From 61e5d500baeefc32c51e449969584d6581ee4e1e Mon Sep 17 00:00:00 2001 From: Daniel Nelson Date: Mon, 27 Aug 2018 13:05:41 -0700 Subject: [PATCH] Add metric requirements to docker README --- plugins/inputs/docker/README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/plugins/inputs/docker/README.md b/plugins/inputs/docker/README.md index a95fb61e9..b7e64af33 100644 --- a/plugins/inputs/docker/README.md +++ b/plugins/inputs/docker/README.md @@ -77,9 +77,6 @@ may prefer to exclude them: ### Metrics: -Every effort was made to preserve the names based on the JSON response from the -docker API. - - docker - tags: - unit @@ -96,7 +93,10 @@ docker API. - n_goroutines - n_listener_events - memory_total - - pool_blocksize + - pool_blocksize (requires devicemapper storage driver) + +The `docker_data` and `docker_metadata` measurements are available only for +some storage drivers such as devicemapper. - docker_data - tags: @@ -224,7 +224,11 @@ docker API. - io_serviced_recursive_write - container_id -- docker_container_health +The `docker_container_health` measurements report on a containers +[HEALTHCHECK](https://docs.docker.com/engine/reference/builder/#healthcheck) +status if configured. + +- docker_container_health (container must use the HEALTHCHECK) - tags: - engine_host - server_version