|
1 | 1 | # Docker events |
2 | 2 |
|
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/). |
4 | 4 |
|
5 | 5 | ## Configuration parameters |
6 | 6 |
|
7 | 7 | This plugin supports the following configuration parameters: |
8 | 8 |
|
9 | 9 | | Key | Description | Default | |
10 | 10 | |:---------------------------|:----------------------------------------------------------------------------------------------------------------|:-----------------------| |
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. |
18 | 22 |
|
19 | 23 | ### Command line |
20 | 24 |
|
21 | | -You can run this plugin from the command line: |
| 25 | +From the command line you can run the plugin with the following options: |
22 | 26 |
|
23 | 27 | ```shell |
24 | 28 | fluent-bit -i docker_events -o stdout |
25 | 29 | ``` |
26 | 30 |
|
27 | 31 | ### Configuration file |
28 | 32 |
|
29 | | -In your main configuration file append the following: |
| 33 | +In your main configuration file, append the following: |
30 | 34 |
|
31 | 35 | {% tabs %} |
32 | 36 | {% tab title="fluent-bit.yaml" %} |
@@ -54,4 +58,4 @@ pipeline: |
54 | 58 | ``` |
55 | 59 |
|
56 | 60 | {% endtab %} |
57 | | -{% endtabs %} |
| 61 | +{% endtabs %} |
0 commit comments