Skip to content

Commit b89ed14

Browse files
authored
Merge pull request #1715 from fluent/lynettemiles/sc-136171/update-fluent-bit-docs-pipeline-inputs-docker
2 parents 19fe493 + 824429d commit b89ed14

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

pipeline/inputs/docker-metrics.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,28 @@
1-
---
2-
description: >-
3-
The docker input plugin allows you to collect Docker container metrics such as
4-
memory usage and CPU consumption.
5-
---
6-
71
# Docker Metrics
82

9-
## Configuration Parameters
3+
The _Docker_ input plugin you collect Docker container metrics, including memory usage and CPU consumption.
4+
5+
## Configuration parameters
106

117
The plugin supports the following configuration parameters:
128

139
| Key | Description | Default |
1410
| ------------ | ----------------------------------------------- | ------- |
15-
| Interval_Sec | Polling interval in seconds | 1 |
16-
| Include | A space-separated list of containers to include | |
17-
| Exclude | A space-separated list of containers to exclude | |
18-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
19-
| path.containers | Used to specify the container directory if Docker is configured with a custom "data-root" directory. | `/var/lib/docker/containers` |
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` |
2016

21-
If you set neither `Include` nor `Exclude`, the plugin will try to get metrics from _all_ the running containers.
17+
If you set neither `Include` nor `Exclude`, the plugin will try to get metrics from all running containers.
2218

23-
## Configuration File
19+
## Configuration file
2420

25-
Here is an example configuration that collects metrics from two docker instances (`6bab19c3a0f9` and `14159be4ca2c`).
21+
The following example configuration collects metrics from two docker instances (`6bab19c3a0f9` and `14159be4ca2c`).
2622

2723
{% tabs %}
2824
{% tab title="fluent-bit.conf" %}
25+
2926
```python
3027
[INPUT]
3128
Name docker
@@ -34,9 +31,11 @@ Here is an example configuration that collects metrics from two docker instances
3431
Name stdout
3532
Match *
3633
```
34+
3735
{% endtab %}
3836

3937
{% tab title="fluent-bit.yaml" %}
38+
4039
```yaml
4140
pipeline:
4241
inputs:
@@ -47,11 +46,12 @@ pipeline:
4746
- name: stdout
4847
match: '*'
4948
```
49+
5050
{% endtab %}
5151
{% endtabs %}
5252
53-
This configuration will produce records like below.
53+
This configuration will produce records like the following:
5454
55-
```
55+
```text
5656
[1] docker.0: [1571994772.00555745, {"id"=>"6bab19c3a0f9", "name"=>"postgresql", "cpu_used"=>172102435, "mem_used"=>5693400, "mem_limit"=>4294963200}]
5757
```

0 commit comments

Comments
 (0)