← Back to branch summary

~ubuntu-branches/ubuntu/trusty/syslog-ng/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/man/syslog-ng.conf.5.in

  • Committer: Package Import Robot
  • Author(s): Laszlo Boszormenyi (GCS), Gergely Nagy
  • Date: 2011-10-11 14:30:48 UTC
  • mfrom: (1.3.7)
  • Revision ID: package-import@ubuntu.com-20111011143048-r1iljux9xbvj3lwh
Tags: 3.3.1.dfsg-1
http://bugs.debian.org/496521
http://bugs.debian.org/616069
http://bugs.debian.org/630172
http://bugs.debian.org/609154
http://bugs.debian.org/608605
http://bugs.debian.org/644458
http://bugs.debian.org/634715
http://bugs.debian.org/589081
* New upstream release with important fixes from upstream git tree with
  non-free manpages removed.
* Drop syslog-ng.conf(5) (closes: #496521).
* syslog-ng(8) is generated, and does not mention -Q anymore
  (closes: #616069).
* Supports CAP_SYSLOG on recent kernels (closes: #630172).
* Does not use g_timeout_add_seconds anymore (closes: #609154).

[ Gergely Nagy <algernon@madhouse-project.org> ]
* Update debian/copyright to DEP-5 format.
* Simplified the logrotate file by merging identical entries.
* Include local configuration files from /etc/syslog-ng/conf.d/ (Closes:
  #609050).
* Update syslog-ng.conf to be fully 3.3 compliant.
* Compress both source and binaries (except the syslog-ng meta
  package) with xz, instead of gzip.
* Use dpkg triggers to restart syslog-ng when appropriate.
* Include DFSG-free manual pages for all binaries.
* Build with Hardening enabled.
* Mention syslog(3) in /etc/default/syslog-ng, instead of
  <linux/kernel.h> (Closes: #608605)
* Support 'status' in the init script.
  Patch from Peter Eisentraut <petere@debian.org> (Closes: #644458)
* Build-Depend on libevtlog-dev (>= 0.2.12-5~) for correct shlibs.
* Use [linux-any] in Build-Depends instead of hardcoded links.
  (Closes: #634715)
* Use $SYSLOGNG_OPTS in the init script when reloading syslog-ng.
  (Closes: #589081)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/syslog-ng.conf.5.in
1
 
'\" t
2
 
.\"     Title: syslog-ng.conf
3
 
.\"    Author: [see the "Author" section]
4
 
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5
 
.\"      Date: 06/30/2010
6
 
.\"    Manual: The syslog-ng.conf manual page
7
 
.\"    Source: syslog-ng 3.2
8
 
.\"  Language: English
9
 
.\"
10
 
.TH "SYSLOG\-NG\&.CONF" "5" "06/30/2010" "syslog\-ng" "The syslog-ng.conf manual page"
11
 
.\" -----------------------------------------------------------------
12
 
.\" * set default formatting
13
 
.\" -----------------------------------------------------------------
14
 
.\" disable hyphenation
15
 
.nh
16
 
.\" disable justification (adjust text to left margin only)
17
 
.ad l
18
 
.\" -----------------------------------------------------------------
19
 
.\" * MAIN CONTENT STARTS HERE *
20
 
.\" -----------------------------------------------------------------
21
 
.SH "NAME"
22
 
syslog-ng.conf \- syslog\-ng configuration file
23
 
.SH "SYNOPSIS"
24
 
.HP \w'\fBsyslog\-ng\&.conf\fR\ 'u
25
 
\fBsyslog\-ng\&.conf\fR
26
 
.SH "DESCRIPTION"
27
 
.PP
28
 
This manual page is only an abstract; for the complete documentation of syslog\-ng, see
29
 
\m[blue]\fBThe syslog\-ng Administrator Guide\fR\m[]\&\s-2\u[2]\d\s+2\&.
30
 
.PP
31
 
The syslog\-ng application is a flexible and highly scalable system logging application\&. Typically, syslog\-ng is used to manage log messages and implement centralized logging, where the aim is to collect the log messages of several devices on a single, central log server\&. The different devices \- called syslog\-ng clients \- all run syslog\-ng, and collect the log messages from the various applications, files, and other
32
 
\fIsources\fR\&. The clients send all important log messages to the remote syslog\-ng server, where the server sorts and stores them\&.
33
 
.PP
34
 
The syslog\-ng application reads incoming messages and forwards them to the selected
35
 
\fIdestinations\fR\&. The syslog\-ng application can receive messages from files, remote hosts, and other
36
 
\fIsources\fR\&.
37
 
.PP
38
 
Log messages enter syslog\-ng in one of the defined sources, and are sent to one or more
39
 
\fIdestinations\fR\&.
40
 
.PP
41
 
Sources and destinations are independent objects;
42
 
\fIlog paths\fR
43
 
define what syslog\-ng does with a message, connecting the sources to the destinations\&. A log path consists of one or more sources and one or more destinations; messages arriving to a source are sent to every destination listed in the log path\&. A log path defined in syslog\-ng is called a
44
 
\fIlog statement\fR\&.
45
 
.PP
46
 
Optionally, log paths can include
47
 
\fIfilters\fR\&. Filters are rules that select only certain messages, for example, selecting only messages sent by a specific application\&. If a log path includes filters, syslog\-ng sends only the messages satisfying the filter rules to the destinations set in the log path\&.
48
 
.SH "CONFIGURING SYSLOG-NG"
49
 
.PP
50
 
Global objects (for example sources, destinations, log paths, or filters) are defined in the syslog\-ng configuration file\&. Object definitions consist of the following elements:
51
 
.sp
52
 
.RS 4
53
 
.ie n \{\
54
 
\h'-04'\(bu\h'+03'\c
55
 
.\}
56
 
.el \{\
57
 
.sp -1
58
 
.IP \(bu 2.3
59
 
.\}
60
 
\fIType of the object\fR: One of
61
 
\fIsource\fR,
62
 
\fIdestination\fR,
63
 
\fIlog\fR,
64
 
\fIfilter\fR,
65
 
\fIparser\fR,
66
 
\fIrewrite\fR
67
 
rule, or
68
 
\fItemplate\fR\&.
69
 
.RE
70
 
.sp
71
 
.RS 4
72
 
.ie n \{\
73
 
\h'-04'\(bu\h'+03'\c
74
 
.\}
75
 
.el \{\
76
 
.sp -1
77
 
.IP \(bu 2.3
78
 
.\}
79
 
\fIIdentifier of the object\fR: A unique name identifying the object\&. When using a reserved word as an identifier, enclose the identifier in quotation marks\&.
80
 
.if n \{\
81
 
.sp
82
 
.\}
83
 
.RS 4
84
 
.it 1 an-trap
85
 
.nr an-no-space-flag 1
86
 
.nr an-break-flag 1
87
 
.br
88
 
.ps +1
89
 
\fBTip\fR
90
 
.ps -1
91
 
.br
92
 
Use identifiers that refer to the type of the object they identify\&. For example, prefix source objects with
93
 
\fIs_\fR, destinations with
94
 
\fId_\fR, and so on\&.
95
 
.sp .5v
96
 
.RE
97
 
.RE
98
 
.sp
99
 
.RS 4
100
 
.ie n \{\
101
 
\h'-04'\(bu\h'+03'\c
102
 
.\}
103
 
.el \{\
104
 
.sp -1
105
 
.IP \(bu 2.3
106
 
.\}
107
 
\fIParameters\fR: The parameters of the object, enclosed in braces
108
 
\fI{parameters}\fR\&.
109
 
.RE
110
 
.sp
111
 
.RS 4
112
 
.ie n \{\
113
 
\h'-04'\(bu\h'+03'\c
114
 
.\}
115
 
.el \{\
116
 
.sp -1
117
 
.IP \(bu 2.3
118
 
.\}
119
 
\fISemicolon\fR: Object definitions end with a semicolon (\fI;\fR)\&.
120
 
.RE
121
 
.PP
122
 
The syntax is summarized as follows:
123
 
.PP
124
 
The syntax of log statements is as follows:
125
 
.sp
126
 
.if n \{\
127
 
.RS 4
128
 
.\}
129
 
.nf
130
 
log {
131
 
    source(s1); source(s2); \&.\&.\&. 
132
 
    optional_element(filter1|parser1|rewrite1); optional_element(filter2|parser2|rewrite2);\&.\&.\&. 
133
 
    destination(d1); destination(d2); \&.\&.\&. 
134
 
    flags(flag1[, flag2\&.\&.\&.]);
135
 
    };
136
 
.fi
137
 
.if n \{\
138
 
.RE
139
 
.\}
140
 
.PP
141
 
The following log statement sends all messages arriving to the localhost to a remote server\&.
142
 
.sp
143
 
.if n \{\
144
 
.RS 4
145
 
.\}
146
 
.nf
147
 
source s_localhost { tcp(ip(127\&.0\&.0\&.1) port(1999) ); };
148
 
destination d_tcp { tcp("10\&.1\&.2\&.3" port(1999); localport(999)); };
149
 
log { source(s_localhost); destination(d_tcp); };
150
 
.fi
151
 
.if n \{\
152
 
.RE
153
 
.\}
154
 
.PP
155
 
The syslog\-ng application has a number of global options governing DNS usage, the timestamp format used, and other general points\&. Each option may have parameters, similarly to driver specifications\&. To set global options, add an option statement to the syslog\-ng configuration file using the following syntax:
156
 
.sp
157
 
.if n \{\
158
 
.RS 4
159
 
.\}
160
 
.nf
161
 
options { option1(params); option2(params); \&.\&.\&. };
162
 
.fi
163
 
.if n \{\
164
 
.RE
165
 
.\}
166
 
.PP
167
 
The sources, destinations, and filters available in syslog\-ng are listed below\&. For details, see
168
 
\m[blue]\fBThe syslog\-ng Administrator Guide\fR\m[]\&\s-2\u[2]\d\s+2\&.
169
 
.sp
170
 
.it 1 an-trap
171
 
.nr an-no-space-flag 1
172
 
.nr an-break-flag 1
173
 
.br
174
 
.B Table\ \&1.\ \&Source drivers available in syslog-ng
175
 
.TS
176
 
allbox tab(:);
177
 
lB lB.
178
 
T{
179
 
Name
180
 
T}:T{
181
 
Description
182
 
T}
183
 
.T&
184
 
l l
185
 
l l
186
 
l l
187
 
l l
188
 
l l
189
 
l l
190
 
l l
191
 
l l
192
 
l l
193
 
l l.
194
 
T{
195
 
internal()
196
 
T}:T{
197
 
Messages generated internally in syslog\-ng\&.
198
 
T}
199
 
T{
200
 
file()
201
 
T}:T{
202
 
Opens the specified file and reads messages\&.
203
 
T}
204
 
T{
205
 
pipe(), fifo
206
 
T}:T{
207
 
Opens the specified named pipe and reads messages\&.
208
 
T}
209
 
T{
210
 
program()
211
 
T}:T{
212
 
Opens the specified application and reads messages from its standard output\&.
213
 
T}
214
 
T{
215
 
sun\-stream(), sun\-streams()
216
 
T}:T{
217
 
Opens the specified \fISTREAMS\fR device on Solaris systems and reads incoming messages\&.
218
 
T}
219
 
T{
220
 
syslog()
221
 
T}:T{
222
 
Listens for incoming messages using the new IETF\-standard syslog protocol\&.
223
 
T}
224
 
T{
225
 
tcp(), tcp6()
226
 
T}:T{
227
 
Listens on the specified TCP port for incoming messages using the BSD\-syslog protocol over IPv4 and IPv6 networks, respectively\&.
228
 
T}
229
 
T{
230
 
udp(), udp6()
231
 
T}:T{
232
 
Listens on the specified UDP port for incoming messages using the BSD\-syslog protocol over IPv4 and IPv6 networks, respectively\&.
233
 
T}
234
 
T{
235
 
unix\-dgram()
236
 
T}:T{
237
 
Opens the specified unix socket in \fISOCK_DGRAM\fR mode and listens for incoming messages\&.
238
 
T}
239
 
T{
240
 
unix\-stream()
241
 
T}:T{
242
 
Opens the specified unix socket in \fISOCK_STREAM\fR mode and listens for incoming messages\&.
243
 
T}
244
 
.TE
245
 
.sp 1
246
 
.sp
247
 
.it 1 an-trap
248
 
.nr an-no-space-flag 1
249
 
.nr an-break-flag 1
250
 
.br
251
 
.B Table\ \&2.\ \&Destination drivers available in syslog-ng
252
 
.TS
253
 
allbox tab(:);
254
 
lB lB.
255
 
T{
256
 
Name
257
 
T}:T{
258
 
Description
259
 
T}
260
 
.T&
261
 
l l
262
 
l l
263
 
l l
264
 
l l
265
 
l l
266
 
l l
267
 
l l
268
 
l l
269
 
l l
270
 
l l
271
 
l l.
272
 
T{
273
 
file()
274
 
T}:T{
275
 
Writes messages to the specified file\&.
276
 
T}
277
 
T{
278
 
fifo(), pipe()
279
 
T}:T{
280
 
Writes messages to the specified named pipe\&.
281
 
T}
282
 
T{
283
 
program()
284
 
T}:T{
285
 
Forks and launches the specified program, and sends messages to its standard input\&.
286
 
T}
287
 
T{
288
 
sql()
289
 
T}:T{
290
 
Sends messages into an SQL database\&. In addition to the standard syslog\-ng packages, the \fIsql()\fR destination requires database\-specific packages to be installed\&. Refer to the section appropriate for your platform in ???\&.
291
 
T}
292
 
T{
293
 
syslog()
294
 
T}:T{
295
 
Sends messages to the specified remote host using the IETF\-syslog protocol\&. The IETF standard supports message transport using the UDP, TCP, and TLS networking protocols\&.
296
 
T}
297
 
T{
298
 
tcp() and tcp6()
299
 
T}:T{
300
 
Sends messages to the specified TCP port of a remote host using the BSD\-syslog protocol over IPv4 and IPv6, respectively\&.
301
 
T}
302
 
T{
303
 
udp() and udp6()
304
 
T}:T{
305
 
Sends messages to the specified UDP port of a remote host using the BSD\-syslog protocol over IPv4 and IPv6, respectively\&.
306
 
T}
307
 
T{
308
 
unix\-dgram()
309
 
T}:T{
310
 
Sends messages to the specified unix socket in \fISOCK_DGRAM\fR style (BSD)\&.
311
 
T}
312
 
T{
313
 
unix\-stream()
314
 
T}:T{
315
 
Sends messages to the specified unix socket in \fISOCK_STREAM\fR style (Linux)\&.
316
 
T}
317
 
T{
318
 
usertty()
319
 
T}:T{
320
 
Sends messages to the terminal of the specified user, if the user is logged in\&.
321
 
T}
322
 
.TE
323
 
.sp 1
324
 
.SH "FILES"
325
 
.PP
326
 
 
327
 
@expanded_sysconfdir@/syslog\-ng\&.conf
328
 
.SH "SEE ALSO"
329
 
.PP
330
 
 
331
 
\fBsyslog\-ng\fR(8)
332
 
.PP
333
 
 
334
 
\m[blue]\fBThe syslog\-ng Administrator Guide\fR\m[]\&\s-2\u[2]\d\s+2
335
 
.PP
336
 
If you experience any problems or need help with syslog\-ng, visit the
337
 
\m[blue]\fBsyslog\-ng mailing list\fR\m[]\&\s-2\u[3]\d\s+2
338
 
.PP
339
 
For news and notifications about the documentation of syslog\-ng, visit the
340
 
\m[blue]\fBBalaBit Documentation Blog\fR\m[]\&\s-2\u[4]\d\s+2\&.
341
 
.SH "AUTHOR"
342
 
.PP
343
 
This manual page was written by the BalaBit Documentation Team <documentation@balabit\&.com>\&.
344
 
.SH "COPYRIGHT"
345
 
.PP
346
 
Copyright \(co 2000\-2009 BalaBit IT Security Ltd\&. Published under the Creative Commons Attribution\-Noncommercial\-No Derivative Works (by\-nc\-nd) 3\&.0 license\&. See
347
 
\m[blue]\fBhttp://creativecommons\&.org/\fR\m[]
348
 
for details\&. The latest version is always available at
349
 
\m[blue]\fBhttp://www\&.balabit\&.com/support/documentation\fR\m[]\&.
350
 
.SH "NOTES"
351
 
.IP " 1." 4
352
 
official syslog-ng website
353
 
.RS 4
354
 
\%http://www.balabit.com/network-security/syslog-ng/
355
 
.RE
356
 
.IP " 2." 4
357
 
The syslog-ng Administrator Guide
358
 
.RS 4
359
 
\%http://www.balabit.com/support/documentation/
360
 
.RE
361
 
.IP " 3." 4
362
 
syslog-ng mailing list
363
 
.RS 4
364
 
\%https://lists.balabit.hu/mailman/listinfo/syslog-ng
365
 
.RE
366
 
.IP " 4." 4
367
 
BalaBit Documentation Blog
368
 
.RS 4
369
 
\%http://robert.blogs.balabit.com
370
 
.RE