You can list all active metrics on your syslog-ng OSE host using the following command (this lists the metrics, without their current values): syslog-ng-ctl query list "*"
To list the metrics and their values, use the following command: syslog-ng-ctl query get "*"
The displayed metrics have the following structure.
The type of the object (for example, dst.file, tag, src.facility)
The ID of the object used in the syslog-ng configuration file, for example, d_internal or source.src_tcp. The #0 part means that this is the first destination in the destination group.
The instance ID (destination) of the object, for example, the filename of a file destination, or the name of the application for a program source or destination.
The status of the object. One of the following:
a - active. At the time of quering the statistics, the source or the destination was still alive (it continuously received statistical data).
d - dynamic. Such objects may not be continuously available, for example, like statistics based on the sender's hostname. These counters only appear above a certain value of stats-level() global option:
host: source host, from stats-level(2)
sender: sender host, from stats-level(3)
program: program, from stats-level(3)
The following example contains 6 different dynamic values: a sender, a host, and four different programs.
src.sender;;localhost;d;processed;4 src.sender;;localhost;d;stamp;1509121934 src.program;;P-18069;d;processed;1 src.program;;P-18069;d;stamp;1509121933 src.program;;P-21491;d;processed;1 src.program;;P-21491;d;stamp;1509121934 src.program;;P-9774;d;processed;1 src.program;;P-9774;d;stamp;1509121919 src.program;;P-14737;d;processed;1 src.program;;P-14737;d;stamp;1509121931 src.host;;localhost;d;processed;4 src.host;;localhost;d;stamp;1509121934
To avoid performance issues or even overloading syslog-ng OSE, you might want to limit the number of registered dynamic counters in the message statistics. To do this, configure the stats-max-dynamics() global option.
o - This object was once active, but stopped receiving messages. (for example, a dynamic object may disappear and become orphan.)
The syslog-ng OSE application stores the statistics of the objects when syslog-ng OSE is reloaded. However, if the configuration of syslog-ng OSE was changed since the last reload, the statistics of orphaned objects are deleted.
The type of the statistics:
processed: The number of messages that successfully reached their destination driver. Note that this does not necessarily mean that the destination driver successfully delivered the messages (for example, written to disk or sent to a remote server).
dropped: The number of dropped messages — syslog-ng OSE could not send the messages to the destination and the output buffer got full, so messages were dropped by the destination driver, or syslog-ng OSE dropped the message for some other reason (for example, a parsing error).
queued: The number of messages passed to the message queue of the destination driver, waiting to be sent to the destination.
suppressed: The number of suppressed messages (if the suppress() feature is enabled).
stamp: The UNIX timestamp of the last message sent to the destination.
discarded: The number of messages discarded by the given parser. These are messages that the parser could not parsed, and are therefore not processed. For example:
memory_usage: The memory used by the messages in the different queue types (in bytes). This includes every queue used by the object, including memory buffers (log-fifo) and disk-based buffers (both reliable and non-reliable). For example:
Note that the memory usage (size) of queues does not equal to the memory usage (size) of the log messages in syslog-ng OSE. A log message can be in multiple queues, thus its size is added to multiple queue sizes. To check the size of all log messages, use global.msg_allocated_bytes.value metric.
matched: The number of messages that are accepted by a given filter. Available for filters and similar objects (for example, a conditional rewrite rule). For example, if a filter matches a specific hostname, then the matched counter contains the number of messages that reached the filter from this hosts.
not_matched: The number of messages that are filtered out by a given filter. Available for filters and similar objects (for example, a conditional rewrite rule). For example, if a filter matches a specific hostname, then the not_matched counter contains the number of messages that reached the filter from other hosts, and so the filter discarded them. Note that since the not_matched metric applies to filters, and filters are expected to discard messages that do not match the filter condition, not_matched messages are not included in the dropped metric of other objects.
written: The number of messages successfully delivered to the destination. This value is calculated from other counters: written = processed - queued - dropped. That is, the number of messages syslog-ng OSE passed to the destination driver (processed) minus the number of messages that are still in the output queue of the destination driver (queued) and the number of messages dropped because of an error (dropped, for example, because syslog-ng OSE could not deliver the message to the destination and exceeded the number of retries).
This metric is calculated from other metrics. You cannot reset this metric directly: to reset it, you have to reset the metrics it is calculated from.
The number of such messages.
Certain statistics are available only if the stats-level() global option is set to a higher value.
Level 0 collects only statistics about the sources and destinations.
Level 1 contains details about the different connections and log files, but has a slight memory overhead.
Level 2 contains detailed statistics based on the hostname.
Level 3 contains detailed statistics based on various message parameters like facility, severity, or tags.
When receiving messages with non-standard facility values (that is, higher than 23), these messages will be listed as other facility instead of their facility number.
If the stats-freq() global option is higher than 0, syslog-ng OSE periodically sends a log statistics message. This message contains statistics about the received messages, and about any lost messages since the last such message. It includes a processed entry for every source and destination, listing the number of messages received or sent, and a dropped entry including the IP address of the server for every destination where syslog-ng has lost messages. The center(received) entry shows the total number of messages received from every configured sources.
The following is a sample log statistics message for a configuration that has a single source (s_local) and a network and a local file destination (d_network and d_local, respectively). All incoming messages are sent to both destinations.
Log statistics; dropped='tcp(AF_INET(192.168.10.1:514))=6439', processed='center(received)=234413', processed='destination(d_tcp)=234413', processed='destination(d_local)=234413', processed='source(s_local)=234413'
The statistics include a list of source groups and destinations, as well as the number of processed messages for each. You can control the verbosity of the statistics using the stats-level() global option. The following is an example output.
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;queued;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
The statistics are semicolon separated: every line contains statistics for a particular object (for example, source, destination, tag, and so on). The statistics have the following fields:
To reset the statistics to zero, use the following command: syslog-ng-ctl stats --reset
Starting with version
This section is a brief overview on how syslog-ng OSE works in multithreaded mode. It is mainly for illustration purposes: the concept has been somewhat simplified and may not completely match reality.
The way syslog-ng OSE uses multithreading may change in future releases. The current documentation applies to version 3.25.
syslog-ng OSE always uses multiple threads:
A main thread that is always running
A number of worker threads that process the messages. You can influence the behavior of worker threads using the threaded() option and the --worker-threads command-line option.
Some other, special threads for internal functionalities. For example, certain destinations run in a separate thread, independently of the multithreading (threaded()) and --worker-threads settings of syslog-ng OSE.
The maximum number of worker threads syslog-ng OSE uses is the number of CPUs or cores in the host running syslog-ng OSE (up to 64). You can limit this value using the --worker-threads command-line option that sets the maximum total number of threads syslog-ng OSE can use, including the main syslog-ng OSE thread. However, the --worker-threads option does not affect the supervisor of syslog-ng OSE. The supervisor is a separate process (see The syslog-ng manual page), but certain operating systems might display it as a thread. In addition, certain destinations always run in a separate thread, independently of the multithreading (threaded()) and --worker-threads settings of syslog-ng OSE.
When an event requiring a new thread occurs (for example, syslog-ng OSE receives new messages, or a destination becomes available), syslog-ng OSE tries to start a new thread. If there are no free threads, the task waits until a thread finishes its task and becomes available. There are two types of worker threads:
Reader threads read messages from a source (as many as possible, but limited by the log-fetch-limit() and log-iw-size() options). The thread then processes these messages, that is, performs filtering, rewriting and other tasks as necessary, and puts the log message into the queue of the destination. If the destination does not have a queue (for example, usertty), the reader thread sends the message to the destination, without the interaction of a separate writer thread.
Writer threads take the messages from the queue of the destination and send them to the destination, that is, write the messages into a file, or send them to the syslog server over the network. The writer thread starts to process messages from the queue only if the destination is writable, and there are enough messages in the queue, as set in the flush-lines() option. Writer threads stop processing messages when the destination becomes unavailable, or there are no more messages in the queue.
The following list describes which sources and destinations can use multiple threads. Changing the --worker-threads command-line option changes the number of threads available to these sources and destinations.
The tcp and syslog(tcp) sources can process independent connections in separate threads. The number of independent connections is limited by the max-connections() option of the source. Separate sources are processed by separate thread, for example, if you have two separate tcp sources defined that receive messages on different IP addresses or port, syslog-ng OSE will use separate threads for these sources even if they both have only a single active connection.
The udp, file, and pipe sources use a single thread for every source statement.
The tcp, syslog, and pipe destinations use a single thread for every destination.
The file destination uses a single thread for writing the destination file, but may use a separate thread for each destination file if the filename includes macros.
The following list describes sources and destinations that use a separate thread even if you disable multithreading in syslog-ng OSE, in addition to the limit set in the --worker-threads command-line option.
Every sql destination uses its own thread. These threads are independent from the setting of the --worker-threads command-line option.
The java destinations use one thread, even if there are multiple Java-based destinations configured. This thread is independent from the setting of the --worker-threads command-line option.