The syslog-ng PE application can lookup IP addresses from an offline GeoIP2 database, and make the retrieved data available in name-value pairs. Depending on the database used, you can access country code, longitude, and latitude information and so on.
The syslog-ng PE application works with the Country and the City version of the GeoIP2 database, both free and the commercial editions. The syslog-ng PE application works with the mmdb (GeoIP2) format of these databases. Other formats, like csv are not supported.
NOTE: To access longitude and latitude information, download the City version of the GeoIP2 database.
There are two types of GeoIP2 databases available.
-
GeoLite2 City:
-
free of charge
-
less accurate
-
GeoIP2 City:
-
has to be purchased
-
more accurate
Unzip the downloaded database (for example, to the /usr/share/GeoIP2/GeoIP2City.mmdb file). This path will be used later in the configuration.
Starting with version 7.0.17, syslog-ng PE tries to automatically detect the location of the database. If that is successful, the database() option is not mandatory.
The geoip2 parser has the following options.
prefix()
Description: Insert a prefix before the name part of the parsed name-value pairs to help further processing. For example:
-
To insert the my-parsed-data. prefix, use the prefix(my-parsed-data.) option.
-
To refer to a particular data that has a prefix, use the prefix in the name of the macro, for example, ${my-parsed-data.name} .
-
If you forward the parsed messages using the IETF-syslog protocol, you can insert all the parsed data into the SDATA part of the message using the prefix(.SDATA.my-parsed-data.) option.
Names starting with a dot (for example,
.example) are reserved for use by syslog-ng PE. If you use such a macro name as the name of a parsed value, it will attempt to replace the original value of the macro (note that only soft macros can be overwritten, see
Hard versus soft macros for details). To avoid such problems, use a prefix when naming the parsed values, for example,
prefix(my-parsed-data.)
For example, to insert the .geoip2 prefix, use the prefix(.geoip2) option. To refer to a particular data when using a prefix, use the prefix in the name of the macro, for example, ${geoip2.country_code}.
database()
| Synopsis: |
database() |
| Default: |
|
Description: Path to the GeoIP2 database to use. This works with absolute and relative paths as well. Note that syslog-ng PE must have the required privileges to read this file. Do not modify or delete this file while syslog-ng PE is running, it can crash syslog-ng PE.
Starting with version 7.0.17, syslog-ng PE tries to automatically detect the location of the database. If that is successful, the database() option is not mandatory.
Monitoring statistics and metrics of syslog-ng
The syslog-ng PE application collects various statistics and measures different metrics about the messages it receives and delivers. These metrics are collected into different counters, depending on the configuration of syslog-ng PE. The stats-level() global option determines exactly which statistics syslog-ng PE collects. You can access these statistics and metrics using the following methods.
Recommended: Structured, selective methods:
Legacy: Unstructured, bulk methods:
-
Using the internal() source.
-
Using the syslog-ng-ctl stats command.
For further information about using syslog-ng-ctl commands, see The syslog-ng control tool manual page.
-
Use the socat application: echo STATS | socat -vv UNIX-CONNECT:/opt/syslog-ng/var/run/syslog-ng.ctl -
-
If you have an OpenBSD-style netcat application installed, use the echo STATS | nc -U /opt/syslog-ng/var/run/syslog-ng.ctl command. Note that the netcat included in most Linux distributions is a GNU-style version that is not suitable to query the statistics of syslog-ng.
You can list all active metrics on your syslog-ng PE 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)
-
program: program, from stats-level(3)
-
sender: sender host, from stats-level(3)
Example: Dynamic counters
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 PE, 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.)
NOTE: The syslog-ng PE application stores the statistics of the objects when syslog-ng PE is reloaded. However, if the configuration of syslog-ng PE was changed since the last reload, the statistics of orphaned objects are deleted.
-
The connections statistics counter displays the number of connections tracked by syslog-ng PE for the selected source driver.
Example: sample configuration and statistics output
The following configuration will display the following syslog-ng-ctl statistics output:
Configuration:
source s_network {
tcp(
port(8001)
);
};
Statistics output:
src.tcp;s_network#0;tcp,127.0.0.5;a;processed;1
src.tcp;s_network#0;tcp,127.0.0.1;a;processed;3
src.tcp;s_network;afsocket_sd.(stream,AF_INET(0.0.0.0:8001));a;connections;2
-
The type of the statistics:
-
batch_size_avg: When batching is enabled, then this shows the current average batch size of the given source or destination.
NOTE: In version 7.0.27, syslog-ng PE only supports the batch_size_avg for the http() destination.
-
batch_size_max: When batching is enabled, the value of batch_size_max shows the current largest batch size of the given source or destination.
NOTE: In version 7.0.27, syslog-ng PE only supports the batch_size_max for the http() 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:
parser;demo_parser;;a;discarded;20
-
dropped: The number of dropped messages — syslog-ng PE 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 PE dropped the message for some other reason (for example, a parsing error).
-
eps_last_1h: The EPS value of the past 1 hour.
-
eps_last_24h: The EPS value of the past 24 hours.
-
eps_since_start: The EPS value since the current syslog-ng PE start.
NOTE: When using the eps_last_1h, the eps_last_24h, and the eps_since_start statistics, consider the following:
-
EPS stands for "event per second", and in our case, a message received or sent counts as a single event.
-
The eps_last_1h, the eps_last_24h, and the eps_since_start values are only approximate values.
-
The eps_last_1h, the eps_last_24h, and the eps_since_start values are automatically updated every 60 seconds.
-
license_host_usage: The number of consumed licensed hosts since the latest syslog-ng startup or the latest periodic license reset (provided that reset-license-counter() option is turned on). This statistics counter is only registered if we have a valid limited license. For example:
global;license_host_usage;;a;processed;56
-
license_monthly_consumed_hosts: The number of consumed licensed hosts since the latest monthly license report. This statistics counter is only registered if we have a valid and limited license, moreover the option report-host-usage() is turned on. For example:
global;license_monthly_consumed_hosts;;a;processed;28
-
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.
filter;demo_filter;;a;matched;28
-
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:
dst.network;d_net#0;tcp,127.0.0.1:9999;a;memory_usage;0
NOTE: The memory usage (size) of queues is not equal to the memory usage (size) of the log messages in syslog-ng PE. 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.
-
msg_size_max: The current largest message size of the given source or destination.
-
msg_size_avg: The current average message size of the given source or destination.
NOTE: When using the msg_size_avg and msg_size_max statistics, consider that message sizes are calculated as follows:
-
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: 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.
filter;demo_filter;;a;not_matched;0
-
processed: The number of messages that successfully reached their destination driver.
NOTE: Consider that a message that has successfully reached its destination driver does not necessarily mean that the destination driver successfully delivered the messages as well. For example, a message can be written to disk or sent to a remote server after reaching the destination driver.
-
queued: The number of messages passed to the message queue of the destination driver, waiting to be sent to the destination.
-
stamp: The UNIX timestamp of the last message sent to the destination.
-
suppressed: The number of suppressed messages (if the suppress() feature is enabled).
-
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 PE 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 PE 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.
NOTE: Consider that for syslog-ng PE version 7.0.27, the following statistics counters are only supported for the http() destination, or the http() destination and all network() sources and destinations, and all file() sources and destinations, respectively:
-
msg_size_max
-
msg_size_avg
-
batch_size_max
-
batch_size_avg
-
eps_last_1h
-
eps_last_24h
-
eps_since_start
-
The number of such messages.
Availability of statistics
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.
Aggregated statistics
Aggregated statistics are available for different sources and destinations from different levels and upwards:
|
network() source and destination |
from level 1 |
from level 1 |
counter N/A |
counter N/A |
from level 1 |
from level 1 |
from level 1 |
|
file() source and destination |
from level 1 |
from level 1 |
counter N/A |
counter N/A |
from level 1 |
from level 1 |
from level 1 |
|
http() destination |
from level 0
|
from level 0 |
from level 0 |
from level 0 |
from level 0 |
from level 0 |
from level 0 |
