blob: 2c88bb46878570ce0ba691ac4dbb1fc304a9a480 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<reference>
<title>SSSD Manual pages</title>
<refentry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />
<refmeta>
<refentrytitle>sssd-systemtap</refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>sssd-systemtap</refname>
<refpurpose>SSSD systemtap information</refpurpose>
</refnamediv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
This manual page provides information about
the systemtap functionality
in
<citerefentry>
<refentrytitle>sssd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>.
</para>
<para>
SystemTap Probe points have been added into various
locations in SSSD code to assist in troubleshooting
and analyzing performance related issues.
</para>
<para>
<itemizedlist>
<listitem>
<para>
Sample SystemTap scripts are
provided in /usr/share/sssd/systemtap/
</para>
</listitem>
<listitem>
<para>
Probes and miscellaneous functions are
defined in /usr/share/systemtap/tapset/sssd.stp
and /usr/share/systemtap/tapset/sssd_functions.stp
respectively.
</para>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 id='probe-points'>
<title>PROBE POINTS</title>
<para>
The information below lists the probe points and arguments available
in the following format:
</para>
<variablelist>
<varlistentry>
<term>probe $name</term>
<listitem>
<para>
Description of probe point
</para>
<programlisting>
variable1:datatype
variable2:datatype
variable3:datatype
...
</programlisting>
</listitem>
</varlistentry>
</variablelist>
<refsect2 id='database-transaction-probes'>
<title>Database Transaction Probes</title>
<para>
<variablelist>
<varlistentry>
<term>probe sssd_transaction_start</term>
<listitem>
<para>
Start of a sysdb transaction, probes the
sysdb_transaction_start() function.
</para>
<programlisting>
nesting:integer
probestr:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sssd_transaction_cancel</term>
<listitem>
<para>
Cancellation of a sysdb transaction,
probes the sysdb_transaction_cancel()
function.
</para>
<programlisting>
nesting:integer
probestr:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sssd_transaction_commit_before</term>
<listitem>
<para>
Probes the sysdb_transaction_commit_before()
function.
</para>
<programlisting>
nesting:integer
probestr:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sssd_transaction_commit_after</term>
<listitem>
<para>
Probes the sysdb_transaction_commit_after()
function.
</para>
<programlisting>
nesting:integer
probestr:string
</programlisting>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
<refsect2 id='ldap-search-probes'>
<title>LDAP Search Probes</title>
<para>
<variablelist>
<varlistentry>
<term>probe sdap_search_send</term>
<listitem>
<para>
Probes the sdap_get_generic_ext_send()
function.
</para>
<programlisting>
base:string
scope:integer
filter:string
attrs:string
probestr:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sdap_search_recv</term>
<listitem>
<para>
Probes the sdap_get_generic_ext_recv()
function.
</para>
<programlisting>
base:string
scope:integer
filter:string
probestr:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sdap_parse_entry</term>
<listitem>
<para>
Probes the sdap_parse_entry()
function. It is called repeatedly
with every received attribute.
</para>
<programlisting>
attr:string
value:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sdap_parse_entry_done</term>
<listitem>
<para>
Probes the sdap_parse_entry()
function. It is called when
parsing of received object is
finished.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sdap_deref_send</term>
<listitem>
<para>
Probes the sdap_deref_search_send()
function.
</para>
<programlisting>
base_dn:string
deref_attr:string
probestr:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sdap_deref_recv</term>
<listitem>
<para>
Probes the sdap_deref_search_recv()
function.
</para>
<programlisting>
base:string
scope:integer
filter:string
probestr:string
</programlisting>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
<refsect2 id='ldap-account-req-probes'>
<title>LDAP Account Request Probes</title>
<para>
<variablelist>
<varlistentry>
<term>probe sdap_acct_req_send</term>
<listitem>
<para>
Probes the sdap_acct_req_send()
function.
</para>
<programlisting>
entry_type:int
filter_type:int
filter_value:string
extra_value:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sdap_acct_req_recv</term>
<listitem>
<para>
Probes the sdap_acct_req_recv()
function.
</para>
<programlisting>
entry_type:int
filter_type:int
filter_value:string
extra_value:string
</programlisting>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
<refsect2 id='ldap-user-search-probes'>
<title>LDAP User Search Probes</title>
<para>
<variablelist>
<varlistentry>
<term>probe sdap_search_user_send</term>
<listitem>
<para>
Probes the sdap_search_user_send()
function.
</para>
<programlisting>
filter:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sdap_search_user_recv</term>
<listitem>
<para>
Probes the sdap_search_user_recv()
function.
</para>
<programlisting>
filter:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sdap_search_user_save_begin</term>
<listitem>
<para>
Probes the sdap_search_user_save_begin()
function.
</para>
<programlisting>
filter:string
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe sdap_search_user_save_end</term>
<listitem>
<para>
Probes the sdap_search_user_save_end()
function.
</para>
<programlisting>
filter:string
</programlisting>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
<refsect2 id='data-provider-request-probes'>
<title>Data Provider Request Probes</title>
<para>
<variablelist>
<varlistentry>
<term>probe dp_req_send</term>
<listitem>
<para>
A Data Provider request is submitted.
</para>
<programlisting>
dp_req_domain:string
dp_req_name:string
dp_req_target:int
dp_req_method:int
</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term>probe dp_req_done</term>
<listitem>
<para>
A Data Provider request is completed.
</para>
<programlisting>
dp_req_name:string
dp_req_target:int
dp_req_method:int
dp_ret:int
dp_errorstr:string
</programlisting>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
<refsect2 id='miscellaneous-functions'>
<title>MISCELLANEOUS FUNCTIONS</title>
<para>
The information below lists the probe points and arguments available
in the following format:
</para>
<variablelist>
<varlistentry>
<term>function acct_req_desc(entry_type)</term>
<listitem>
<para>
Convert entry_type to string and return string
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>function sssd_acct_req_probestr(fc_name, entry_type,
filter_type, filter_value, extra_value)</term>
<listitem>
<para>
Create probe string based on filter type
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>function dp_target_str(target)</term>
<listitem>
<para>
Convert target to string and return string
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>function dp_method_str(target)</term>
<listitem>
<para>
Convert method to string and return string
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 id='sample-systemtap-scripts'>
<title>SAMPLE SYSTEMTAP SCRIPTS</title>
<para>
Start the SystemTap script
(<command>stap /usr/share/sssd/systemtap/<script_name>.stp</command>),
then perform an identity operation and the script
will collect information from probes.
</para>
<para>
Provided SystemTap scripts are:
</para>
<variablelist>
<varlistentry>
<term>dp_request.stp</term>
<listitem>
<para>
Monitoring of data provider request performance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>id_perf.stp</term>
<listitem>
<para>
Monitoring of <command>id</command> command
performance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_perf.stp</term>
<listitem>
<para>
Monitoring of LDAP queries.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>nested_group_perf.stp</term>
<listitem>
<para>
Performance of nested groups resolving.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />
</refentry>
</reference>
|
