mqtt
Subscribe to topics on MQTT brokers.
Introduced in version 4.37.0.
-
Common
-
Advanced
inputs:
label: ""
mqtt:
urls: [] # No default (required)
client_id: ""
connect_timeout: 30s
topics: [] # No default (required)
auto_replay_nacks: trueinputs:
label: ""
mqtt:
urls: [] # No default (required)
client_id: ""
dynamic_client_id_suffix: "" # No default (optional)
connect_timeout: 30s
will:
enabled: false
qos: 0
retained: false
topic: ""
payload: ""
user: ""
password: ""
keepalive: 30
tls:
enabled: false
skip_cert_verify: false
enable_renegotiation: false
root_cas: ""
root_cas_file: ""
client_certs: []
topics: [] # No default (required)
qos: 1
clean_session: true
auto_replay_nacks: trueMetadata
This input adds the following metadata fields to each message:
-
mqtt_duplicate
-
mqtt_qos
-
mqtt_retained
-
mqtt_topic
-
mqtt_message_id
You can access these metadata fields using function interpolation.
Fields
auto_replay_nacks
Whether messages that are rejected (nacked) at the output level should be automatically replayed indefinitely, eventually resulting in back pressure if the cause of the rejections is persistent. If set to false these messages will instead be deleted. Disabling auto replays can greatly improve memory efficiency of high throughput streams as the original shape of the data can be discarded immediately upon consumption and mutation.
Type: bool
Default: true
connect_timeout
The maximum amount of time to wait in order to establish a connection before the attempt is abandoned.
Requires version 3.58.0 or later.
Type: string
Default: 30s
# Examples:
connect_timeout: 1s
# ---
connect_timeout: 500msdynamic_client_id_suffix
Append a dynamically generated suffix to the specified client_id on each run of the pipeline. This can be useful when clustering Redpanda Connect producers.
Type: string
| Option | Summary |
|---|---|
|
append a nanoid of length 21 characters |
password
A password to connect with.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets. |
Type: string
Default: ""
tls.client_certs[]
A list of client certificates to use. For each certificate either the fields cert and key, or cert_file and key_file should be specified, but not both.
Type: object
Default: []
# Examples:
client_certs:
- cert: foo
key: bar
# ---
client_certs:
- cert_file: ./example.pem
key_file: ./example.keytls.client_certs[].key
A plain text certificate key to use.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets. |
Type: string
Default: ""
tls.client_certs[].password
A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC algorithm is not supported for the PKCS#8 format.
Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets. |
Type: string
Default: ""
# Examples:
password: foo
# ---
password: ${KEY_PASSWORD}tls.enable_renegotiation
Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you’re seeing the error message local error: tls: no renegotiation.
Requires version 3.45.0 or later.
Type: bool
Default: false
tls.root_cas
An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.
|
This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets. |
Type: string
Default: ""
# Examples:
root_cas: |-
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----tls.root_cas_file
An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.
Type: string
Default: ""
# Examples:
root_cas_file: ./root_cas.pemtls.skip_cert_verify
Whether to skip server side certificate verification.
Type: bool
Default: false
urls[]
A list of URLs to connect to. Use the format scheme://host:port, where:
-
schemeis one of the following:tcp,ssl,ws -
hostis the IP address or hostname -
portis the port on which the MQTT broker accepts connections
If an item in the list contains commas, it is expanded into multiple URLs.
Type: array
# Examples:
urls:
- "tcp://localhost:1883"