Skip to content

General cleanup and standardization of docker events input plugin doc. Fixes #2237. #2238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 28, 2025
Merged

General cleanup and standardization of docker events input plugin doc. Fixes #2237. #2238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions pipeline/inputs/docker-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,36 @@
# 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 [in the Docker documentation](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/reference/cli/docker/system/events/).

## 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 retry interval in seconds. | `1` |
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
| `buffer_size` | The size of the buffer used to read docker events in bytes. | `8192` |
| `key` | When a message is unstructured (no parser applied), it's appended as a string under the key name `message`. | `message` |
| `parser` | Specify the name of a parser to interpret the entry as a structured message. | _none_ |
| `reconnect.retry_interval` | The retry interval in seconds. | `1` |
| `reconnect.retry_limits` | The maximum number of retries allowed. The plugin tries to reconnect with docker socket when `EOF` is detected. | `5` |
| `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` |

## Get started

To capture Docker events, you can run the plugin from the command line or through the configuration file.

### Command line

You can run this plugin from the command line:
From the command line you can run the plugin with the following options:

```shell
fluent-bit -i docker_events -o stdout
```

### Configuration file

In your main configuration file append the following:
In your main configuration file, append the following:

{% tabs %}
{% tab title="fluent-bit.yaml" %}
Expand Down Expand Up @@ -54,4 +58,4 @@ pipeline:
```

{% endtab %}
{% endtabs %}
{% endtabs %}