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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "../xml-stylesheet/pdf/dtd/docbookx.dtd">
<reference xmlns:xi="http://www.w3.org/2001/XInclude" id="syslog-ng-ctl-man-page">
<title>The syslog-ng control tool manual page</title>
<info>
<productname class="trade">syslog-ng Open Source Edition</productname>
</info>
<refentry id="syslog-ng-ctl.1">
<refmeta>
<refentrytitle>syslog-ng-ctl</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="version">3.3</refmiscinfo>
<refmiscinfo class="source">syslog-ng Open Source Edition</refmiscinfo>
</refmeta>
<refnamediv>
<refname>syslog-ng-ctl</refname>
<refpurpose>Display message statistics and enable verbose, debug and trace modes in syslog-ng Open Source Edition </refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis sepchar=" ">
<command moreinfo="none">syslog-ng-ctl</command>
<arg choice="opt" rep="norepeat">command</arg>
<arg choice="opt" rep="norepeat">options</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="syslog-ng-ctl_mandescription">
<title>Description</title>
<para>NOTE: The syslog-ng-ctl application is distributed with the syslog-ng Open Source Edition system logging application, and is usually part of the syslog-ng package. The latest version of the syslog-ng application is available at <ulink url="http://www.balabit.com/network-security/syslog-ng/">the official syslog-ng website</ulink>.</para>
<para>This manual page is only an abstract; for the complete documentation of syslog-ng, see
<ulink url="http://www.balabit.com/support/documentation/">
<command moreinfo="none">The syslog-ng Open Source Edition Administrator Guide</command>
</ulink>.</para>
<para>The <command moreinfo="none">syslog-ng-ctl</command> application is a utility that can be used to:</para>
<itemizedlist>
<listitem>
<para>enable/disable various syslog-ng messages for troubleshooting;</para>
</listitem>
<listitem>
<para>display statistics about the processed messages.</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1 id="syslog-ng-ctl">
<title>Enabling troubleshooting messages</title>
<cmdsynopsis sepchar=" ">
<command moreinfo="none">command</command>
<arg choice="opt" rep="norepeat">options</arg>
</cmdsynopsis>
<para>Use the <command moreinfo="none">syslog-ng-ctl <command> --set=on</command> command to display verbose, trace, or debug messages. If you are trying to solve configuration problems, the debug (and occassionally trace) messages are usually sufficient; debug messages are needed mostly for finding software errors. After solving the problem, do not forget to turn these messages off using the <command moreinfo="none">syslog-ng-ctl <command> --set=off</command>. Note that enabling debug messages does not enable verbose and trace messages.</para>
<para>Use <command moreinfo="none">syslog-ng-ctl <command></command> without any parameters to display whether the particular type of messages are enabled or not.</para>
<para>If you need to use a non-standard control socket to access syslog-ng, use the <command moreinfo="none">syslog-ng-ctl <command> --set=on --control=<socket></command> command to specify the socket to use.</para>
<variablelist>
<varlistentry>
<term><command moreinfo="none">verbose</command></term>
<listitem>
<para>Print verbose messages. If syslog-ng was started with the <parameter moreinfo="none">--stderr</parameter> or <parameter moreinfo="none">-e</parameter> option, the messages will be sent to stderr. If not specified, syslog-ng will log such messages to its internal source.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command moreinfo="none">trace</command></term>
<listitem>
<para>Print trace messages of how messages are processed. If syslog-ng was started with the <parameter moreinfo="none">--stderr</parameter> or <parameter moreinfo="none">-e</parameter> option, the messages will be sent to stderr. If not specified, syslog-ng will log such messages to its internal source.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command moreinfo="none">debug</command></term>
<listitem>
<para>Print debug messages. If syslog-ng was started with the <parameter moreinfo="none">--stderr</parameter> or <parameter moreinfo="none">-e</parameter> option, the messages will be sent to stderr. If not specified, syslog-ng will log such messages to its internal source.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Example: <synopsis format="linespecific">syslog-ng-ctl verbose --set=on</synopsis></para>
</refsect1>
<refsect1 id="syslog-ng-ctl-stats">
<title>The stats command</title>
<cmdsynopsis sepchar=" ">
<command moreinfo="none">stats</command>
<arg choice="opt" rep="norepeat">options</arg>
</cmdsynopsis>
<para>Use the <command moreinfo="none">stats</command> command to display statistics about the processed messages. The <command moreinfo="none">stats</command> command has the following options:</para>
<variablelist>
<varlistentry>
<term><command moreinfo="none">--control=<socket></command> or <command moreinfo="none">-c</command></term>
<listitem>
<para>Specify the socket to use to access syslog-ng. Only needed when using a non-standard socket.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Example:
<synopsis format="linespecific">syslog-ng-ctl stats</synopsis></para>
<para>An example output:</para>
<synopsis format="linespecific">src.internal;s_all#0;;a;processed;6445
src.internal;s_all#0;;a;stamp;1268989330
destination;df_auth;;a;processed;404
destination;df_news_dot_notice;;a;processed;0
destination;df_news_dot_err;;a;processed;0
destination;d_ssb;;a;processed;7128
destination;df_uucp;;a;processed;0
source;s_all;;a;processed;7128
destination;df_mail;;a;processed;0
destination;df_user;;a;processed;1
destination;df_daemon;;a;processed;1
destination;df_debug;;a;processed;15
destination;df_messages;;a;processed;54
destination;dp_xconsole;;a;processed;671
dst.tcp;d_network#0;10.50.0.111:514;a;dropped;5080
dst.tcp;d_network#0;10.50.0.111:514;a;processed;7128
dst.tcp;d_network#0;10.50.0.111:514;a;stored;2048
destination;df_syslog;;a;processed;6724
destination;df_facility_dot_warn;;a;processed;0
destination;df_news_dot_crit;;a;processed;0
destination;df_lpr;;a;processed;0
destination;du_all;;a;processed;0
destination;df_facility_dot_info;;a;processed;0
center;;received;a;processed;0
destination;df_kern;;a;processed;70
center;;queued;a;processed;0
destination;df_facility_dot_err;;a;processed;0</synopsis>
</refsect1>
<refsect1>
<title>Files</title>
<para>
<filename moreinfo="none">/opt/syslog-ng/sbin/syslog-ng-ctl</filename>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<ulink url="http://www.balabit.com/support/documentation/">
<command moreinfo="none">The syslog-ng Administrator Guide</command>
</ulink>
</para>
<para>
<link linkend="syslog-ng.conf.5">
<command moreinfo="none">syslog-ng.conf</command>(5)</link>
</para>
<para>
<link linkend="syslog-ng.8">
<command moreinfo="none">syslog-ng</command>(8)</link>
</para>
<para><ulink url="http://www.balabit.com/support/documentation/"><command moreinfo="none">The syslog-ng OSE 3.3 Administrator Guide</command></ulink></para><para>If you experience any problems or need help with syslog-ng, visit <ulink url="http://www.balabit.com/wiki/syslog-ng-faq">visit the syslog-ng wiki</ulink> or the <ulink url="https://lists.balabit.hu/mailman/listinfo/syslog-ng"><command moreinfo="none">syslog-ng mailing list</command></ulink>.</para><para>For news and notifications about of syslog-ng, visit the <ulink url="http://insider.blogs.balabit.com"><command moreinfo="none">syslog-ng Insider Blog</command></ulink>.</para>
</refsect1>
<refsect1>
<title>Author</title><para>This manual page was written by the BalaBit Documentation Team <documentation@balabit.com>.</para>
</refsect1>
<refsect1>
<title>Copyright</title><refsect2 condition="ose">
<para>The authors grant permission to copy, distribute and/or modify this manual page under the terms of the GNU General Public License Version 2 or newer (GPL v2+).</para>
</refsect2>
</refsect1>
</refentry>
</reference>
|
