rpms/sssd
7
0
Fork 0
Code Issues Pull Requests Releases Activity
1aff49b48c
sssd/0113-MAN-Add-sssd-systemtap-man-page.patch
Lukas Slebodnik 8eda442b2e Fix few bugs/regressions 
Resolves: rhbz#1488327 - SELinux is preventing selinux_child from write access
                         on the sock_file system_bus_socket
Resolves: rhbz#1490402 - SSSD does not create /var/lib/sss/deskprofile and
                         fails to download desktop profile data
Resolves: upstream#3485 - getsidbyid does not work with 1.15.3
Resolves: upstream#3488 - SUDO doesn't work for IPA users on IPA clients after
                          applying ID Views for them in IPA server
Resolves: upstream#3501 - Accessing IdM kerberos ticket fails while id mapping
                          is applied
2017-09-12 09:22:07 +02:00

492 lines
17 KiB
Diff
Raw Blame History

From f199c749197532fd3380fa6f5d9f7a579879c21a Mon Sep 17 00:00:00 2001
From: Justin Stephenson <jstephen@redhat.com>
Date: Mon, 29 May 2017 14:32:51 -0400
Subject: [PATCH 113/115] MAN: Add sssd-systemtap man page
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Provide information for administrators and users to utilize
SSSD systemtap infrastructure.
Reviewed-by: Jakub Hrozek <jhrozek@redhat.com>
Reviewed-by: Lukáš Slebodník <lslebodn@redhat.com>
---
contrib/sssd.spec.in | 1 +
src/man/Makefile.am | 9 +-
src/man/include/seealso.xml | 6 +
src/man/po/po4a.cfg | 1 +
src/man/sssd-systemtap.5.xml | 386 +++++++++++++++++++++++++++++++++++++++++++
5 files changed, 402 insertions(+), 1 deletion(-)
create mode 100644 src/man/sssd-systemtap.5.xml
diff --git a/contrib/sssd.spec.in b/contrib/sssd.spec.in
index e921a352eee6c9a6584292ba8ae5fad1639db57d..eae36c594b814e7c47c1f867757cd07e291f04b8 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 0e35ac277658e76ca8346a077a6931bc5c95ae23..15022c4fe24a28395335a74104d0970a356fe496 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 9b9a72ce257a9487f445bd40e7658259f091a01f..52798e460e0a00ab436a4f4fa071cee104e1bb8b 100644
--- a/src/man/include/seealso.xml
+++ b/src/man/include/seealso.xml
@@ -97,5 +97,11 @@
<refentrytitle>sss_rpcidmapd</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
+ <phrase condition="with_stap">
+ <citerefentry>
+ <refentrytitle>sssd-systemtap</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </citerefentry>
+ </phrase>
</para>
</refsect1>
diff --git a/src/man/po/po4a.cfg b/src/man/po/po4a.cfg
index e9492cfe1525b2f5e1f2a18b7703afd15b5f8fde..7fd4e3881c74be99405c6af26f59543e1d8c19c6 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 0000000000000000000000000000000000000000..f7b04e0aff983ad47e0354e2fa700809f4702670
--- /dev/null
+++ b/src/man/sssd-systemtap.5.xml
@@ -0,0 +1,386 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/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
+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_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>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />
+
+</refentry>
+</reference>
--
2.14.1
Reference in New Issue View Git Blame Copy Permalink