[syslog-ng] syslog-ng OSE 3.4 Administrator Guide draft update

Balazs Scheidler bazsi at balabit.hu
Fri Dec 7 06:28:12 CET 2012

On Sat, 2012-11-10 at 20:59 +0100, Fekete Róbert wrote:
> Hi, 

> My colleague, Ancsur Sebestyen had some time this week to work on the 3.4 admin guide a bit. Still far from being finished or up-to-date, the following new stuff has been documented since the first draft:
> * The tfhash template function

I would propose a different name of the "tfhash" function. As it is,
tfhash is only the name of the module that hosts these functions,
however, with the on-demand module loading feature of syslog-ng 3.4, it
doesn't really matter.

On the other hand, the names of the supported functions should be more
prominent, so perhaps listing the available functions in the title would
be better.

I saw a typo when explaining the --length parameter, it is written as

> * The JSON parser

I couldn't find this in the index, perhaps an indexterm is missing?

marker() descripton is not that easy to understand, it is basically a
prefix in front of the actual json payload, which identifies that it is
actually JSON. It is used by CEE. All non-matching messages are simply
not allowed through the parser (e.g. they get dropped if there's no
alternate path for them, just like a filter).

The prefix could also use some clarity, and a simple example within the
description of the option.

> * The --disable-json	compile option

I didn't know we had a section on configure otpion, but it's nice.

btw: json-glib support has been dropped.

> * The @PCRE@ patterndb parser


> * Bug 204: dbparser docs not clear for @NUMBER@
> * Bug 205 Docs for macro MSGHDR incorrecthttps://www.balabit.com/sites/default/files/documents/syslog-ng-ose-3.4-guides/syslog-ng-ose-v3.4-guide-admin-en/html/bk01-toc.htmlg

ok and ok :)

> * The LOGHOST macro


> * The syslog-ng-ctl reload option is included in the syslog-ng-ctl man page

somehow, this got messy with the title reading "Enabling troublshooting
messages", then explaining the general synopsis for using syslog-ng-ctl
commands, and then only listing "reload".

> Also, the links to the docs have changed. The new ones are: 
> HTML: https://www.balabit.com/sites/default/files/documents/syslog-ng-ose-3.4-guides/syslog-ng-ose-v3.4-guide-admin-en/html/bk01-toc.html
> Single-page HTML: https://www.balabit.com/sites/default/files/documents/syslog-ng-ose-3.4-guides/syslog-ng-ose-v3.4-guide-admin-en/html-single/index.html
> PDF: https://www.balabit.com/sites/default/files/documents/syslog-ng-ose-3.4-guides/syslog-ng-ose-v3.4-guide-admin-en/pdf/syslog-ng-ose-v3.4-guide-admin-en.pdf
> As always, any feedback is welcome. 

thanks for the updates, your work and the syslog-ng manual is
appreciated. :)


More information about the syslog-ng mailing list