Skip to content
LyftData Docs

MQTT

MQTT (mqtt)

Section titled “MQTT (mqtt)”

Ingest events from MQTT brokers (client mode) or an embedded broker (broker mode).

Messaging Enterprise edition binary json raw

Minimal example

Section titled “Minimal example”
input:
  mqtt: {}
JSON 
{
  "input": {
    "mqtt": {}
  }
}

Contents

Section titled “Contents”

A ✓ marks a field that accepts a context variable such as {{ VARIABLE }}.

Fields

Section titled “Fields”
Field Type Required Description
client Client Connect to an external MQTT broker as a client subscriber.
broker Embedded Broker Run an embedded broker and surface publishes into the pipeline.

Schema

Section titled “Schema”

Client - Retry - Backoff Fields

Section titled “Client - Retry - Backoff Fields”
Field Type Required Description
strategy Strategy Backoff strategy to use (default exponential).
Allowed values: exponential, linear, fixed
base string Base delay before retrying (e.g. “200ms”).
max string Maximum delay between retries.
jitter ✓ boolean (bool) Whether to add jitter to retry delays.
Default: false

Client - Retry Fields

Section titled “Client - Retry Fields”
Field Type Required Description
max-attempts number (integer) Maximum attempts before giving up.
Examples: 42, 1.2e-10
forever ✓ boolean (bool) Retry indefinitely until cancelled.
Default: false
backoff Backoff Backoff strategy configuration.

Client - Last Will Fields

Section titled “Client - Last Will Fields”
Field Type Required Description
topic string ✅ Topic that receives the Last Will publish.
payload string ✅ Payload delivered with the Last Will publish.
qos number QoS level (0, 1, or 2).
Default: 0
retain ✓ boolean (bool) Whether the Last Will publish should be retained.
Default: false

Client Fields

Section titled “Client Fields”
Field Type Required Description
retry Retry Retry configuration applied to client failures.
endpoint url (string) ✅ Broker endpoint URI (e.g. mqtt://broker:1883 or mqtts://broker:8883).
Examples: https://example.com/path
client-id string Optional client identifier override (defaults to job name).
keep-alive-secs number (integer) Keep-alive interval in seconds.
Default: 30
Examples: 42, 1.2e-10
clean-session ✓ boolean (bool) Whether to request a clean session on connect.
Default: true
topics string[] Explicit list of topics to subscribe to.
payload-mode Payload Mode Controls how publish payloads are interpreted.
Default: auto
Allowed values: auto, json, raw, binary
qos number Subscription QoS level (0, 1, or 2).
Default: 0
username string Optional username for broker authentication.
password string Optional password for broker authentication.
request-channel-capacity number (integer) Request channel capacity for the client worker.
Default: 10
Examples: 42, 1.2e-10
inflight number (integer) Maximum inflight window for QoS1/2 publishes.
Default: 100
Examples: 42, 1.2e-10
protocol Protocol MQTT protocol version negotiated with the broker.
Allowed values: v3, v5
last-will Last Will Optional Last Will registration.

Embedded Broker - Retry - Backoff Fields

Section titled “Embedded Broker - Retry - Backoff Fields”
Field Type Required Description
strategy Strategy Backoff strategy to use (default exponential).
Allowed values: exponential, linear, fixed
base string Base delay before retrying (e.g. “200ms”).
max string Maximum delay between retries.
jitter ✓ boolean (bool) Whether to add jitter to retry delays.
Default: false

Embedded Broker - Retry Fields

Section titled “Embedded Broker - Retry Fields”
Field Type Required Description
max-attempts number (integer) Maximum attempts before giving up.
Examples: 42, 1.2e-10
forever ✓ boolean (bool) Retry indefinitely until cancelled.
Default: false
backoff Backoff Backoff strategy configuration.

Embedded Broker - Listeners Fields

Section titled “Embedded Broker - Listeners Fields”
Field Type Required Description
bind socket-address (string) ✅ Socket address in host:port form for the embedded broker listener.
Examples: localhost:443
tls ✓ boolean (bool) Whether TLS should be enabled for this listener (placeholder).
Default: false

Embedded Broker Fields

Section titled “Embedded Broker Fields”
Field Type Required Description
retry Retry Retry configuration applied to broker ingestion failures.
topics string[] Topics the embedded broker should emit.
payload-mode Payload Mode Controls how publish payloads are interpreted.
Default: auto
Allowed values: auto, json, raw, binary
listeners Listeners[] Listener surfaces to bind for the embedded broker.
persistence-path string Optional on-disk directory for broker persistence (defaults to job data dir).
worker-threads number (integer) Number of worker threads dedicated to the embedded broker runtime.
Default: 1
Examples: 42, 1.2e-10

Client - Retry - Backoff - Strategy Options

Section titled “Client - Retry - Backoff - Strategy Options”
Value Aliases Name Description
exponential exponential
linear linear
fixed fixed

Client - Payload Mode Options

Section titled “Client - Payload Mode Options”
Value Aliases Name Description
auto auto
json json
raw raw
binary binary

Client - Protocol Options

Section titled “Client - Protocol Options”
Value Aliases Name Description
v3 v3
v5 v5

Embedded Broker - Retry - Backoff - Strategy Options

Section titled “Embedded Broker - Retry - Backoff - Strategy Options”
Value Aliases Name Description
exponential exponential
linear linear
fixed fixed

Embedded Broker - Payload Mode Options

Section titled “Embedded Broker - Payload Mode Options”
Value Aliases Name Description
auto auto
json json
raw raw
binary binary