Skip to content

Added two new config parameters and general updates to docker metrics input plugin doc. Fixes #2241. #2242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 28, 2025
Merged

Added two new config parameters and general updates to docker metrics input plugin doc. Fixes #2241. #2242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff74433
Added two new items to spelling exceptions list in vale rules. For #2…
eschabell Nov 28, 2025
0627211
Added two new config parameters and general updates to docker metrics…
eschabell Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions pipeline/inputs/docker-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# Docker metrics

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

## Configuration parameters

The plugin supports the following configuration parameters:

| Key | Description | Default |
|-------------------|---------------------------------------------------------------------------------------------------------|------------------------------|
| `Interval_Sec` | Polling interval in seconds | `1` |
| `Include` | A space-separated list of containers to include. | _none_ |
| `Exclude` | A space-separated list of containers to exclude. | _none_ |
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
| `path.containers` | Used to specify the container directory if Docker is configured with a custom `data-root` directory. | `/var/lib/docker/containers` |

If you set neither `Include` nor `Exclude`, the plugin will try to get metrics from all running containers.
|:------------------|:--------------------------------------------------------------------------------------------------------|:-----------------------------|
| `exclude` | A space-separated list of containers to exclude. | _none_ |
| `include` | A space-separated list of containers to include. | _none_ |
| `interval_nsec` | Polling interval in nanoseconds. | `0` |
| `interval_sec` | Polling interval in seconds. | `1` |
| `path.containers` | Container directory path, for custom Docker `data-root` configurations. | `/var/lib/docker/containers` |
| `path.sysfs` | Sysfs cgroup mount point. | `/sys/fs/cgroup` |
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

If you set neither `include` nor `exclude`, the plugin will try to get metrics from all running containers.

## Configuration file

Expand Down
2 changes: 2 additions & 0 deletions vale-styles/FluentBit/Spelling-exceptions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Buildkite
Buildroot
cAdvisor
Calyptia
cgroup
Chronosphere
chronotf
clickstreams
Expand Down Expand Up @@ -220,6 +221,7 @@ sysinfo
syslog
systemctl
systemd
Sysfs
Tanzu
Telegraf
templated
Expand Down