Skip to content
This repository was archived by the owner on Mar 14, 2024. It is now read-only.

Commit 977f851

Browse files
authored
added new example grafana dashboard (#15)
* added new example grafana dashboard * added new example grafana dashboard, fixed typos
1 parent cacfd90 commit 977f851

File tree

2 files changed

+612
-33
lines changed

2 files changed

+612
-33
lines changed

examples/grafana/README.md

Lines changed: 20 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,44 @@
11
# Grafana Dashboard
22

3-
The `NGINX Mesh Top` Grafana dashboard provides a high-level picture
4-
of the request volume and success rate of all your applications in the mesh.
5-
NGINX Service Mesh deploys Grafana and adds `NGINX Mesh Top` as the
6-
default dashboard. If you prefer to use an existing Grafana deployment, you can import
7-
the `NGINX Mesh Top` dashboard included in this directory.
3+
Two Grafana dashboards have been included as examples for use in your environment:
4+
- NGINX Mesh Top
5+
- NGINX Service Mesh Summary
6+
7+
Both Grafana dashboards provide a high-level picture of the request volume and success rate of all your applications in the mesh, and each have been included to provide two different references for consuming and rendering NGINX Service Mesh metrics data.
8+
9+
NGINX Service Mesh deploys Grafana and adds `NGINX Mesh Top` as the default dashboard. If you prefer to use an existing Grafana deployment, you can import either or both example dashboards included in this directory.
810

911
## Prerequisties
1012
- Grafana version >= 5.2.0
11-
- Prometheus datasource must be
12-
[configured](https://prometheus.io/docs/visualization/grafana/#creating-a-prometheus-data-source).
13+
- Prometheus datasource must be [configured](https://prometheus.io/docs/visualization/grafana/#creating-a-prometheus-data-source).
1314

14-
**Note:** If you are using the Prometheus server deployed by NGINX Service Mesh you can
15-
find the address by running [`nginx-meshctl
16-
config`](https://docs.nginx.com/nginx-service-mesh/reference/nginx-meshctl/#usage).
17-
If you are using your own Prometheus server, make sure to add the NGINX
18-
Service Mesh [scrape config](../prometheus/README.md) to your
19-
Prometheus configuration.
20-
15+
**Note:** If you are using the Prometheus server deployed by NGINX Service Mesh you can find the address by running [`nginx-meshctl config`](https://docs.nginx.com/nginx-service-mesh/reference/nginx-meshctl/#usage).
16+
If you are using your own Prometheus server, make sure to add the NGINX Service Mesh [scrape config](../prometheus/README.md) to your Prometheus configuration.
2117

22-
## Installing the NGINX Mesh Top Dashboard
18+
## Installing Example Dashboards
2319

24-
To install the NGINX Mesh Top Dashboard using the Grafana UI follow these steps:
20+
To install an example dashboard using the Grafana UI follow these steps:
2521
- Select the New Dashboard button and click Import.
26-
- Upload the [nginx-mesh-top.json](nginx-mesh-top.json) file or copy and paste the contents of the file in the textbox and click Load.
27-
- Select the Prometheus data source you configured previously from the dropdown
28-
menu and click Import.
22+
- Upload the dashboard JSON, ex: [nginx-mesh-top.json](nginx-mesh-top.json), file or copy and paste the contents of the file in the textbox and click Load.
23+
- Select the Prometheus data source you configured previously from the dropdown menu and click Import.
2924

3025
![nginx-mesh-top](dashboard.png)
3126

3227

3328
### Features
34-
NGINX Mesh Top dashboard includes the following stats and graphs:
29+
The default NGINX Mesh Top dashboard includes the following stats and graphs:
3530

3631
- Stats:
37-
- Global Success Rate: the percentage of requests that are successful over
38-
the last 30 seconds (`nginxplus_upstream_server_responses` with response codes of `1xx` or `2xx`).
39-
- Global Request Volume: the volume of requests over the last 30 seconds,
40-
measured in requests per second (`nginxplus_http_total_requests`) .
32+
- Global Success Rate: the percentage of requests that are successful over the last 30 seconds (`nginxplus_upstream_server_responses` with response codes of `1xx` or `2xx`).
33+
- Global Request Volume: the volume of requests over the last 30 seconds, measured in requests per second (`nginxplus_http_total_requests`) .
4134
- Pods Monitored: The number of pods being scraped by Prometheus.
4235
- Graphs:
43-
- Request Volume: this graph shows the volume of requests per Pod, in
44-
requests per second (`nginxplus_http_total_requests`).
45-
- Pod Success: this graph shows the percentage of requests that are
46-
successful per Pod (`nginxplus_upstream_server_responses` with response codes of
47-
`1xx` or `2xx`).
36+
- Request Volume: this graph shows the volume of requests per Pod, in requests per second (`nginxplus_http_total_requests`).
37+
- Pod Success: this graph shows the percentage of requests that are successful per Pod (`nginxplus_upstream_server_responses` with response codes of `1xx` or `2xx`).
4838
- Sidecar Memory Usage (RSS): this graph shows the Resident Set Size (RSS) of the NSM sidecars.
4939
- Sidecar Memory Usage (Private): this graph shows the Private memory used by the NSM sidecars.
5040

5141

5242
## Customizing your own Dashboard
5343

54-
NGINX Service Mesh exposes NGINX Plus metrics in Prometheus format that can be used to
55-
create your own panels and custom dashboards. For a list of available metrics, labels,
56-
and example Prometheus queries, see the [Traffic Metrics
57-
guide](https://docs.nginx.com/nginx-service-mesh/guides/traffic-metrics/).
44+
NGINX Service Mesh exposes NGINX Plus metrics in Prometheus format that can be used to create your own panels and custom dashboards. For a list of available metrics, labels, and example Prometheus queries, see the [Traffic Metrics guide](https://docs.nginx.com/nginx-service-mesh/guides/traffic-metrics/).

0 commit comments

Comments
 (0)