Add dashboard link to readme

This commit is contained in:
Sander Saares 2020-01-22 11:23:45 +02:00 committed by GitHub
parent ed4b1ca1be
commit a6785a38e5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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. 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. Navigate to http://hostname:9417/metrics to explore the available metrics.
1. Register `hostname:9417` in your Prometheus configuration as a scrape target. 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: 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: 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 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. 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.