Skip to main content

nats_stream

Publish messages to a NATS Stream subject.

Connects to a NATS Streaming cluster and publishes each message to the configured subject. The NATS Streaming Server is deprecated; for new pipelines, consider NATS JetStream instead.

# Config fields, showing default values
output:
  label: ""
  nats_stream:
    urls: [] # No default (required)
    cluster_id: "" # No default (required)
    subject: "" # No default (required)
    client_id: ""
    max_in_flight: 64
    max_reconnects: 0
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs: []
    tls_handshake_first: false
    auth:
      nkey_file: ""
      nkey: ""
      user_credentials_file: ""
      user_jwt: ""
      user_nkey_seed: ""
      user: ""
      password: ""
      token: ""
    inject_tracing_map: ""

Examples​

Publish messages to a subject on a NATS Streaming cluster.

output:
  nats_stream:
    urls:
      - nats://127.0.0.1:4222
    cluster_id: test-cluster
    client_id: expanso-edge
    subject: foo.bar.baz

Fields​

urls​

A list of URLs to connect to. If an item of the list contains commas it will be expanded into multiple URLs.

Type: array

cluster_id​

The cluster ID to publish to.

Type: string

subject​

The subject to publish to.

Type: string

client_id​

The client ID to connect with.

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

max_reconnects​

The maximum number of times to attempt to reconnect to the server. If negative, it will never stop trying to reconnect.

Type: int

tls​

Custom TLS settings can be used to override system defaults.

Type: object

tls.enabled​

Whether custom TLS settings are enabled.

Type: bool
Default: false

tls.skip_cert_verify​

Whether to skip server side certificate verification.

Type: bool
Default: false

tls.enable_renegotiation​

Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you're seeing the error message local error: tls: no renegotiation.

Type: bool
Default: false

tls.root_cas​

An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

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

tls.client_certs​

A list of client certificates to use. For each certificate either the fields cert and key, or cert_file and key_file should be specified, but not both.

Type: array
Default: []

tls.client_certs[].cert​

A plain text certificate to use.

Type: string
Default: ""

tls.client_certs[].key​

A plain text certificate key to use. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

tls.client_certs[].cert_file​

The path of a certificate to use.

Type: string
Default: ""

tls.client_certs[].key_file​

The path of a certificate key to use.

Type: string
Default: ""

tls.client_certs[].password​

A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC algorithm is not supported for the PKCS#8 format. Warning: Since it does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

tls_handshake_first​

Whether to perform the initial TLS handshake before sending the NATS INFO protocol message.

Type: bool
Default: false

auth​

Optional configuration of NATS authentication parameters.

Type: object

auth.nkey_file​

An optional file containing a NKey seed.

Type: string

auth.nkey​

Your NKey seed or private key for NATS authentication. NKeys provide secure, cryptographic authentication without passwords. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string

auth.user_credentials_file​

An optional file containing user credentials which consist of a user JWT and corresponding NKey seed.

Type: string

auth.user_jwt​

An optional plaintext user JWT to use along with the corresponding user NKey seed. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string

auth.user_nkey_seed​

An optional plaintext user NKey seed to use along with the corresponding user JWT. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string

auth.user​

An optional plain text user name (given along with the corresponding user password).

Type: string

auth.password​

An optional plain text password (given along with the corresponding user name). :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string

auth.token​

An optional plain text token. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string

inject_tracing_map​

A Bloblang mapping used to inject an object containing tracing propagation information into outbound messages. The specification of the injected fields will match the format used by the service wide tracer.

Type: string