Skip to content

Commit 99da2f0

Browse files
authored
General cleanup and standardization of docker events input plugin doc. Fixes #2237. (#2238)
General cleanup and standardization of docker events input plugin doc. Fixes #2237. (#2238) Signed-off-by: Eric D. Schabell <[email protected]>
1 parent 00a6926 commit 99da2f0

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

pipeline/inputs/docker-events.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,36 @@
11
# Docker events
22

3-
The _Docker events_ input plugin uses the Docker API to capture server events. A complete list of possible events returned by this plugin can be found [in the Docker documentation](https://docs.docker.com/engine/reference/commandline/events/).
3+
The _Docker events_ input plugin uses the Docker API to capture server events. A complete list of possible events returned by this plugin can be found [in the Docker documentation](https://docs.docker.com/reference/cli/docker/system/events/).
44

55
## Configuration parameters
66

77
This plugin supports the following configuration parameters:
88

99
| Key | Description | Default |
1010
|:---------------------------|:----------------------------------------------------------------------------------------------------------------|:-----------------------|
11-
| `Unix_Path` | The docker socket Unix path. | `/var/run/docker.sock` |
12-
| `Buffer_Size` | The size of the buffer used to read docker events in bytes. | `8192` |
13-
| `Parser` | Specify the name of a parser to interpret the entry as a structured message. | _none_ |
14-
| `Key` | When a message is unstructured (no parser applied), it's appended as a string under the key name `message`. | `message` |
15-
| `Reconnect.Retry_limits` | The maximum number of retries allowed. The plugin tries to reconnect with docker socket when `EOF` is detected. | `5` |
16-
| `Reconnect.Retry_interval` | The retry interval in seconds. | `1` |
17-
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
11+
| `buffer_size` | The size of the buffer used to read docker events in bytes. | `8192` |
12+
| `key` | When a message is unstructured (no parser applied), it's appended as a string under the key name `message`. | `message` |
13+
| `parser` | Specify the name of a parser to interpret the entry as a structured message. | _none_ |
14+
| `reconnect.retry_interval` | The retry interval in seconds. | `1` |
15+
| `reconnect.retry_limits` | The maximum number of retries allowed. The plugin tries to reconnect with docker socket when `EOF` is detected. | `5` |
16+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
17+
| `unix_path` | The docker socket Unix path. | `/var/run/docker.sock` |
18+
19+
## Get started
20+
21+
To capture Docker events, you can run the plugin from the command line or through the configuration file.
1822

1923
### Command line
2024

21-
You can run this plugin from the command line:
25+
From the command line you can run the plugin with the following options:
2226

2327
```shell
2428
fluent-bit -i docker_events -o stdout
2529
```
2630

2731
### Configuration file
2832

29-
In your main configuration file append the following:
33+
In your main configuration file, append the following:
3034

3135
{% tabs %}
3236
{% tab title="fluent-bit.yaml" %}
@@ -54,4 +58,4 @@ pipeline:
5458
```
5559

5660
{% endtab %}
57-
{% endtabs %}
61+
{% endtabs %}

0 commit comments

Comments
 (0)