Connect
Self-Managed Only

pulsar

Write messages to an Apache Pulsar server.

Introduced in version 3.43.0.

  • Common

  • Advanced

output:
  label: ""
  pulsar:
    url: "" # No default (required)
    topic: "" # No default (required)
    tls:
      root_cas_file: ""
    key: ""
    ordering_key: ""
    max_in_flight: 64
output:
  label: ""
  pulsar:
    url: "" # No default (required)
    topic: "" # No default (required)
    tls:
      root_cas_file: ""
    key: ""
    ordering_key: ""
    max_in_flight: 64
    auth:
      oauth2:
        enabled: false
        audience: ""
        issuer_url: ""
        scope: ""
        private_key_file: ""
      token:
        enabled: false
        token: ""

Fields

auth

Optional configuration of Pulsar authentication methods.

Requires version 3.60.0 or later.

Type: object

auth.oauth2

Parameters for Pulsar OAuth2 authentication.

Type: object

auth.oauth2.audience

OAuth2 audience.

Type: string

Default: ""

auth.oauth2.enabled

Whether OAuth2 is enabled.

Type: bool

Default: false

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.oauth2.scope

OAuth2 scope to request.

Requires version 4.29.0 or later.

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: ""

key

An optional key to populate for each message.

This field supports interpolation functions.

Type: string

Default: ""

max_in_flight

The maximum number of messages to have in flight at a given time. For outputs that send messages in batches, this limit applies to message batches. Increase this value to improve throughput.

Type: int

Default: 64

ordering_key

The ordering key to publish messages with.

This field supports interpolation functions.

Type: string

Default: ""

tls

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

Requires version 4.2.0 or later.

Type: object

tls.root_cas_file

The path of a PEM file containing the certificate authority certificates that the client trusts when it verifies the TLS certificate of the broker. Leave empty to trust the certificate authorities of the host system.

Type: string

Default: ""

# Examples:
root_cas_file: ./root_cas.pem

topic

The topic to publish to.

Type: string

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