diff --git a/examples/grafana-metrics/README.md b/examples/grafana-metrics/README.md index b7612a380..66766d1eb 100644 --- a/examples/grafana-metrics/README.md +++ b/examples/grafana-metrics/README.md @@ -1,11 +1,14 @@ # Grafana Metrics Example -This example demonstrates how the NGINX agent can be used to report metrics using prometheus and grafana servers. +This README will give instructions on how to run the demonstration on how the NGINX agent can be used to report metrics using prometheus and grafana servers. -## Run Example +
+## Run Example +Run the following command to start up the agent grafana metrics example. This will create all the servies listed in [List of Services](#list-of-services). ``` make clean build run ``` +
## List of Services The services run by this example are listed below @@ -16,6 +19,30 @@ The services run by this example are listed below | Grafana | 8081 | | Prometheus | 9090 | -## Example of Grafana Dashboard +
+ +## Accessing Grafana Dashboard + +Grafana Dashboard can be accessed locally via the url http://localhost:3000 with the "admin" as both username and password. +On the home screen, select the NGINX Agent dashboard. ![Dashboard](grafana-dashboard-example.png) + +
+ +## Generate traffic for Dashboard + +To generate data for the dashboard you can curl the NGINX instance. This will increase nginx_http_status_2xx on +``` +ab -k -c 10 -n 10000 127.0.0.1:8080/ +``` +If you monitor the dashboard you'll see the graphs being populated. + +
+ +## Teardown Example + +Run the following command in the grafana directory to shut down example services. +``` +make clean +``` \ No newline at end of file