Skip to content

Commit 0627211

Browse files
committed
Added two new config parameters and general updates to docker metrics input plugin doc. Fixes #2241.
Signed-off-by: Eric D. Schabell <[email protected]>
1 parent ff74433 commit 0627211

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

pipeline/inputs/docker-metrics.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
# Docker metrics
22

3-
The _Docker_ input plugin you collect Docker container metrics, including memory usage and CPU consumption.
3+
The _Docker_ input plugin lets you collect Docker container metrics, including memory usage and CPU consumption.
44

55
## Configuration parameters
66

77
The plugin supports the following configuration parameters:
88

99
| Key | Description | Default |
10-
|-------------------|---------------------------------------------------------------------------------------------------------|------------------------------|
11-
| `Interval_Sec` | Polling interval in seconds | `1` |
12-
| `Include` | A space-separated list of containers to include. | _none_ |
13-
| `Exclude` | A space-separated list of containers to exclude. | _none_ |
14-
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
15-
| `path.containers` | Used to specify the container directory if Docker is configured with a custom `data-root` directory. | `/var/lib/docker/containers` |
16-
17-
If you set neither `Include` nor `Exclude`, the plugin will try to get metrics from all running containers.
10+
|:------------------|:--------------------------------------------------------------------------------------------------------|:-----------------------------|
11+
| `exclude` | A space-separated list of containers to exclude. | _none_ |
12+
| `include` | A space-separated list of containers to include. | _none_ |
13+
| `interval_nsec` | Polling interval in nanoseconds. | `0` |
14+
| `interval_sec` | Polling interval in seconds. | `1` |
15+
| `path.containers` | Container directory path, for custom Docker `data-root` configurations. | `/var/lib/docker/containers` |
16+
| `path.sysfs` | Sysfs cgroup mount point. | `/sys/fs/cgroup` |
17+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
18+
19+
If you set neither `include` nor `exclude`, the plugin will try to get metrics from all running containers.
1820

1921
## Configuration file
2022

0 commit comments

Comments
 (0)