NATS
Configuration Options
Required Options
url(required)
The NATS URL to connect to. The url must take the form of nats://server:port
.
Type | Syntax | Default | Example |
---|---|---|---|
string | literal | ["nats://demo.nats.io","nats://127.0.0.1:4222"] |
subject(required)
The NATS subject to publish messages to.
Type | Syntax | Default | Example |
---|---|---|---|
string | template | ["{{ 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.
Type | Syntax | Default | Example |
---|---|---|---|
string | literal | ["nats"] |
Advanced Options
queue(optional)
NATS Queue Group to join
Type | Syntax | Default | Example |
---|---|---|---|
string | literal | vector | ["foo","API Name Option Example"] |
connection_name(optional)
A name assigned to the NATS connection.
Type | Syntax | Default | Example |
---|---|---|---|
string | literal | vector | ["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.