Elasticsearch

Install

cargo install faucet-cli --features sink-elasticsearch
faucet init --sink elasticsearch

# Cargo.toml — use it as a library
cargo add faucet-sink-elasticsearch

Starter config

sink:
  type: elasticsearch
  config:
    base_url: ""    # REQUIRED — Base URL of the Elasticsearch cluster (e.g.
    index: ""    # REQUIRED — Target index name.
    auth:
      type: none    # one of: none, basic, bearer, api_key
      # --- Alternative variants — replace the block above with one of these ---
      # type: basic
      # config:
        # username: ""    # REQUIRED
        # password: ""    # REQUIRED
      #
      # type: bearer
      # config:
        # token: ""    # REQUIRED
      #
      # type: api_key
      # config:
        # key: ""    # REQUIRED
    # batch_size: 1000    # Maximum documents per `_bulk` HTTP request.
    # id_field: ""    # Optional JSON field name to use as the document `_id`.
    # write_mode: null    # Write semantics for a sink.
    # key: []    # Key columns.
    # delete_marker: null    # Optional.
    # rollback: null    # Runtime rollback settings (#706): the run id to journal under, the run-id column, and whether to journal before-images / keep a replaced table.
    # connect_timeout_secs: 10    # Seconds to wait for a TCP/TLS connection to the cluster.
    # request_timeout_secs: 300    # Seconds one HTTP request (a `_bulk`, `_delete_by_query`, mapping call) may take end to end before it fails as retriable.
    # tls: { ... }    # Server verification and client-certificate settings for a connector that dials a TLS server itself (Redis, NATS, Elasticsearch).
    # op_type: null    # The `_bulk` action an append write issues.

Capabilities

Config fields