Starting with in syslog-ng OSE3.24 and later, you can use shell-style globbing ('*' and '?' wildcards) in the selector.
To use globs in a selector
-
Use the glob() option within the selector() option in your syslog-ng OSE configuration file, for example:
parser p_add_context_data {
add-contextual-data(
selector(glob("${HOST}"))
database("context-info-db.csv")
);
};
-
Use globs and wildcards in the selector column of your CSV-file, for example:
example-glob-entry1*,sourcetype,:hec:user
example-glob-entry2*,sourcetype,:hec:user
postfix*,sourcetype,:hec:mta
Note the following points when using globbing in the selector:
-
The order of the patterns depends on the CSV-file. The order of entries in the database determines the matching order.
-
The globs are matched against the expanded template string sequentially.
-
Put more specific patterns to the top of the CSV-file. The syslog-ng OSE appication does not evaluate other entries after the first match.
-
In debug mode, syslog-ng OSE sends log messages to its internal() destination to help troubleshooting. For example:
[2019-09-21T06:01:10.748237] add-contextual-data(): Evaluating glob against message; glob-template='$PROGRAM', string='postfix/smtpd', pattern='example-glob-entry1*', matched='0'
[2019-09-21T06:01:10.748562] add-contextual-data(): Evaluating glob against message; glob-template='$PROGRAM', string='postfix/smtpd', pattern='example-glob-entry2*', matched='0'
[2019-09-21T06:01:10.748697] add-contextual-data(): Evaluating glob against message; glob-template='$PROGRAM', string='postfix/smtpd', pattern='postfix*', matched='1'
[2019-09-21T06:01:10.750084] add-contextual-data(): message lookup finished; message='almafa', resolved_selector='postfix*', selector='postfix*', msg='0x8e15320'
The add-contextual-data() has the following options.
Required options:
The following options are required: selector(), database().
database()
| Type: |
<path-to-file>.csv |
| Default: |
|
Description: Specifies the path to the CSV file, for example, /opt/syslog-ng/my-csv-database.csv. The extension of the file must be .csv, and can include Windows-style (CRLF) or UNIX-style (LF) linebreaks. You can use absolute path, or relative to the syslog-ng OSE binary.
default-selector()
| Synopsis: |
default-selector() |
Description: Specifies the ID of the entry (line) that is corresponds to log messages that do not have a selector that matches an entry in the database. For example, if you add name-value pairs from the database based on the hostname from the log message (selector("${HOST}")), then you can include a line for unknown hosts in the database, and set default-selector() to the ID of the line for unknown hosts. In the CSV file:
unknown-hostname,host-role,unknown
In the syslog-ng OSE configuration file:
add-contextual-data(
selector("$HOST")
database("context-info-db.csv")
default-selector("unknown-hostname")
);
ignore-case()
| Synopsis: |
ignore-case() |
|
Default: |
ignore-case(no) |
Description: Specifies if selectors are handled as case insensitive. If you set the ignore-case() option to yes, selectors are handled as case insensitive.
prefix()
Description: Insert a prefix before the name part of the added name-value pairs (including the pairs added by the default-selector()) to help further processing.
selector()
Description: Specifies the string or macro that syslog-ng OSE evaluates for each message, and if its value matches the ID of an entry in the database, syslog-ng OSE adds the name-value pair of every matching database entry to the log message. You can use the following in the selector() option.
This parser is deprecated. Use Looking up GeoIP2 data from IP addresses instead.
The syslog-ng OSE application can lookup IPv4 addresses from an offline GeoIP database, and make the retrieved data available in name-value pairs. IPv6 addresses are not supported. Depending on the database used, you can access country code, longitude, and latitude information.
NOTE: To access longitude and latitude information, download the GeoLiteCity database, and unzip it (for example, to the /usr/share/GeoIP/GeoLiteCity.dat file). The default databases available on Linux and other platforms usually contain only the country codes.
You can refer to the separated parts of the message using the key of the value as a macro. For example, if the message contains KEY1=value1,KEY2=value2, you can refer to the values as ${KEY1} and ${KEY2}.
Declaration:
parser parser_name {
geoip(
<macro-containing-the-IP-address-to-lookup>
prefix()
database("<path-to-database-file>")
);
};
Example: Using the GeoIP parser
In the following example, syslog-ng OSE retrieves the GeoIP data of the IP address contained in the ${HOST} field of the incoming message, and includes the data (prefixed with the geoip. string) in the output JSON message.
@version: 3.7
options {
keep-hostname(yes);
};
source s_file {
file("/tmp/input");
};
parser p_geoip { geoip( "${HOST}", prefix( "geoip." ) database( "/usr/share/GeoIP/GeoLiteCity.dat" ) ); };
destination d_file {
file( "/tmp/output" template("$(format-json --scope core --key geoip*)\n") );
};
log {
source(s_file);
parser(p_geoip);
destination(d_file);
};
For example, for the <38>Jan 1 14:45:22 192.168.1.1 prg00000[1234]: test message message the output will look like:
{"geoip":{"longitude":"47.460704","latitude":"19.049968","country_code":"HU"},"PROGRAM":"prg00000","PRIORITY":"info","PID":"1234","MESSAGE":"test message","HOST":"192.168.1.1","FACILITY":"auth","DATE":"Jan 1 14:45:22"}
If you are transferring your log messages into Elasticsearch, use the following rewrite rule to combine the longitude and latitude information into a single value (called geoip.location), and set the mapping in Elasticsearch accordingly. Do not forget to include the rewrite in your log path. For details on transferring your log messages to Elasticsearch, see elasticsearch2: Sending messages directly to Elasticsearch version 2.0 or higher (DEPRECATED).
rewrite r_geoip {
set(
"${geoip.latitude},${geoip.longitude}",
value( "geoip.location" ),
condition(not "${geoip.latitude}" == "")
);
};
In your Elasticsearch configuration, set the appropriate mappings:
{
"mappings" : {
"_default_" : {
"properties" : {
"geoip" : {
"properties" : {
"country_code" : {
"index" : "not_analyzed",
"type" : "string",
"doc_values" : true
},
"latitude" : {
"index" : "not_analyzed",
"type" : "string",
"doc_values" : true
},
"longitude" : {
"type" : "string",
"doc_values" : true,
"index" : "not_analyzed"
},
"location" : {
"type" : "geo_point"
}
}
}
}
}
}
}
The geoip 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 OSE. 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 geoip. prefix, use the prefix(.geoip.) option. To refer to a particular data when using a prefix, use the prefix in the name of the macro, for example, ${geoip.country_code} .
database()
| Synopsis: |
database() |
| Default: |
/usr/share/GeoIP/GeoIP.dat |
Description: The full path to the GeoIP database to use. Note that syslog-ng OSE must have the required privileges to read this file. Do not modify or delete this file while syslog-ng OSE is running, it can crash syslog-ng OSE.
