A modern, flexible and privacy-focused analytics solution for NGINX.
Deploy a single Next.js dashboard to the same server as NGINX.
Follow the dashboard deployment guide.
Deploy the lightweight agent to your server to securely expose your log files to the dashboard, and stream log file content and changes in real-time. Deploy the Next.js dashboard anywhere.
Best if server resources are tight, or log files are large.
Follow the agent deployment guide.
Update your existing NGINX configuration to serve your log files as restricted static files. Deploy the Next.js dashboard anywhere.
Limited functionality; best if you want to avoid further deployments to your server.
Follow the NGINX configuration guide.
Drag-and-drop your access.log and error.log directly into the dashboard. Get started straight away on our deployment.
IP-location inference can be set up easily, utilising MaxMind's free GeoLite2 database. Simply drop the GeoLite2-City.mmdb or GeoLite2-Country.mmdb file in the root folder of the agent or dashboard deployment on your server.
Monitoring of system resources (CPU, memory, and storage) is supported but disabled by default. Enable it by setting NGINX_ANALYTICS_SYSTEM_MONITORING=true in the environment variables of the agent or dashboard deployment on your server.
When using the agent, it's recommended to use an authentication token. Set the private environment variable NGINX_ANALYTICS_AUTH_TOKEN to the same value for both the agent (server) and the dashboard (client) deployment.
The agent will verify that the auth token sent by the client matches the locally stored value before allowing access to the logs.
If your dashboard is publically accessible, set up password protection by assigning a value to the NGINX_ANALYTICS_PASSWORD environment variable for the dashboard deployment.
Deploying with HTTPS is always recommended. Without this, you risk exposing any personal information within your log files such as IP addresses.
Only the default NGINX log format is supported currently, but future plans include support for custom formats.
To better configure NGINX to get the most out of your analytics, take a look at the NGINX configuration guide.
Contributions, issues and feature requests are welcome.
- Fork it (https://github.com/tom-draper/nginx-analytics)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Disclaimer
This project is not affiliated with, sponsored by, or endorsed by F5, Inc. or the official NGINX project. NGINX is a registered trademark of F5, Inc. This is an independent project created by Tom Draper.
If you find value in my work, consider supporting me.
Buy Me a Coffee: https://www.buymeacoffee.com/tomdraper
PayPal: https://www.paypal.com/paypalme/tomdraper