docs-xml/manpages/samba-log-parser.1.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="samba-log-parser.1">
   4
   5 <refmeta>
   6         <refentrytitle>samba-log-parser</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">User Commands</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>samba-log-parser</refname>
  16         <refpurpose>Samba (winbind) trace parser.</refpurpose>
  17 </refnamediv>
  18 options:
  19   -h, --help     show this help message and exit
  20   --traceid ID   specify the traceid of the trace records
  21   --pid PID      specify the pid of winbind client
  22   --breakdown    breakdown the traces into per traceid files
  23   --merge-by-timestamp   merge logs by timestamp
  24   --flow         show the request/sub-request flow traces
  25   --flow-compact show the request/sub-request flow traces without dcerpc details
  26
  27 <refsynopsisdiv>
  28         <cmdsynopsis>
  29                 <command>samba-log-parser</command>
  30                 <arg choice="req">path</arg>
  31                 <arg choice="opt">--pid=PID</arg>
  32                 <arg choice="opt">--traceid=ID</arg>
  33                 <arg choice="opt">--breakdown</arg>
  34                 <arg choice="opt">--merge-by-timestamp</arg>
  35                 <arg choice="opt">--flow</arg>
  36                 <arg choice="opt">--flow-compact</arg>
  37                 <arg choice="opt">-h|--help</arg>
  38         </cmdsynopsis>
  39 </refsynopsisdiv>
  40
  41 <refsect1>
  42         <title>DESCRIPTION</title>
  43
  44         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  45         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  46
  47         <para>The <command>samba-log-parser</command> program parses samba winbind
  48         logs.</para>
  49 </refsect1>
  50
  51
  52 <refsect1>
  53         <title>OPTIONS</title>
  54
  55         <para>The following options are available to the <command>samba-log-parser</command> program.
  56         </para>
  57
  58         <variablelist>
  59                 <varlistentry>
  60                 <term>--pid=PID</term>
  61                 <listitem><para>Display traces for winbind client with the matching PID.
  62                 </para></listitem>
  63                 </varlistentry>
  64
  65                 <varlistentry>
  66                 <term>--traceid=ID</term>
  67                 <listitem><para>Display traces with matching traceid debug header field.
  68                 </para></listitem>
  69                 </varlistentry>
  70
  71                 <varlistentry>
  72                 <term>--breakdown</term>
  73                 <listitem><para>Break down all traces to separate files in the current
  74                 working directory. For each traceid, three files are created:
  75                 traceid.full
  76                 traceid.flow
  77                 traceid.flowcompact
  78                 </para></listitem>
  79                 </varlistentry>
  80
  81                 <varlistentry>
  82                 <term>--merge-by-timestamp</term>
  83                 <listitem><para>Sort the trace lines according to the timestamp.
  84                 Works with log files without traceid header field as well.
  85                 </para></listitem>
  86                 </varlistentry>
  87
  88
  89                 <varlistentry>
  90                 <term>--flow</term>
  91                 <listitem><para>Display the request/sub-request flow.
  92                 </para></listitem>
  93                 </varlistentry>
  94
  95                 <varlistentry>
  96                 <term>--flow-compact</term>
  97                 <listitem><para>Display the request/sub-request flow without dcerpc
  98                 call details.
  99                 </para></listitem>
 100                 </varlistentry>
 101
 102         </variablelist>
 103 </refsect1>
 104
 105
 106 <refsect1>
 107         <title>EXAMPLES</title>
 108
 109         <para>Show the flow traces for trace id
 110         <parameter>1234</parameter> from log file log.winbind:
 111         </para>
 112         <programlisting>
 113         # samba-log-parser --traceid 1234 --flow /var/log/samba/log.winbind
 114         </programlisting>
 115
 116         <para>Show the full traces for winbind client with PID
 117         <parameter>999999</parameter>
 118         sorted using the timestamp for log files found in the samba log directory:
 119         </para>
 120
 121         <programlisting>
 122         # samba-log-parser --pid 999999 --merge-by-timestamp /var/log/samba
 123         </programlisting>
 124
 125         <para>Break down the traces into separate files according to traceid sorted
 126         using the timestamp for log files found in the samba log directory:
 127         </para>
 128
 129         <programlisting>
 130         # samba-log-parser --breakdown --merge-by-timestamp /var/log/samba
 131         </programlisting>
 132
 133         <para>Sort traces using the timestamp for log files found in the samba log
 134         directory. Traces do not need to contain the traceid header field.
 135         </para>
 136
 137         <programlisting>
 138         # samba-log-parser --merge-by-timestamp /var/log/samba
 139         </programlisting>
 140 </refsect1>
 141
 142 <refsect1>
 143         <title>VERSION</title>
 144
 145         <para>This man page is part of version &doc.version; of the Samba suite.</para>
 146 </refsect1>
 147
 148 <refsect1>
 149         <title>AUTHOR</title>
 150         <para>The original Samba software and related utilities
 151         were created by Andrew Tridgell. Samba is now developed
 152         by the Samba Team as an Open Source project similar
 153         to the way the Linux kernel is developed.</para>
 154 </refsect1>
 155
 156 </refentry>