Skip to main content

Pulsar

Reads messages from an Apache Pulsar server.

The following metadata fields are added to each message:

- pulsar_message_id
- pulsar_key
- pulsar_ordering_key
- pulsar_event_time_unix
- pulsar_publish_time_unix
- pulsar_topic
- pulsar_producer_name
- pulsar_redelivery_count
- All properties of the message

Configuration​

NameTypeOptionalSecretDescription
urlstringnonoA URL to connect to.
topics[]stringnonoA list of topics to subscribe to. This or topics_pattern must be set.
topics_patternstringnonoA regular expression matching the topics to subscribe to. This or topics must be set.
subscription_namestringnonoSpecify the subscription name for this consumer.
subscription_typestringyesnoSpecify the subscription type for this consumer.
> NOTE: Using a key_shared subscription type will allow out-of-order delivery since nack-ing messages sets non-zero nack delivery delay - this can potentially cause consumers to stall. See https://pulsar.apache.org/docs/en/2.8.1/concepts-messaging/#negative-acknowledgement[Pulsar documentation^] and https://github.com/apache/pulsar/issues/12208[this Github issue^] for more details. The value should be one of shared, key_shared, failover or exclusive. The value defaults to "shared".
subscription_initial_positionstringyesnoSpecify the subscription initial position for this consumer. The value should be one of latest or earliest. The value defaults to "latest".
authauthnonoOptional configuration of Pulsar authentication methods.

Auth​

NameTypeOptionalSecretDescription
oauth2oauth2nonoParameters for Pulsar OAuth2 authentication.
tokentokennonoParameters for Pulsar Token authentication.