summaryrefslogtreecommitdiffstats
path: root/docs-xml/manpages/samba-log-parser.1.xml
blob: 7a62cd10a474530a515edcfadb04643d5bddf8fc (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
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="samba-log-parser.1">

<refmeta>
	<refentrytitle>samba-log-parser</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">User Commands</refmiscinfo>
	<refmiscinfo class="version">&doc.version;</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>samba-log-parser</refname>
	<refpurpose>Samba (winbind) trace parser.</refpurpose>
</refnamediv>
options:
  -h, --help     show this help message and exit
  --traceid ID   specify the traceid of the trace records
  --pid PID      specify the pid of winbind client
  --breakdown    breakdown the traces into per traceid files
  --merge-by-timestamp   merge logs by timestamp
  --flow         show the request/sub-request flow traces
  --flow-compact show the request/sub-request flow traces without dcerpc details

<refsynopsisdiv>
	<cmdsynopsis>
		<command>samba-log-parser</command>
		<arg choice="req">path</arg>
		<arg choice="opt">--pid=PID</arg>
		<arg choice="opt">--traceid=ID</arg>
		<arg choice="opt">--breakdown</arg>
		<arg choice="opt">--merge-by-timestamp</arg>
		<arg choice="opt">--flow</arg>
		<arg choice="opt">--flow-compact</arg>
		<arg choice="opt">-h|--help</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>The <command>samba-log-parser</command> program parses samba winbind
	logs.</para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<para>The following options are available to the <command>samba-log-parser</command> program.
	</para>

	<variablelist>
		<varlistentry>
		<term>--pid=PID</term>
		<listitem><para>Display traces for winbind client with the matching PID.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>--traceid=ID</term>
		<listitem><para>Display traces with matching traceid debug header field.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>--breakdown</term>
		<listitem><para>Break down all traces to separate files in the current
		working directory. For each traceid, three files are created:
		traceid.full
		traceid.flow
		traceid.flowcompact
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>--merge-by-timestamp</term>
		<listitem><para>Sort the trace lines according to the timestamp.
		Works with log files without traceid header field as well.
		</para></listitem>
		</varlistentry>


		<varlistentry>
		<term>--flow</term>
		<listitem><para>Display the request/sub-request flow.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>--flow-compact</term>
		<listitem><para>Display the request/sub-request flow without dcerpc
		call details.
		</para></listitem>
		</varlistentry>

	</variablelist>
</refsect1>


<refsect1>
	<title>EXAMPLES</title>

	<para>Show the flow traces for trace id
	<parameter>1234</parameter> from log file log.winbind:
	</para>
	<programlisting>
	# samba-log-parser --traceid 1234 --flow /var/log/samba/log.winbind
	</programlisting>

	<para>Show the full traces for winbind client with PID
	<parameter>999999</parameter>
	sorted using the timestamp for log files found in the samba log directory:
	</para>

	<programlisting>
	# samba-log-parser --pid 999999 --merge-by-timestamp /var/log/samba
	</programlisting>

	<para>Break down the traces into separate files according to traceid sorted
	using the timestamp for log files found in the samba log directory:
	</para>

	<programlisting>
	# samba-log-parser --breakdown --merge-by-timestamp /var/log/samba
	</programlisting>

	<para>Sort traces using the timestamp for log files found in the samba log
	directory. Traces do not need to contain the traceid header field.
	</para>

	<programlisting>
	# samba-log-parser --merge-by-timestamp /var/log/samba
	</programlisting>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is part of version &doc.version; of the Samba suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	<para>The original Samba software and related utilities
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar
	to the way the Linux kernel is developed.</para>
</refsect1>

</refentry>