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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
<?xml version="1.0"?>
<!--
Copyright (c) 2017 Balabit
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
As an additional exemption you are allowed to compile & link against the
OpenSSL libraries as published by the OpenSSL project. See the file
COPYING for details.
-->
<reference xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
<productname/>
<title>The syslog-ng-debun manual page</title>
</info>
<refentry xml:id="syslog-ng-debun.1">
<refmeta>
<refentrytitle>syslog-ng-debun</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="version">4.8</refmiscinfo>
<refmiscinfo class="source"/>
</refmeta>
<refnamediv>
<refname>syslog-ng-debun</refname>
<refpurpose>syslog-ng DEBUg buNdle generator</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>syslog-ng-debun</command>
<arg>options</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection xml:id="syslog-ng-debun-mandescription">
<title>Description</title>
<para>NOTE: The <command>syslog-ng-debun</command> application is distributed with the system logging application, and is usually part of the package. The latest version of the application is available at .</para>
<para>This manual page is only an abstract, for the complete documentation of syslog-ng, see <link xmlns:ns1="http://www.w3.org/1999/xlink" ns1:href="https://www.balabit.com/support/documentation/">The syslog-ng Administrator Guide</link>.</para>
<para>The <command>syslog-ng-debun</command> tool collects and saves information about your installation, making troubleshooting easier, especially if you ask help about your related problem.</para>
</refsection>
<refsection>
<title>General Options</title>
<variablelist>
<varlistentry>
<term>
<command>-r</command>
</term>
<listitem>
<para>Run <command>syslog-ng-debun</command>. Using this option is required to actually execute the data collection with <command>syslog-ng-debun</command>. It is needed to prevent accidentally running <command>syslog-ng-debun</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-h</command>
</term>
<listitem>
<para>Display the help page.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-l</command>
</term>
<listitem>
<para>Do not collect privacy-sensitive data, for example, process tree, fstab, and so on. If you use with <userinput>-d</userinput>, then the following parameters will be used for debug mode:<userinput>-Fev</userinput></para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-R <directory></command>
</term>
<listitem>
<para>The directory where is installed instead of <filename>/opt/syslog-ng</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-W <directory></command>
</term>
<listitem>
<para>Set the working directory, where the debug bundle will be saved. Default value: <filename>/tmp</filename>. The name of the created file is <userinput>syslog.debun.${host}.${date}.${3-random-characters-or-pid}.tgz</userinput></para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Debug mode options</title>
<variablelist>
<varlistentry>
<term>
<command>-d</command>
</term>
<listitem>
<para>Start in debug mode, using the <userinput>-Fedv --enable-core</userinput> options.</para>
<para>Warning! Using this option under high message load may increase disk I/O during the debug, and the resulting debug bundle can be huge. To exit debug mode, press Enter.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-D <options></command>
</term>
<listitem>
<para>Start in debug mode, using the specified command-line options. To exit debug mode, press Enter. For details on the available options, see <xref linkend="syslog-ng.8"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-t <seconds></command>
</term>
<listitem>
<para>Run in noninteractive debug mode for <seconds>, and automatically exit debug mode after the specified number of seconds.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-w <seconds></command>
</term>
<listitem>
<para>Wait <seconds> seconds before starting debug mode.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>System call tracing</title>
<variablelist>
<varlistentry>
<term>
<command>-s</command>
</term>
<listitem>
<para>Enable syscall tracing (<command>strace -f</command> or <command>truss -f</command>). Note that using <userinput>-s</userinput> itself does not enable debug mode, only traces the system calls of an already running process. To trace system calls in debug mode, use both the <userinput>-s</userinput> and <userinput>-d</userinput> options.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Packet capture options</title>
<para>Capturing packets requires a packet capture tool on the host. The <command>syslog-ng-debun</command> tool attempts to use <command>tcpdump</command> on most platforms, except for Solaris, where it uses <command>snoop</command>.</para>
<variablelist>
<varlistentry>
<term>
<command>-i <interface></command>
</term>
<listitem>
<para>Capture packets only on the specified interface, for example, <userinput>eth0</userinput>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-p</command>
</term>
<listitem>
<para>Capture incoming packets using the following filter: <userinput>port 514 or port 601 or port 53</userinput></para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-P <options></command>
</term>
<listitem>
<para>Capture incoming packets using the specified filter.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>-t <seconds></command>
</term>
<listitem>
<para>Run in noninteractive debug mode for <seconds>, and automatically exit debug mode after the specified number of seconds.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Examples</title>
<synopsis>syslog-ng-debun -r</synopsis>
<para>Create a simple debug bundle, collecting information about your environment, for example, list packages containing the word: syslog, ldd of your syslog-binary, and so on.</para>
<synopsis>syslog-ng-debun -r -l</synopsis>
<para>Similar to <command>syslog-ng-debun -r</command>, but without privacy-sensitive information. For example, the following is NOT collected: fstab, df output, mount info, ip / network interface configuration, DNS resolv info, and process tree.</para>
<synopsis>syslog-ng-debun -r -d</synopsis>
<para>Similar to <command>syslog-ng-debun -r</command>, but it also stops syslog-ng, then restarts it in debug mode (<userinput>-Fedv --enable-core</userinput>). To stop debug mode, press Enter. The output of the debug mode collected into a separate file, and also added to the debug bundle.</para>
<synopsis>syslog-ng-debun -r -s</synopsis>
<para>Trace the system calls (using <command>strace</command> or <command>truss</command>) of an already running process.</para>
<synopsis>syslog-ng-debun -r -d -s</synopsis>
<para>Restart in debug mode, and also trace the system calls (using <command>strace</command> or <command>truss</command>) of the process.</para>
<synopsis>syslog-ng-debun -r -p</synopsis>
<para>Run packet capture (pcap) with the filter: <userinput>port 514 or port 601 or port 53</userinput> Also waits for pressing Enter, like debug mode.</para>
<synopsis>syslog-ng-debun -r -p -t 10</synopsis>
<para>Noninteractive debug mode: Similar to <command>syslog-ng-debun -r -p</command>, but automatically exit after 10 seconds.</para>
<synopsis>syslog-ng-debun -r -P "host 1.2.3.4" -D "-Fev --enable-core"</synopsis>
<para>Change the packet-capturing filter from the default to <userinput>host 1.2.3.4</userinput>. Also change debugging parameters from the default to <userinput>-Fev --enable-core</userinput>. Since a timeout (<userinput>-t</userinput>) is not given, waits for pressing Enter.</para>
<synopsis>syslog-ng-debun -r -p -d -w 5 -t 10</synopsis>
<para>Collect pcap and debug mode output following this scenario:</para>
<itemizedlist>
<listitem>
<para>Start packet capture with default parameters (<userinput>-p</userinput>)</para>
</listitem>
<listitem>
<para>Wait 5 seconds (<userinput>-w 5</userinput>)</para>
</listitem>
<listitem>
<para>Stop syslog-ng</para>
</listitem>
<listitem>
<para>Start syslog-ng in debug mode with default parameters (<userinput>-d</userinput>)</para>
</listitem>
<listitem>
<para>Wait 10 seconds (<userinput>-t 10</userinput>)</para>
</listitem>
<listitem>
<para>Stop syslog-ng debugging</para>
</listitem>
<listitem>
<para>Start syslog-ng</para>
</listitem>
<listitem>
<para>Stop packet capturing</para>
</listitem>
</itemizedlist>
</refsection>
<refsection>
<title>Files</title>
<para>
<filename>/opt/syslog-ng/bin/loggen</filename>
</para>
</refsection>
<refsection>
<title>See also</title>
<para>
<link linkend="syslog-ng.conf.5"><command>syslog-ng.conf</command>(5)</link>
</para>
<note version="5.0">
<para>For the detailed documentation of see <link xmlns:ns1="http://www.w3.org/1999/xlink" ns1:href="https://www.balabit.com/documents/syslog-ng-ose-latest-guides/en/syslog-ng-ose-guide-admin/html/index.html"><command>The 4.8 Administrator Guide</command></link></para>
<para>If you experience any problems or need help with syslog-ng, visit the <link xmlns:ns1="http://www.w3.org/1999/xlink" ns1:href="https://lists.balabit.hu/mailman/listinfo/syslog-ng"><command>syslog-ng mailing list</command></link>.</para>
<para>For news and notifications about of syslog-ng, visit the <link xmlns:ns1="http://www.w3.org/1999/xlink" ns1:href="https://syslog-ng.org/blogs/"><command>syslog-ng blogs</command></link>.</para>
</note>
</refsection>
<refsection version="5.0">
<title>Author</title>
<para>This manual page was written by the Balabit Documentation Team <documentation@balabit.com>.</para>
</refsection>
<refsection version="5.0">
<title>Copyright</title>
</refsection>
</refentry>
</reference>
|
