Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blind-oracle/nginx-prometheus
Turn Nginx logs into Prometheus metrics
https://github.com/blind-oracle/nginx-prometheus
golang log nginx parser prometheus syslog
Last synced: about 2 months ago
JSON representation
Turn Nginx logs into Prometheus metrics
- Host: GitHub
- URL: https://github.com/blind-oracle/nginx-prometheus
- Owner: blind-oracle
- License: mpl-2.0
- Created: 2018-10-23T09:10:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-16T09:07:15.000Z (about 4 years ago)
- Last Synced: 2024-07-31T20:52:54.517Z (4 months ago)
- Topics: golang, log, nginx, parser, prometheus, syslog
- Language: Go
- Homepage:
- Size: 42 KB
- Stars: 41
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - nginx-prometheus - Nginx log parser and exporter to Prometheus. (Server Applications / HTTP Clients)
- zero-alloc-awesome-go - nginx-prometheus - Nginx log parser and exporter to Prometheus. (Server Applications / HTTP Clients)
- awesome-go-extra - nginx-prometheus - 10-23T09:10:27Z|2020-09-16T09:07:15Z| (Server Applications / HTTP Clients)
README
# Nginx log parser and Prometheus exporter
[](https://goreportcard.com/report/github.com/blind-oracle/nginx-prometheus)
[](https://coveralls.io/github/blind-oracle/nginx-prometheus?branch=master)
[](https://travis-ci.org/blind-oracle/nginx-prometheus)
[](https://github.com/avelino/awesome-go)
This service parses incoming syslog messages from Nginx sent over UDP and converts them into Prometheus metrics exported through the built-in HTTP server.
- If the prefix-list is specified then per-URI statistics are generated.
Using this feature without URI-prefix list is dangerous because it leads to an unbounded memory usage. It's therefore enabled only with a limited prefix list.
The URI prefix list is a plain-text file with a single prefix per line, e.g.
```bash
/api/call1.json
/api/call2.json
/api/call3.json
```
URIs received from nginx are stripped of any query parameters - only the part before '?' is used.
- It optionally supports country lookup for client IPs using MaxMind GeoIP database.
## Nginx configuration snippet
```nginxconf
log_format collector '$remote_addr|$scheme|$host|$request_method|$server_protocol|$request_uri|$status|$request_time|$request_length|$bytes_sent';
access_log syslog:server=1.1.1.1:1514,tag=nginx collector;
```
## Getting it
- Get RPM & DEB directly from [releases](https://github.com/blind-oracle/nginx-prometheus/releases), only linux-amd64 build currently available.
- Build youself:
```bash
go get github.com/blind-oracle/nginx-prometheus
cd $GOPATH/src/github.com/blind-oracle/nginx-prometheus
go build
```
## Usage example
If you're using RPM/DEB packages then options are set in `/etc/default/nginx-prometheus`
```bash
./nginx-prometheus \
-debug false \
-listenSyslog 0.0.0.0:1514 \
-listenHTTP 0.0.0.0:1514 \
-geoipCountryDB /etc/nginx-prometheus/country.mmdb \
-uriPrefixFile /etc/nginx-prometheus/uriPrefixes.txt
```
- **debug** - prints every syslog message received if true (defaults to false)
- **listenSyslog** - ip:port on which to listen for UDP Syslog messages (defaults to 0.0.0.0:1514)
- **listenHTTP** - ip:port on which to listen for incoming HTTP requests from Prometheus (defaults to 0.0.0.0:11080)
- **geoipCountryDB** - path to MaxMind country GeoIP database (optional)
- **uriPrefixFile** - path to a URI prefix list (optional)
## Grafana dashboard
Add Prometheus source to Grafana and import _grafana-dashboard.json_ for most common graphs.