1SSSD-SYSTEMTAP(5) File Formats and Conventions SSSD-SYSTEMTAP(5)
2
3
4
6 sssd-systemtap - SSSD systemtap information
7
9 This manual page provides information about the systemtap functionality
10 in sssd(8).
11
12 SystemTap Probe points have been added into various locations in SSSD
13 code to assist in troubleshooting and analyzing performance related
14 issues.
15
16 • Sample SystemTap scripts are provided in /usr/share/sssd/systemtap/
17
18 • Probes and miscellaneous functions are defined in
19 /usr/share/systemtap/tapset/sssd.stp and
20 /usr/share/systemtap/tapset/sssd_functions.stp respectively.
21
22
24 The information below lists the probe points and arguments available in
25 the following format:
26
27 probe $name
28 Description of probe point
29
30 variable1:datatype
31 variable2:datatype
32 variable3:datatype
33 ...
34
35
36 Database Transaction Probes
37 probe sssd_transaction_start
38 Start of a sysdb transaction, probes the sysdb_transaction_start()
39 function.
40
41 nesting:integer
42 probestr:string
43
44
45 probe sssd_transaction_cancel
46 Cancellation of a sysdb transaction, probes the
47 sysdb_transaction_cancel() function.
48
49 nesting:integer
50 probestr:string
51
52
53 probe sssd_transaction_commit_before
54 Probes the sysdb_transaction_commit_before() function.
55
56 nesting:integer
57 probestr:string
58
59
60 probe sssd_transaction_commit_after
61 Probes the sysdb_transaction_commit_after() function.
62
63 nesting:integer
64 probestr:string
65
66
67 LDAP Search Probes
68 probe sdap_search_send
69 Probes the sdap_get_generic_ext_send() function.
70
71 base:string
72 scope:integer
73 filter:string
74 attrs:string
75 probestr:string
76
77
78 probe sdap_search_recv
79 Probes the sdap_get_generic_ext_recv() function.
80
81 base:string
82 scope:integer
83 filter:string
84 probestr:string
85
86
87 probe sdap_parse_entry
88 Probes the sdap_parse_entry() function. It is called repeatedly
89 with every received attribute.
90
91 attr:string
92 value:string
93
94
95 probe sdap_parse_entry_done
96 Probes the sdap_parse_entry() function. It is called when parsing
97 of received object is finished.
98
99 probe sdap_deref_send
100 Probes the sdap_deref_search_send() function.
101
102 base_dn:string
103 deref_attr:string
104 probestr:string
105
106
107 probe sdap_deref_recv
108 Probes the sdap_deref_search_recv() function.
109
110 base:string
111 scope:integer
112 filter:string
113 probestr:string
114
115
116 LDAP Account Request Probes
117 probe sdap_acct_req_send
118 Probes the sdap_acct_req_send() function.
119
120 entry_type:int
121 filter_type:int
122 filter_value:string
123 extra_value:string
124
125
126 probe sdap_acct_req_recv
127 Probes the sdap_acct_req_recv() function.
128
129 entry_type:int
130 filter_type:int
131 filter_value:string
132 extra_value:string
133
134
135 LDAP User Search Probes
136 probe sdap_search_user_send
137 Probes the sdap_search_user_send() function.
138
139 filter:string
140
141
142 probe sdap_search_user_recv
143 Probes the sdap_search_user_recv() function.
144
145 filter:string
146
147
148 probe sdap_search_user_save_begin
149 Probes the sdap_search_user_save_begin() function.
150
151 filter:string
152
153
154 probe sdap_search_user_save_end
155 Probes the sdap_search_user_save_end() function.
156
157 filter:string
158
159
160 Data Provider Request Probes
161 probe dp_req_send
162 A Data Provider request is submitted.
163
164 dp_req_domain:string
165 dp_req_name:string
166 dp_req_target:int
167 dp_req_method:int
168
169
170 probe dp_req_done
171 A Data Provider request is completed.
172
173 dp_req_name:string
174 dp_req_target:int
175 dp_req_method:int
176 dp_ret:int
177 dp_errorstr:string
178
179
180 MISCELLANEOUS FUNCTIONS
181 The information below lists the probe points and arguments available in
182 the following format:
183
184 function acct_req_desc(entry_type)
185 Convert entry_type to string and return string
186
187 function sssd_acct_req_probestr(fc_name, entry_type, filter_type,
188 filter_value, extra_value)
189 Create probe string based on filter type
190
191 function dp_target_str(target)
192 Convert target to string and return string
193
194 function dp_method_str(target)
195 Convert method to string and return string
196
198 Start the SystemTap script (stap
199 /usr/share/sssd/systemtap/<script_name>.stp), then perform an identity
200 operation and the script will collect information from probes.
201
202 Provided SystemTap scripts are:
203
204 dp_request.stp
205 Monitoring of data provider request performance.
206
207 id_perf.stp
208 Monitoring of id command performance.
209
210 ldap_perf.stp
211 Monitoring of LDAP queries.
212
213 nested_group_perf.stp
214 Performance of nested groups resolving.
215
217 sssd(8), sssd.conf(5), sssd-ldap(5), sssd-krb5(5), sssd-simple(5),
218 sssd-ipa(5), sssd-ad(5), sssd-files(5), sssd-sudo(5), sssd-session-
219 recording(5), sss_cache(8), sss_debuglevel(8), sss_obfuscate(8),
220 sss_seed(8), sssd_krb5_locator_plugin(8), sss_ssh_authorizedkeys(8),
221 sss_ssh_knownhostsproxy(8), sssd-ifp(5), pam_sss(8). sss_rpcidmapd(5)
222 sssd-systemtap(5)
223
225 The SSSD upstream - https://github.com/SSSD/sssd/
226
227
228
229SSSD 05/19/2021 SSSD-SYSTEMTAP(5)