gilbn/lsio-docker-mods repository overview

⁠Geoip2Influx

⁠The mod has now been added to the linuxserver/docker-mods repo

https://github.com/linuxserver/docker-mods/tree/swag-geoip2influx⁠

⁠For the standalone container click here: https://github.com/gilbN/geoip2influx⁠

⁠ ⁠ ⁠

A docker mod for the linuxserver/letsencrypt container adding a python script to send geo location metrics to InfluxDB

⁠! Check Update 21.06.20⁠ if nginx logs stopped working.

The mod will parse the access log for IPs and and convert them into geo metrics for InfluxDB. It will also send log metrics if enabled.

Add -e DOCKER_MODS=gilbn/lsio-docker-mods:geoip2-nginx-stats

⁠Enviroment variables:

These are the default values for all envs. Add the ones that differ on your system.

⁠MaxMind Geolite2

Use:

-e MAXMINDDB_LICENSE_KEY=<license-key>

Default download location is /config/geoip2db/GeoLite2-City.mmdb

⁠InfluxDB

⁠InfluxDB v2.x is not supported. Use v1.8x.

The InfluxDB database will be created automatically with the name you choose.

-e INFLUX_DATABASE=geoip2influx 

⁠Grafana dashboard:

⁠Grafana Dashboard Link⁠

⁠Sending Nginx log metrics

1. Add the following to the http block in your nginx.conffile:

geoip2 /config/geoip2db/GeoLite2-City.mmdb {
auto_reload 5m;
$geoip2_data_country_iso_code country iso_code;
$geoip2_data_city_name city names en;
}

log_format custom '$remote_addr - $remote_user [$time_local]'
           '"$request" $status $body_bytes_sent'
           '"$http_referer" $host "$http_user_agent"'
           '"$request_time" "$upstream_connect_time"'
           '"$geoip2_data_city_name" "$geoip2_data_country_iso_code"';

1. Set the access log use the custom log format.

access_log /config/log/nginx/access.log custom;

⁠Multiple log files

If you separate your nginx log files but want this mod to parse all of them you can do the following:

As nginx can have multiple access log directives in a block, just add another one in the server block.

Example

	access_log /config/log/nginx/technicalramblings/access.log custom;
	access_log /config/log/nginx/access.log custom;

This will log the same lines to both files.

Then use the /config/log/nginx/access.log file in the NGINX_LOG_PATH variable.

⁠Updates

21.06.20 - Added $host(domain) to the nginx log metrics. This will break your nginx logs parsing, as you need to update the custom log format.

06.06.20 - Added influx retention policy to try and mitigate max-values-per-tag limit exceeded errors.

• -e INFLUX_RETENTION Default 30d
• -e INFLUX_SHARD Default 2d
• It will only add the retention policy if the database doesn't exist.

30.05.20 - Added logging. Use -e GEOIP2INFLUX_LOG_LEVEL to set the log level.

15.05.20 - Removed GEOIP2_KEY and GEOIP_DB_PATHvariables. With commit https://github.com/linuxserver/docker-letsencrypt/commit/75b9685fdb3ec6edda590300f289b0e75dd9efd0⁠ the letsencrypt container now natively supports downloading and updating(weekly) the GeoLite2-City database!

Adapted source: https://github.com/ratibor78/geostat⁠