Skip to content

pipeline: inputs: mqtt: update mqtt input config with buffer_size defaults and payload_key examples #2283

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
eschabell merged 2 commits into from
Dec 5, 2025
Merged

pipeline: inputs: mqtt: update mqtt input config with buffer_size defaults and payload_key examples #2283

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9714a04
pipeline: inputs: mqtt: update mqtt input config with buffer_size def…
eschabell Dec 5, 2025
b2831c2
pipeline: inputs: mqtt: updated description of payload_key as per rev…
eschabell Dec 5, 2025
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
24 changes: 18 additions & 6 deletions pipeline/inputs/mqtt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,22 @@ The _MQTT_ input plugin retrieves messages and data from MQTT control packets ov

The plugin supports the following configuration parameters:

| Key | Description | Default |
|:--------------|:--------------------------------------------------------------------------------------------------------|:----------|
| `Listen` | Listener network interface. | `0.0.0.0` |
| `Port` | TCP port where listening for connections. | `1883` |
| `Payload_Key` | Specify the key where the payload key/value will be preserved. | _none_ |
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
| Key | Description | Default |
|:--------------|:--------------------------------------------------------------------------------------------------------|:-------------|
| `buffer_size` | Maximum payload size (in bytes) for a single MQTT message. | `2048` |
| `listen` | Listener network interface. | `0.0.0.0` |
| `payload_key` | Field name where the MQTT message payload will be stored in the output record. | _none_ |
| `port` | TCP port where listening for connections. | `1883` |
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

Notes:
- `buffer_size` defaults to `2048` bytes; messages larger than this limit are dropped.
- Defaults for `listen` and `port` are `0.0.0.0` and `1883`, so you can omit them if you want the standard MQTT listener.
- Payloads are expected to be JSON maps; non-JSON payloads will fail to parse.

### TLS / SSL

The MQTT input plugin supports TLS/SSL. For the available options and guidance, see [Transport Security](../../administration/transport-security.md).

## Get started

Expand Down Expand Up @@ -55,6 +65,7 @@ pipeline:
tag: data
listen: 0.0.0.0
port: 1883
payload_key: payload

outputs:
- name: stdout
Expand All @@ -70,6 +81,7 @@ pipeline:
Tag data
Listen 0.0.0.0
Port 1883
Payload_Key payload

[OUTPUT]
Name stdout
Expand Down