diff --git a/pipeline/inputs/docker-events.md b/pipeline/inputs/docker-events.md index 40d85ec5c..4d6569f9c 100644 --- a/pipeline/inputs/docker-events.md +++ b/pipeline/inputs/docker-events.md @@ -1,33 +1,36 @@ -# Docker Events +# Docker events -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/) +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/). -## Configuration Parameters +## Configuration parameters This plugin supports the following configuration parameters: | Key | Description | Default | | :--- | :--- | :--- | -| Unix\_Path | The docker socket unix path | /var/run/docker.sock | -| Buffer\_Size | The size of the buffer used to read docker events \(in bytes\) | 8192 | -| Parser | Specify the name of a parser to interpret the entry as a structured message. | None | -| Key | When a message is unstructured \(no parser applied\), it's appended as a string under the key name _message_. | message | -| Reconnect.Retry_limits| The maximum number of retries allowed. The plugin tries to reconnect with docker socket when EOF is detected. | 5 | -| Reconnect.Retry_interval| The retrying interval. Unit is second. | 1 | -| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | +| `Unix_Path` | The docker socket Unix path. | `/var/run/docker.sock` | +| `Buffer_Size` | The size of the buffer used to read docker events in bytes. | `8192` | +| `Parser` | Specify the name of a parser to interpret the entry as a structured message. | _none_ | +| `Key` | When a message is unstructured (no parser applied), it's appended as a string under the key name `message`. | `message` | +| `Reconnect.Retry_limits`| The maximum number of retries allowed. The plugin tries to reconnect with docker socket when `EOF` is detected. | `5` | +| `Reconnect.Retry_interval`| The retry interval in seconds. | `1` | +| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | -### Command Line +### Command line + +You can run this plugin from the command line: ```bash -$ fluent-bit -i docker_events -o stdout +fluent-bit -i docker_events -o stdout ``` -### Configuration File +### Configuration file -In your main configuration file append the following **Input** & **Output** sections: +In your main configuration file append the following `Input` and `Output` sections: {% tabs %} {% tab title="fluent-bit.conf" %} + ```yaml [INPUT] Name docker_events @@ -36,9 +39,11 @@ In your main configuration file append the following **Input** & **Output** sect Name stdout Match * ``` + {% endtab %} {% tab title="fluent-bit.yaml" %} + ```yaml pipeline: inputs: @@ -48,5 +53,6 @@ pipeline: - name: stdout match: '*' ``` + {% endtab %} {% endtabs %}