NATS

Configuration Options

Required Options

url(required)

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

TypeSyntaxDefaultExample
stringliteral["nats://demo.nats.io","nats://127.0.0.1:4222"]
subject(required)

The NATS subject to publish messages to.

TypeSyntaxDefaultExample
stringtemplate["{{ host }}","foo","time.us.east","time.*.east","time.>",">"]
type(required)

The component type. This is a required field for all components and tells Vector which component to use.

TypeSyntaxDefaultExample
stringliteral["nats"]

Advanced Options

queue(optional)

NATS Queue Group to join

TypeSyntaxDefaultExample
stringliteralvector["foo","API Name Option Example"]
connection_name(optional)

A name assigned to the NATS connection.

TypeSyntaxDefaultExample
stringliteralvector["foo","API Name Option Example"]

How it Works

nats.rs

The nats source/sink uses nats.rs under the hood.

State

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

Context

By default, the nats source augments events with helpful context keys.