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}.
parser parser_name {
geoip(
<macro-containing-the-IP-address-to-lookup>
prefix()
database("<path-to-database-file>")
);
};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.
| Synopsis: | 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} .
| 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.
The syslog-ng OSE 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 OSE application works with the Country and the City version of the GeoIP2 database, both free and the commercial editions. The syslog-ng OSE 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
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}.
for example, if the default prefix (.geoip2) is used, you can determine the country code using ${.geoip2.country.iso_code}.
To look up all keys:
Install the mmdb-bin package.
After installing this package, you will be able to use the mmdblookup command.
NOTE: The name of the package depends on the Linux distribution. The package mentioned in this example is on Ubuntu.
Create a dump using the following command: mmdblookup --file GeoLite2-City.mmdb --ip <your-IP-address>
The resulting dump file will contain the keys that you can use.
For a more complete list of keys, you can also check the GeoIP2 City and Country CSV Databases. However, note that the syslog-ng OSE application works with the mmdb (GeoIP2) format of these databases. Other formats, like csv are not supported.
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center