Skip to content

Commit 5fe289f

Browse files
authored
Merge pull request #1714 from fluent/lynettemiles/sc-136170/update-fluent-bit-docs-pipeline-inputs-docker
2 parents b89ed14 + fe51159 commit 5fe289f

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

pipeline/inputs/docker-events.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,36 @@
1-
# Docker Events
1+
# 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 [here](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/engine/reference/commandline/events/).
44

5-
## Configuration Parameters
5+
## 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 retrying interval. Unit is second. | 1 |
17-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
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` |
1818

19-
### Command Line
19+
### Command line
20+
21+
You can run this plugin from the command line:
2022

2123
```bash
22-
$ fluent-bit -i docker_events -o stdout
24+
fluent-bit -i docker_events -o stdout
2325
```
2426

25-
### Configuration File
27+
### Configuration file
2628

27-
In your main configuration file append the following **Input** & **Output** sections:
29+
In your main configuration file append the following `Input` and `Output` sections:
2830

2931
{% tabs %}
3032
{% tab title="fluent-bit.conf" %}
33+
3134
```yaml
3235
[INPUT]
3336
Name docker_events
@@ -36,9 +39,11 @@ In your main configuration file append the following **Input** & **Output** sect
3639
Name stdout
3740
Match *
3841
```
42+
3943
{% endtab %}
4044

4145
{% tab title="fluent-bit.yaml" %}
46+
4247
```yaml
4348
pipeline:
4449
inputs:
@@ -48,5 +53,6 @@ pipeline:
4853
- name: stdout
4954
match: '*'
5055
```
56+
5157
{% endtab %}
5258
{% endtabs %}

0 commit comments

Comments
 (0)