Skip to main content

pulsar

EXPERIMENTAL

This component is experimental and therefore subject to change or removal outside of major version releases.

Write messages to an Apache Pulsar server.

Introduced in version 1.0.0.

# Common config fields, showing default values
output:
  label: ""
  pulsar:
    url: pulsar://localhost:6650 # No default (required)
    topic: "" # No default (required)
    tls:
      root_cas_file: ""
    key: ""
    ordering_key: ""
    max_in_flight: 64

Fields​

url​

A URL to connect to.

Type: string

# Examples

url: pulsar://localhost:6650

url: pulsar://pulsar.us-west.example.com:6650

url: pulsar+ssl://pulsar.us-west.example.com:6651

topic​

The topic to publish to.

Type: string

tls​

Specify the path to a custom CA certificate to trust broker TLS service.

Type: object

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.pem

key​

The key to publish messages with. This field supports interpolation functions.

Type: string
Default: ""

ordering_key​

The ordering key to publish messages with. This field supports interpolation functions.

Type: string
Default: ""

max_in_flight​

The maximum number of messages to have in flight at a given time. Increase this to improve throughput.

Type: int
Default: 64

auth​

Optional configuration of Pulsar authentication methods.

Type: object
Requires version 1.0.0 or newer

auth.oauth2​

Parameters for Pulsar OAuth2 authentication.

Type: object

auth.oauth2.enabled​

Whether OAuth2 is enabled.

Type: bool
Default: false

auth.oauth2.audience​

OAuth2 audience.

Type: string
Default: ""

auth.oauth2.issuer_url​

OAuth2 issuer URL.

Type: string
Default: ""

auth.oauth2.private_key_file​

The path to a file containing a private key.

Type: string
Default: ""

auth.token​

Parameters for Pulsar Token authentication.

Type: object

auth.token.enabled​

Whether Token Auth is enabled.

Type: bool
Default: false

auth.token.token​

Actual base64 encoded token.

Type: string
Default: ""