Name
loggen — Generate syslog messages at a specified rate
Synopsis
loggen [options] target [port]
Description
NOTE: The loggen application is distributed with the syslog-ng PE system logging application, and is usually part of the syslog-ng PE package.
This manual page is only an abstract, for the complete documentation of syslog-ng PE, see the syslog-ng PE Documentation page.
The loggen application is tool to test and stress-test your syslog server and the connection to the server. It can send syslog messages to the server at a specified rate using a number of connection types and protocols, including TCP, UDP, and unix domain sockets. The messages can be generated automatically (repeating the PADDstring over and over), or read from a file or the standard input. The following is a sample generated message:
<38>2017-04-05T12:16:46 localhost prg00000[1234]: seq: 0000000000, thread: 0000, runid: 1491387406, stamp: 2017-04-05T12:16:46 PADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADD
When loggen finishes sending the messages, it displays the following statistics:
-
average rate: Average rate the messages were sent in messages/second.
-
count: The total number of messages sent.
-
time: The time required to send the messages in seconds.
-
average message size: The average size of the sent messages in bytes.
-
bandwidth: The average bandwidth used for sending the messages in kilobytes/second.
Options
-
--active-connections <number-of-connections>
Number of connections loggen will use to send messages to the destination. This option is usable only when using TCP or TLS connections to the destination. Default value: 1
The loggen utility waits until every connection is established before starting to send messages. See also the --idle-connections option.
-
--csv or -C
Send the statistics of the sent messages to stdout as CSV. This can be used for plotting the message rate.
-
--dgram or -D
Use datagram socket (UDP or unix-dgram) to send the messages to the target. Requires the --inet option as well.
-
dont-parse or -d
Do not parse the lines read from the input files, send them as received.
-
--help or -h
Display a brief help message.
-
--idle-connection <number-of-connections>
Number of idle connections loggen will establish to the destination. Note that loggen will not send any messages on idle connections, but the connection is kept open using keep-alive messages. This option is usable only when using TCP or TLS connections to the destination. See also the --active-connections option. Default value: 0
-
--inet or -i
Use the TCP (by default) or UDP (when used together with the --dgram option) protocol to send the messages to the target.
-
--interval <seconds> or -I <seconds>
The number of seconds loggen will run. Default value: 10
NOTE: Note that when the --interval and --number are used together, loggen will send messages until the period set in --interval expires or the amount of messages set in --number is reached, whichever happens first.
-
--ipv6 or -6
Specify the destination using its IPv6 address. Note that the destination must have a real IPv6 address.
-
--loop-reading or -l
Read the file specified in --read-file option in loop: loggen will start reading from the beginning of the file when it reaches the end of the file.
-
--number <number-of-messages> or -n <number-of-messages>
Number of messages to generate.
NOTE: Note that when the --interval and --number are used together, loggen will send messages until the period set in --interval expires or the amount of messages set in --number is reached, whichever happens first.
-
--no-framing or -F
Do not use the framing of the IETF-syslog protocol style, even if the --syslog-proto option is set.
-
--quiet or -Q
Output statistics only when the execution of loggen is finished. If not set, the statistics are displayed every second.
-
--permanent or -T
Keep sending logs indefinitely, without time limit.
-
--rate <message/second> or -r <message/second>
The number of messages generated per second for every active connection. Default value: 1000
If you want to change the message rate while loggen is running, send SIGUSR1 to double the message rate, or SIGUSR2 to halve it:
kill -USR1 <loggen-pid>kill -USR2 <loggen-pid>
-
--read-file <filename> or -R <filename>
Read the messages from a file and send them to the target. See also the --skip-tokens option.
Specify - as the input file to read messages from the standard input (stdio). Note that when reading messages from the standard input, loggen can only use a single thread. The -R -parameters must be placed at end of command, like: loggen 127.0.0.1 1061 --read-file -
-
--sdata <data-to-send> or -p <data-to-send>
Send the argument of the --sdata option as the SDATA part of IETF-syslog (RFC5424 formatted) messages. Use it together with the --syslog-proto option. For example: --sdata "[test name=\"value\"]
-
--size <message-size> or -s <message-size>
The size of a syslog message in bytes. Default value: 256. Minimum value: 127 bytes, maximum value: 8192 bytes.
-
--skip-tokens <number>
Skip the specified number of space-separated tokens (words) at the beginning of every line. For example, if the messages in the file look like foo bar message, --skip-tokens 2 skips the foo bar part of the line, and sends only the message part. Works only when used together with the --read-file parameter. Default value: 0
-
--stream or -S
Use a stream socket (TCP or unix-stream) to send the messages to the target.
-
--syslog-proto or -P
Use the new IETF-syslog message format as specified in RFC5424. By default, loggen uses the legacy BSD-syslog message format (as described in RFC3164). See also the --no-framing option.
-
--unix </path/to/socket> or -x </path/to/socket>
Use a UNIX domain socket to send the messages to the target.
-
--use-ssl or -U
Use an SSL-encrypted channel to send the messages to the target. Note that it is not possible to check the certificate of the target, or to perform mutual authentication.
-
--version or -V
Display version number of syslog-ng.
Examples
The following command generates 100 messages per second for ten minutes, and sends them to port 2010 of the localhost via TCP. Each message is 300 bytes long.
loggen --size 300 --rate 100 --interval 600 127.0.0.1 2010
The following command is similar to the one above, but uses the UDP protocol.
loggen --inet --dgram --size 300 --rate 100 --interval 600 127.0.0.1 2010
Send a single message on TCP6 to the ::1 IPv6 address, port 1061:
loggen --ipv6 --number 1 ::1 1061
Send a single message on UDP6 to the ::1 IPv6 address, port 1061:
loggen --ipv6 --dgram --number 1 ::1 1061
Send a single message using a unix domain-socket:
loggen --unix --stream --number 1 </path/to/socket>
Read messages from the standard input (stdio) and send them to the localhost:
loggen 127.0.0.1 1061 --read-file -
Files
/opt/syslog-ng/bin/loggen
Name
pdbtool — An application to test and convert syslog-ng pattern database rules
Synopsis
pdbtool [command] [options]
Description
This manual page is only an abstract, for the complete documentation of syslog-ng PE, see the syslog-ng PE Documentation page.
The syslog-ng PE application can match the contents of the log messages to a database of predefined message patterns (also called patterndb). By comparing the messages to the known patterns, syslog-ng PE is able to identify the exact type of the messages, tag the messages, and sort them into message classes. The message classes can be used to classify the type of the event described in the log message. The functionality of the pattern database is similar to that of the logcheck project, but the syslog-ng approach is faster, scales better, and is much easier to maintain compared to the regular expressions of logcheck.
The pdbtool application is a utility that can be used to:
The dictionary command
dictionary [options]
Lists every name-value pair that can be set by the rules of the pattern database.
-
--dump-tag or -T
List the tags instead of the names of the name-value pairs.
-
--pdb <path-to-file> or -p <path-to-file>
Name of the pattern database file to use.
-
--program <programname> or -P <programname>
List only the name-value pairs that can be set for the messages of the specified $PROGRAM application.
The dump command
dump [options]
Display the RADIX tree built from the patterns. This shows how are the patterns represented in syslog-ng PE and it might also help to track down pattern-matching problems. The dump utility can dump the tree used for matching the PROGRAM or the MSG parts.
-
--debug or -d
Enable debug/diagnostic messages on stderr.
-
--pdb or -p
Name of the pattern database file to use.
-
--program or -P
Displays the RADIX tree built from the patterns belonging to the ${PROGRAM} application.
-
--program-tree or -T
Display the ${PROGRAM} tree.
-
--verbose or -v
Enable verbose messages on stderr.
Example and sample output:
pdbtool dump -p patterndb.xml -P 'sshd'
'p'
'assword for'
@QSTRING:@
'from'
@QSTRING:@
'port '
@NUMBER:@ rule_id='fc49054e-75fd-11dd-9bba-001e6806451b'
' ssh' rule_id='fc55cf86-75fd-11dd-9bba-001e6806451b'
'2' rule_id='fc4b7982-75fd-11dd-9bba-001e6806451b'
'ublickey for'
@QSTRING:@
'from'
@QSTRING:@
'port '
@NUMBER:@ rule_id='fc4d377c-75fd-11dd-9bba-001e6806451b'
' ssh' rule_id='fc5441ac-75fd-11dd-9bba-001e6806451b'
'2' rule_id='fc44a9fe-75fd-11dd-9bba-001e6806451b'
The match command
match [options]
Use the match command to test the rules in a pattern database. The command tries to match the specified message against the patterns of the database, evaluates the parsers of the pattern, and also displays which part of the message was parsed successfully. The command returns with a 0 (success) or 1 (no match) return code and displays the following information:
-
the class assigned to the message (that is, system, violation, and so on),
-
the ID of the rule that matched the message, and
-
the values of the parsers (if there were parsers in the matching pattern).
The match command has the following options:
-
--color-out or -c
Color the terminal output to highlight the part of the message that was successfully parsed.
-
--debug or -d
Enable debug/diagnostic messages on stderr.
-
--debug-csv or -C
Print the debugging information returned by the --debug-pattern option as comma-separated values.
-
--debug-pattern or -D
Print debugging information about the pattern matching. See also the --debug-csv option.
-
--file=<filename-with-path> or -f
Process the messages of the specified log file with the pattern database. This option allows to classify messages offline, and to apply the pattern database to already existing logfiles. To read the messages from the standard input (stdin), specify a hyphen (-) character instead of a filename.
-
--filter=<filter-expression> or -F
Print only messages matching the specified syslog-ng filter expression.
-
--message or -M
The text of the log message to match (only the ${MESSAGE} part without the syslog headers).
-
--pdb or -p
Name of the pattern database file to use.
-
--program or -P
Name of the program to use, as contained in the ${PROGRAM} part of the syslog message.
-
--template=<template-expression> or -T
A syslog-ng template expression that is used to format the output messages.
-
--verbose or -v
Enable verbose messages on stderr.
Example:
The following command checks if the patterndb.xml file recognizes the Accepted publickey for myuser from 127.0.0.1 port 59357 ssh6 message:
pdbtool match -p patterndb.xml -P sshd -M "Accepted publickey for myuser from 127.0.0.1 port 59357 ssh6"
Example:
The following example applies the sshd.pdb pattern database file to the log messages stored in the /var/log/messages file, and displays only the messages that received a useracct tag.
pdbtool match -p sshd.pdb \
–file /var/log/messages \
–filter ‘tags(“usracct”);’
The merge command
merge [options]
Use the merge command to combine separate pattern database files into a single file (pattern databases are usually stored in separate files per applications to simplify maintenance). If a file uses an older database format, it is automatically updated to the latest format (V3). See the The syslog-ng Administrator Guide for details on the different pattern database versions.
-
--debug or -d
Enable debug/diagnostic messages on stderr.
-
--directory or -D
The directory that contains the pattern database XML files to be merged.
-
--glob or -G
Specify filenames to be merged using a glob pattern, for example, using wildcards. For details on glob patterns, see man glob. This pattern is applied only to the filenames, and not on directory names.
-
--pdb or -p
Name of the output pattern database file.
-
--recursive or -r
Merge files from subdirectories as well.
-
--verbose or -v
Enable verbose messages on stderr.
Example:
pdbtool merge --recursive --directory /home/me/mypatterns/ --pdb /var/lib/syslog-ng/patterndb.xml
Currently it is not possible to convert a file without merging, so if you only want to convert an older pattern database file to the latest format, you have to copy it into an empty directory.
The patternize command
patternize [options]
Automatically create a pattern database from a log file containing a large number of log messages. The resulting pattern database is printed to the standard output (stdout). The pdbtool patternize command uses a data clustering technique to find similar log messages and replacing the differing parts with @ESTRING:: @ parsers. For details on pattern databases and message parsers, see the The syslog-ng Administrator Guide. The patternize command is available only in version 3.2 and later.
-
--debug or -d
Enable debug/diagnostic messages on stderr.
-
--file=<path> or -f
The logfile containing the log messages to create patterns from. To receive the log messages from the standard input (stdin), use -.
-
--iterate-outliers or -o
Recursively iterate on the log lines to cover as many log messages with patterns as possible.
-
--named-parsers or -n
The number of example log messages to include in the pattern database for every pattern. Default value: 1
-
--no-parse or -p
Do not parse the input file, treat every line as the message part of a log message.
-
--samples=<number-of-samples>
Include a generated name in the parsers, for example, .dict.string1, .dict.string2, and so on.
-
--support=<number> or -S
A pattern is added to the output pattern database if at least the specified percentage of log messages from the input logfile match the pattern. For example, if the input logfile contains 1000 log messages and the --support=3.0 option is used, a pattern is created only if the pattern matches at least 3 percent of the log messages (that is, 30 log messages). If patternize does not create enough patterns, try to decrease the support value.
Default value: 4.0
-
--verbose or -v
Enable verbose messages on stderr.
Example:
pdbtool patternize --support=2.5 --file=/var/log/messages
The test command
test [options]
Use the test command to validate a pattern database XML file. Note that you must have the xmllint application installed. The test command is available only in syslog-ng PE version 3.2 and later.
-
--color-out or -c
Enable coloring in terminal output.
-
--debug or -d
Enable debug/diagnostic messages on stderr.
-
--debug or -D
Print debugging information on non-matching patterns.
-
--rule-id or -r
Test only the patterndb rule (specified by its rule id) against its example.
-
--validate
Validate a pattern database XML file.
-
--verbose or -v
Enable verbose messages on stderr.
Example:
pdbtool test --validate /home/me/mypatterndb.pdb
Files
/opt/syslog-ng/
/opt/syslog-ng/etc/syslog-ng.conf
Name
persist-tool — Display the content of the persist file
Synopsis
persist-tool [command] [options]
Description
NOTE: The persist-tool application is distributed with the syslog-ng PE system logging application, and is usually part of the syslog-ng PE package.
This manual page is only an abstract, for the complete documentation of syslog-ng PE, see the syslog-ng PE Documentation page.
The persist-tool application is a utility that can be used to dump the content of the persist file, and manipulate its content.
|
|
CAUTION:Persist-tool is a special tool for syslog-ng experts. Do use the tool unless you know exactly what you are doing. Misconfiguring it will result in irrecoverable damage to the persist file, without any warning. |
The dump command
dump [options] [persist_file]
Use the dump command to print the current content of the persist file in JSON format to the console.
The dump command has the following options:
Example: persist-tool dump
persist-tool dump /opt/syslog-ng/var/syslog-ng.persist
The output looks like:
run_id = { "value": "00 00 00 00 0C 00 00 00 " }
host_id = { "value": "00 00 00 00 5F 49 2F 01 " }
The add command
add [options] [input_file]
Use the add command to add or modify a specified state-entry in the persist file. The state-entry should be in the same format as the dump command displays it. If the given state-entry already exists, it will be updated. Otherwise, a new value will be added. If the given persist state is invalid, it will be skipped.
To use the add command: use persist-tool dump to print the content of the current persist file, and redirect it to a file. Edit the content of this file. Use persist-tool add with this file to modify the persist.
The add command has the following options:
-
--help or -?
Display a brief help message.
-
--output-dir=<directory> or -o
Required parameter. The directory where the persist file is located at. The name of the persist file stored in this directory must be syslog-ng.persist.
-
--persist-name=<filename> or -p
Optional parameter. The name of the persist file to generate. Default value: syslog-ng.persist.
Example:
/opt/syslog-ng/bin/persist-tool add dump_persist -o .
The valid output looks like:
log_reader_curpos(Application) OK
affile_sd_curpos(/var/aaa.txt) OK
The invalid output looks like:
log_reader_curpos(Application) OK
wrong
FAILED (error: Invalid entry syntax)
affile_sd_curpos(/var/aaa.txt) OK
Files
/opt/syslog-ng/bin/persist-tool
Name
syslog-debun — syslog-ng DEBUg buNdle generator
Synopsis
syslog-debun [options]
Description
NOTE: The syslog-debun application is distributed with the syslog-ng PE system logging application, and is usually part of the syslog-ng PE package.
The syslog-debun tool collects and saves information about your syslog-ng PE installation, making troubleshooting easier, especially if you ask help about your syslog-ng PE related problem.
General Options
-
-h
Display the help page.
-
-l
Do not collect privacy-sensitive data, for example, process tree, fstab, and so on. If you use with -d, then the following parameters will be used for debug mode:-Fev
-
-R <directory>
The directory where syslog-ng PE is installed instead of /opt/syslog-ng.
-
-W <directory>
Set the working directory, where the debug bundle will be saved. Default value: /tmp. The name of the created file is syslog.debun.${host}.${date}.${3-random-characters-or-pid}.tgz
Debug mode options
-
-d
Start syslog-ng PE in debug mode, using the -Fedv --enable-core options.
|
|
CAUTION: 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. |
-
-D <options>
Start syslog-ng PE in debug mode, using the specified command-line options. To exit debug mode, press Enter.
-
-t <seconds>
Run syslog-ng PE in noninteractive debug mode for <seconds>, and automatically exit debug mode after the specified number of seconds.
-
-w <seconds>
Wait <seconds> seconds before starting debug mode.
System call tracing
-
-s
Enable syscall tracing (strace -f or truss -f). Note that using -s itself does not enable debug mode, only traces the system calls of an already running syslog-ng PE process. To trace system calls in debug mode, use both the -s and -d options.
Packet capture options
Capturing packets requires a packet capture tool on the host. The syslog-debun tool attempts to use tcpdump on most platforms, except for Solaris, where it uses snoop.
-
-i <interface>
Capture packets only on the specified interface, for example, eth0.
-
-p
Capture incoming packets using the following filter: port 514 or port 601 or port 53
-
-P <options>
Capture incoming packets using the specified filter.
-
-t <seconds>
Run syslog-ng PE in noninteractive debug mode for <seconds>, and automatically exit debug mode after the specified number of seconds.
Examples
syslog-debun
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.
syslog-debun -l
Similar to syslog-debun, 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.
syslog-debun -d
Similar to syslog-debun, but it also stops syslog-ng PE, then restarts it in debug mode (-Fedv --enable-core). To stop debug mode, press Enter. The output of the debug mode collected into a separate file, and also added to the debug bundle.
syslog-debun -s
Trace the system calls (using strace or truss) of an already running syslog-ng PE process.
syslog-debun -d -s
Restart syslog-ng PE in debug mode, and also trace the system calls (using strace or truss) of the syslog-ng PE process.
syslog-debun -p
Run packet capture (pcap) with the filter: port 514 or port 601 or port 53 Also waits for pressing Enter, like debug mode.
syslog-debun -p -t 10
Noninteractive debug mode: Similar to syslog-debun -p, but automatically exit after 10 seconds.
syslog-debun -P "host 1.2.3.4" -D "-Fev --enable-core"
Change the packet-capturing filter from the default to host 1.2.3.4. Also change debugging parameters from the default to -Fev --enable-core. Since a timeout (-t) is not given, waits for pressing Enter.
syslog-debun -p -d -w 5 -t 10
Collect pcap and debug mode output following this scenario:
Files
/opt/syslog-ng/bin/loggen
