Skip to content

Commit f905089

Browse files
committed
Add Grafana Dashboard for NGINX metrics
1 parent a803520 commit f905089

File tree

4 files changed

+580
-0
lines changed

4 files changed

+580
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,9 @@ Note: the binary is built for the OS/arch of your machine. To build binaries for
140140
141141
The binary is built with the name `nginx-prometheus-exporter`.
142142
143+
## Grafana Dashboard
144+
The official Grafana dashboard is provided with the exporter for NGINX. Check the [Grafana Dashboard](./grafana/README.md) documentation for more information.
145+
143146
## Support
144147
145148
The commercial support is available for NGINX Plus customers when the NGINX Prometheus Exporter is used with NGINX Ingress Controller.

grafana/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Grafana Dashboard
2+
We provide the official Grafana dashboard that visualizes the NGINX metrics exposed by the exporter. The dashboard allows you to filter metrics per instance or see the metrics from all instances.
3+
4+
## Prerequisites
5+
6+
The dashboard has been tested with the following software versions:
7+
8+
* NGINX Prometheus Exporter >= 0.4.1
9+
* Grafana >= v5.0.0
10+
* Prometheus >= v2.0.0
11+
12+
A Prometheus data source needs to be [added](https://prometheus.io/docs/visualization/grafana/#using) before installing the dashboard.
13+
14+
## Installing the Dashboard
15+
16+
In the Grafana UI complete the following steps:
17+
18+
1. Use the *New Dashboard* button and click *Import*.
19+
2. Upload `dashboard.json` or copy and paste the contents of the file in the textbox and click *Load*.
20+
3. Set the Prometheus data source and click *Import*.
21+
4. The dashboard will appear. Note how you can filter the instance label just below the dashboard title (top left corner). This allows you to filter metrics per instance. By default, all instances are selected.
22+
23+
![dashboard](./dashboard.png)
24+
25+
## Graphs
26+
27+
The dashboard comes with 2 rows with the following graphs for NGINX metrics:
28+
29+
* Status
30+
* Up/Down graph per instance. It shows the `nginx_up` metric.
31+
* Metrics
32+
* Processed connections (`nginx_connections_accepted` and `nginx_connections_handled` metrics). This graph shows an [irate](https://prometheus.io/docs/prometheus/latest/querying/functions/#irate) in a range of 5 minutes. Useful for seeing the variation of the processed connections in time.
33+
* Active connections (`nginx_connections_active`, `nginx_connections_reading`, `nginx_connections_waiting` and `nginx_connections_writing`). Useful for checking what is happening right now.
34+
* Total Requests with an irate (5 minutes range too) of the total number of client requests (`nginx_http_requests_total`) over time.
35+

0 commit comments

Comments
 (0)