diff --git a/README.md b/README.md index bc33b35..545012b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # A Prometheus & Grafana docker-compose stack Here's a quick start to stand-up a [Prometheus](http://prometheus.io/) stack containing Prometheus, Grafana and Node scraper to monitor your Docker infrastructure. A big shoutout to [philicious](https://github.com/philicious) for kicking this project off! -##Pre-requisites +## Pre-requisites Before we get started installing the Prometheus stack. Ensure you install the latest version of docker and [docker-compose](https://docs.docker.com/compose/install/) on your Docker host machine. This has also been tested with Docker for Mac and it works well. -##Installation & Configuration +## Installation & Configuration Clone the project locally to your Docker host. If you would like to change which targets should be monitored or make configuration changes edit the [/prometheus/prometheus.yml](https://github.com/vegasbrianc/prometheus/blob/version-2/prometheus/prometheus.yml) file. The targets section is where you define what should be monitored by Prometheus. The names defined in this file are actually sourced from the service name in the docker-compose file. If you wish to change names of the services you can add the "container_name" parameter in the `docker-compose.yml` file. @@ -51,7 +51,7 @@ View Alert Manager `http://:9093` ### Test Alerts A quick test for your alerts is to stop a service. Stop the node_exporter container and you should notice shortly the alert arrive in Slack. Also check the alerts in both the Alert Manager and Prometheus Alerts just to understand how they flow through the system. -High load test alert - `docker run --rm -it busybox sh -c "while true; do :; done"`` +High load test alert - `docker run --rm -it busybox sh -c "while true; do :; done"` Let this run for a few minutes and you will notice the load alert appear.