From f199c749197532fd3380fa6f5d9f7a579879c21a Mon Sep 17 00:00:00 2001 From: Justin Stephenson Date: Sep 08 2017 14:09:53 +0000 Subject: MAN: Add sssd-systemtap man page Provide information for administrators and users to utilize SSSD systemtap infrastructure. Reviewed-by: Jakub Hrozek Reviewed-by: Lukáš Slebodník --- diff --git a/contrib/sssd.spec.in b/contrib/sssd.spec.in index e921a35..eae36c5 100644 --- a/contrib/sssd.spec.in +++ b/contrib/sssd.spec.in @@ -1008,6 +1008,7 @@ done %dir %{_datadir}/systemtap/tapset %{_datadir}/systemtap/tapset/sssd.stp %{_datadir}/systemtap/tapset/sssd_functions.stp +%{_mandir}/man5/sssd-systemtap.5* %endif %if (0%{?install_pcscd_polkit_rule} == 1) diff --git a/src/man/Makefile.am b/src/man/Makefile.am index 0e35ac2..15022c4 100644 --- a/src/man/Makefile.am +++ b/src/man/Makefile.am @@ -30,6 +30,9 @@ endif if BUILD_SECRETS KCM_CONDS = ;with_kcm endif +if BUILD_SYSTEMTAP +STAP_CONDS = ;with_stap +endif if GPO_DEFAULT_ENFORCING GPO_CONDS = ;gpo_default_enforcing else @@ -43,7 +46,7 @@ FILES_CONDS = ;enable_files_domain else FILES_CONDS = ;no_enable_files_domain endif -CONDS = with_false$(SUDO_CONDS)$(AUTOFS_CONDS)$(SSH_CONDS)$(PAC_RESPONDER_CONDS)$(IFP_CONDS)$(GPO_CONDS)$(SEC_CONDS)$(SYSTEMD_CONDS)$(FILES_CONDS)$(KCM_CONDS) +CONDS = with_false$(SUDO_CONDS)$(AUTOFS_CONDS)$(SSH_CONDS)$(PAC_RESPONDER_CONDS)$(IFP_CONDS)$(GPO_CONDS)$(SEC_CONDS)$(SYSTEMD_CONDS)$(FILES_CONDS)$(KCM_CONDS)$(STAP_CONDS) #Special Rules: @@ -92,6 +95,10 @@ if BUILD_KCM man_MANS += sssd-kcm.8 endif +if BUILD_SYSTEMTAP +man_MANS += sssd-systemtap.5 +endif + if BUILD_NFS_IDMAP man_MANS += sss_rpcidmapd.5 endif diff --git a/src/man/include/seealso.xml b/src/man/include/seealso.xml index 9b9a72c..52798e4 100644 --- a/src/man/include/seealso.xml +++ b/src/man/include/seealso.xml @@ -97,5 +97,11 @@ sss_rpcidmapd 5 + + + sssd-systemtap + 5 + + diff --git a/src/man/po/po4a.cfg b/src/man/po/po4a.cfg index e9492cf..7fd4e38 100644 --- a/src/man/po/po4a.cfg +++ b/src/man/po/po4a.cfg @@ -33,6 +33,7 @@ [type:docbook] sssd-secrets.5.xml $lang:$(builddir)/$lang/sssd-secrets.5.xml [type:docbook] sssd-session-recording.5.xml $lang:$(builddir)/$lang/sssd-session-recording.5.xml [type:docbook] sssd-kcm.8.xml $lang:$(builddir)/$lang/sssd-kcm.8.xml +[type:docbook] sssd-systemtap.5.xml $lang:$(builddir)/$lang/sssd-systemtap.5.xml [type:docbook] include/service_discovery.xml $lang:$(builddir)/$lang/include/service_discovery.xml opt:"-k 0" [type:docbook] include/upstream.xml $lang:$(builddir)/$lang/include/upstream.xml opt:"-k 0" [type:docbook] include/failover.xml $lang:$(builddir)/$lang/include/failover.xml opt:"-k 0" diff --git a/src/man/sssd-systemtap.5.xml b/src/man/sssd-systemtap.5.xml new file mode 100644 index 0000000..f7b04e0 --- /dev/null +++ b/src/man/sssd-systemtap.5.xml @@ -0,0 +1,386 @@ + + + +SSSD Manual pages + + + + + sssd-systemtap + 5 + File Formats and Conventions + + + + sssd-systemtap + SSSD systemtap information + + + + DESCRIPTION + + This manual page provides information about + the systemtap functionality + in + + sssd + 8 + . + + + SystemTap Probe points have been added into various + locations in SSSD code to assist in troubleshooting + and analyzing performance related issues. + + + + + + Sample SystemTap scripts are + provided in /usr/share/sssd/systemtap/ + + + + + Probes and miscellaneous functions are + defined in /usr/share/systemtap/tapset/sssd.stp + and /usr/share/systemtap/tapset/sssd_functions.stp + respectively. + + + + + + + + PROBE POINTS + + The information below lists the probe points and arguments available + in the following format: + + + + probe $name + + + Description of probe point + + +variable1:datatype +variable2:datatype +variable3:datatype +... + + + + + + + Database Transaction Probes + + + + probe sssd_transaction_start + + + Start of a sysdb transaction, probes the + sysdb_transaction_start() function. + + +nesting:integer +probestr:string + + + + + probe sssd_transaction_cancel + + + Cancellation of a sysdb transaction, + probes the sysdb_transaction_cancel() + function. + + +nesting:integer +probestr:string + + + + + probe sssd_transaction_commit_before + + + Probes the sysdb_transaction_commit_before() + function. + + +nesting:integer +probestr:string + + + + + probe sssd_transaction_commit_after + + + Probes the sysdb_transaction_commit_after() + function. + + +nesting:integer +probestr:string + + + + + + + + + LDAP Search Probes + + + + probe sdap_search_send + + + Probes the sdap_get_generic_ext_send() + function. + + +base:string +scope:integer +filter:string +probestr:string + + + + + probe sdap_search_recv + + + Probes the sdap_get_generic_ext_recv() + function. + + +base:string +scope:integer +filter:string +probestr:string + + + + + probe sdap_deref_send + + + Probes the sdap_deref_search_send() + function. + + +base_dn:string +deref_attr:string +probestr:string + + + + + probe sdap_deref_recv + + + Probes the sdap_deref_search_recv() + function. + + +base:string +scope:integer +filter:string +probestr:string + + + + + + + + + LDAP Account Request Probes + + + + probe sdap_acct_req_send + + + Probes the sdap_acct_req_send() + function. + + +entry_type:int +filter_type:int +filter_value:string +extra_value:string + + + + + probe sdap_acct_req_recv + + + Probes the sdap_acct_req_recv() + function. + + +entry_type:int +filter_type:int +filter_value:string +extra_value:string + + + + + + + + + LDAP User Search Probes + + + + probe sdap_search_user_send + + + Probes the sdap_search_user_send() + function. + + +filter:string + + + + + probe sdap_search_user_recv + + + Probes the sdap_search_user_recv() + function. + + +filter:string + + + + + probe sdap_search_user_save_begin + + + Probes the sdap_search_user_save_begin() + function. + + +filter:string + + + + + probe sdap_search_user_save_end + + + Probes the sdap_search_user_save_end() + function. + + +filter:string + + + + + + + + + Data Provider Request Probes + + + + probe dp_req_send + + + A Data Provider request is submitted. + + +dp_req_domain:string +dp_req_name:string +dp_req_target:int +dp_req_method:int + + + + + probe dp_req_done + + + A Data Provider request is completed. + + +dp_req_name:string +dp_req_target:int +dp_req_method:int +dp_ret:int +dp_errorstr:string + + + + + + + + + MISCELLANEOUS FUNCTIONS + + The information below lists the probe points and arguments available + in the following format: + + + + function acct_req_desc(entry_type) + + + Convert entry_type to string and return string + + + + + function sssd_acct_req_probestr(fc_name, entry_type, + filter_type, filter_value, extra_value) + + + Create probe string based on filter type + + + + + function dp_target_str(target) + + + Convert target to string and return string + + + + + function dp_method_str(target) + + + Convert method to string and return string + + + + + + + + + + + +