Apache Pulsar Sink

The Vector pulsar sink sends logs to Apache Pulsar.

Configuration

• Common
• Advanced

• vector.toml
• vector.yaml
• vector.json

[sinks.my_sink_id]
  # General
  type = "pulsar" # required
  inputs = ["my-source-or-transform-id", "prefix-*"] # required
  endpoint = "pulsar://127.0.0.1:6650" # required
  topic = "topic-1234" # required

  # Encoding
  encoding.codec = "text" # required

  # Healthcheck
  healthcheck.enabled = true # optional, default

5 items

commonrequired

• optionaltable

  auth

  Options for the authentication strategy.

  • optionalstring

    name

    The basic authentication name.

    • Syntax: literal
    • View examples
  • optionalstring

    token

    The basic authentication password.

    • Syntax: literal
    • View examples
• commonrequiredtable

  encoding

  Configures the encoding specific sink behavior.

  • commonrequiredstring

    codec

    The encoding codec used to serialize the events before outputting.

    • Syntax: literal
    • View examples
  • optional[string]

    except_fields

    Prevent the sink from encoding the specified labels.

    • View examples
  • optional[string]

    only_fields

    Prevent the sink from encoding the specified labels.

    • View examples
  • enumoptionalstring

    timestamp_format

    How to format event timestamps.

    • Syntax: literal
    • Default: "rfc3339"
    • Enum, must be one of: "rfc3339" "unix"
    • View examples
• commonrequiredstring

  endpoint

  Endpoint to which the pulsar client should connect to.

  • Syntax: literal
  • View examples
• commonoptionaltable

  healthcheck

  Health check options for the sink. See Health checks for more info.

  • commonoptionalbool

    enabled

    Enables/disables the healthcheck upon Vector boot.

    • Default: true
    • View examples
• commonrequiredstring

  topic

  The Pulsar topic name to write events to.

  • Syntax: literal
  • View examples

Telemetry

This component provides the following metrics that can be retrieved through the internal_metrics source. See the metrics section in the monitoring page for more info.

• counter

  encode_errors_total

  The total number of errors encountered when encoding an event. This metric includes the following tags:

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• counter

  events_in_total

  The total number of events accepted by this component. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• counter

  events_out_total

  The total number of events emitted by this component. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

How It Works

Health checks

Health checks ensure that the downstream service is accessible and ready to accept data. This check is performed upon sink initialization. If the health check fails an error will be logged and Vector will proceed to start.

Require health checks

If you'd like to exit immediately upon a health check failure, you can pass the --require-healthy flag:

vector --config /etc/vector/vector.toml --require-healthy

Disable health checks

If you'd like to disable health checks for this sink you can set the healthcheck option to false.

State

This component is stateless, meaning its behavior is consistent across each input.