NATS

Install

cargo install faucet-cli --features source-nats
faucet init --source nats

# Cargo.toml — use it as a library
cargo add faucet-source-nats

Starter config

source:
  type: nats
  config:
    # servers: ["nats://127.0.0.1:4222"]    # One or more NATS server URLs, e.g.
    # auth: { type: none }    # one of: none, token, user_password, n_key, creds_file
      # --- Alternative variants — replace the block above with one of these ---
      # type: token
      # config:
        # token: ""    # REQUIRED
      #
      # type: user_password
      # config:
        # username: ""    # REQUIRED
        # password: ""    # REQUIRED
      #
      # type: n_key
      # config:
        # nkey: ""    # REQUIRED
      #
      # type: creds_file
      # config:
        # path: ""    # REQUIRED
    # tls: null    # `tls:` on the wire: a flag or a settings block.
    # name: ""    # Optional client connection name (surfaced in NATS server monitoring).
    # ignore_discovered_servers: false    # Connect only to `servers`, ignoring the cluster members a server advertises.
    subject: ""    # REQUIRED — Subject to subscribe to.
    # queue_group: ""    # Optional queue group for core-NATS load-balanced subscriptions — all subscribers sharing a group split the subject's messages.
    # jetstream_stream: ""    # JetStream stream name.
    # jetstream_consumer: ""    # Name of the durable JetStream (pull) consumer to bind to.
    # max_messages: 0    # Stop after this many messages have been drained.
    # idle_timeout_secs: 0    # Stop after this many seconds elapse with no new message.
    # batch_size: 1000    # Messages per emitted `StreamPage`.
    # progress_interval_secs: 10    # JetStream only: send an in-progress ack (`+WPI`) every this many seconds for every message pulled but not yet acked (while a page is assembled and while the sink writes it), resetting the consumer's `ack_wait` so a slow page is not redelivered into the same run.
    # value_format: null    # How `NatsSourceConfig::value_format` decodes a payload.
    # include_metadata: false    # Wrap each record as `{ subject, sequence, message_id, payload }` so a downstream consumer can deduplicate redeliveries: `sequence` is the JetStream stream sequence (`null` in core mode) and `message_id` the `Nats-Msg-Id` header (`null` when absent).
    # on_decode_error: null    # `NatsSourceConfig::on_decode_error`.

Capabilities

Config fields