pulsar

Type:

Available in: Self-Managed

Write messages to an Apache Pulsar server.

Introduced in version 3.43.0.

  • Common

  • Advanced

# 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
# All 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
    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.

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

The 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

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

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