diff --git a/README.md b/README.md index dd6b3fc..1d30f9a 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Given a Docker installation with default configuration (listening on Unix pipe): 1. Start the exporter by executing `docker run --name docker_exporter --detach --restart always --volume "/var/run/docker.sock":"/var/run/docker.sock" --publish 9417:9417 prometheusnet/docker_exporter` 1. Navigate to http://hostname:9417/metrics to explore the available metrics. 1. Register `hostname:9417` in your Prometheus configuration as a scrape target. +1. If using Grafana, [install the template dashboard](https://grafana.com/grafana/dashboards/11467) Example Prometheus scrape configuration: @@ -64,4 +65,4 @@ You can append the `--verbose` parameter to the end of the `docker run` command Docker can occasionally be very slow or even hang due to ongoing Docker operations blocking the information-gathering by this app. The app will try its best to work around such slowness: 1. If probing Docker takes too long (more than 20 seconds), the probe is continued in the background and stale data is returned to Prometheus. You can observe the `docker_probe_successfully_completed_time` metric to identify whether you are seeing stale data. -1. If probing Docker in the background still takes too long (more than a few minutes), the probe is aborted and the next scrape will try again from the beginning. \ No newline at end of file +1. If probing Docker in the background still takes too long (more than a few minutes), the probe is aborted and the next scrape will try again from the beginning.