1SYSLOG-NG-CTL(1)        The syslog-ng control tool man        SYSLOG-NG-CTL(1)
2
3
4

NAME

6       syslog-ng-ctl - Display message statistics and enable verbose, debug
7       and trace modes in
8

SYNOPSIS

10       syslog-ng-ctl [command] [options]
11

DESCRIPTION

13       NOTE: The syslog-ng-ctl application is distributed with the system
14       logging application, and is usually part of the syslog-ng package. The
15       latest version of the syslog-ng application is available at the
16       official syslog-ng website[1].
17
18       This manual page is only an abstract, for the complete documentation of
19       syslog-ng, see The Administrator Guide[2].
20
21       The syslog-ng-ctl application is a utility that can be used to:
22
23       •   enable/disable various syslog-ng messages for troubleshooting
24
25       •   display statistics about the processed messages
26
27       •   reload the configuration of .
28

ENABLING TROUBLESHOOTING MESSAGES

30       command [options]
31
32       Use the syslog-ng-ctl <command> --set=on command to display verbose,
33       trace, or debug messages. If you are trying to solve configuration
34       problems, the verbose (and occasionally trace) messages are usually
35       sufficient. Debug messages are needed mostly for finding software
36       errors. After solving the problem, do not forget to turn these messages
37       off using the syslog-ng-ctl <command> --set=off. Note that enabling
38       debug messages does not enable verbose and trace messages.
39
40       Use syslog-ng-ctl <command> without any parameters to display whether
41       the particular type of messages are enabled or not.
42
43       If you need to use a non-standard control socket to access syslog-ng,
44       use the syslog-ng-ctl <command> --set=on --control=<socket> command to
45       specify the socket to use.
46
47       verbose
48           Print verbose messages. If syslog-ng was started with the --stderr
49           or -e option, the messages will be sent to stderr. If not
50           specified, syslog-ng will log such messages to its internal source.
51
52       trace
53           Print trace messages of how messages are processed. If syslog-ng
54           was started with the --stderr or -e option, the messages will be
55           sent to stderr. If not specified, syslog-ng will log such messages
56           to its internal source.
57
58       debug
59           Print debug messages. If syslog-ng was started with the --stderr or
60           -e option, the messages will be sent to stderr. If not specified,
61           syslog-ng will log such messages to its internal source.
62
63       Example:
64
65           syslog-ng-ctl verbose --set=on
66

THE STATS COMMAND

68       stats [options]
69
70       Use the stats command to display statistics about the processed
71       messages. The stats command has the following options:
72
73       --control=<socket> or -c
74           Specify the socket to use to access syslog-ng. Only needed when
75           using a non-standard socket.
76
77       --reset or -r
78           Reset all statistics to zero, except for the stored counters. (The
79           stored counters show the number of messages stored in the message
80           queue of the destination driver, waiting to be sent to the
81           destination.)
82
83       Example:
84
85           syslog-ng-ctl stats
86
87       An example output:
88
89           src.internal;s_all#0;;a;processed;6445
90           src.internal;s_all#0;;a;stamp;1268989330
91           destination;df_auth;;a;processed;404
92           destination;df_news_dot_notice;;a;processed;0
93           destination;df_news_dot_err;;a;processed;0
94           destination;d_ssb;;a;processed;7128
95           destination;df_uucp;;a;processed;0
96           source;s_all;;a;processed;7128
97           destination;df_mail;;a;processed;0
98           destination;df_user;;a;processed;1
99           destination;df_daemon;;a;processed;1
100           destination;df_debug;;a;processed;15
101           destination;df_messages;;a;processed;54
102           destination;dp_xconsole;;a;processed;671
103           dst.tcp;d_network#0;10.50.0.111:514;a;dropped;5080
104           dst.tcp;d_network#0;10.50.0.111:514;a;processed;7128
105           dst.tcp;d_network#0;10.50.0.111:514;a;stored;2048
106           destination;df_syslog;;a;processed;6724
107           destination;df_facility_dot_warn;;a;processed;0
108           destination;df_news_dot_crit;;a;processed;0
109           destination;df_lpr;;a;processed;0
110           destination;du_all;;a;processed;0
111           destination;df_facility_dot_info;;a;processed;0
112           center;;received;a;processed;0
113           destination;df_kern;;a;processed;70
114           center;;queued;a;processed;0
115           destination;df_facility_dot_err;;a;processed;0
116

RELOADING THE CONFIGURATION

118       command [options]
119
120       Use the syslog-ng-ctl reload command to reload the configuration file
121       of without having to restart the application. The syslog-ng-ctl reload
122       works like a SIGHUP.
123

FILES

125       /usr/local/sbin/syslog-ng-ctl
126

SEE ALSO

128       The syslog-ng Administrator Guide[2]
129
130       syslog-ng.conf(5)
131
132       syslog-ng(8)
133
134           Note
135           For the detailed documentation of see The 4.3 Administrator
136           Guide[3]
137
138           If you experience any problems or need help with syslog-ng, visit
139           the syslog-ng mailing list[4].
140
141           For news and notifications about of syslog-ng, visit the syslog-ng
142           blogs[5].
143

AUTHOR

145       This manual page was written by the Balabit Documentation Team
146       <documentation@balabit.com>.
147

NOTES

150        1. the official syslog-ng website
151           https://syslog-ng.org
152
153        2. The  Administrator Guide
154           https://www.balabit.com/support/documentation/
155
156        3. The  4.3 Administrator Guide
157           https://www.balabit.com/documents/syslog-ng-ose-latest-guides/en/syslog-ng-ose-guide-admin/html/index.html
158
159        4. syslog-ng mailing list
160           https://lists.balabit.hu/mailman/listinfo/syslog-ng
161
162        5. syslog-ng blogs
163           https://syslog-ng.org/blogs/
164
165
166
1674.3                               07/28/2023                  SYSLOG-NG-CTL(1)
Impressum