NATS Sink

The Vector nats sink sends logs to NATS.

Configuration

• Common
• Advanced

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

[sinks.my_sink_id]
  # General
  type = "nats" # required
  inputs = ["my-source-or-transform-id"] # required
  subject = "{{ host }}" # required
  url = "nats://demo.nats.io" # required

  # Encoding
  encoding.codec = "json" # required

  # Healthcheck
  healthcheck.enabled = true # optional, default

5 items

commonrequired

• commonrequiredtable

  encoding

  Configures the encoding specific sink behavior.

  • commonrequiredstring

    codec

    The encoding codec used to serialize the events before outputting.

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

    • Default: "rfc3339"
    • Enum, must be one of: "rfc3339" "unix"
    • 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
• optionalstring

  name

  A name assigned to the NATS connection.

  • Default: "vector"
  • View examples
• templateablecommonrequiredstring

  subject

  The NATS subject to publish messages to.

  • View examples
• commonrequiredstring

  url

  The NATS URL to connect to. The url must take the form of nats://server:port.

  • 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

  processed_events_total

  The total number of events processed 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.

  • file - The file that produced the error

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

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

• counter

  processed_bytes_total

  The total number of bytes processed by the 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.