gRPC

Install

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

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

Starter config

source:
  type: grpc
  config:
    endpoint: ""    # REQUIRED — gRPC endpoint URL (e.g.
    service_name: ""    # REQUIRED — Fully qualified service name (e.g.
    method_name: ""    # REQUIRED — Method name (e.g.
    request: null    # REQUIRED — Request message as JSON.
    descriptor_set_path: ""    # REQUIRED — Path to the compiled `FileDescriptorSet` file.
    auth:
      type: none    # one of: none, bearer, metadata
      # --- Alternative variants — replace the block above with one of these ---
      # type: bearer
      # config:
        # token: ""    # REQUIRED
      #
      # type: metadata
      # config:
        # entries: []    # REQUIRED
    # tls: false    # Whether to use TLS (detected from `https://` in endpoint by default).
    # ca_cert: null    # PEM file with an extra CA certificate to trust — for a server whose certificate is signed by a private CA.
    # domain_name: null    # Host name to verify the server certificate against, when it differs from the endpoint's host (connecting by IP or throug…
    # records_path: ""    # JSONPath to extract records from the response.
    # batch_size: 1000    # Records per emitted `StreamPage`.
    # rpc_kind: null    # Kind of gRPC RPC to invoke.
    # max_messages: null    # For `RpcKind::ServerStreaming`: maximum number of messages to consume before terminating the stream.
    # terminate_on_error: false    # For `RpcKind::ServerStreaming`: if `true`, transient stream errors (server-side disconnects, transport errors, etc.) terminate the run with `FaucetError::Source`.
    # reconnect_initial_backoff: 1    # For `RpcKind::ServerStreaming` reconnect: initial backoff delay before the first retry.
    # reconnect_max_backoff: 30    # For `RpcKind::ServerStreaming` reconnect: maximum backoff cap.
    # reconnect_max_attempts: 10    # For `RpcKind::ServerStreaming` reconnect: maximum consecutive reconnect attempts before surfacing the error.
    # reconnect_replay_from_start: false    # For `RpcKind::ServerStreaming` reconnect: whether the server replays the response stream from the beginning when the identical request is re-issued after a disconnect.
    # max_decoding_message_size: null    # Maximum size, in bytes, of a single inbound (decoded) gRPC message.
    # max_encoding_message_size: null    # Maximum size, in bytes, of a single outbound (encoded) gRPC request message.
    # connect_timeout: 10    # Seconds to wait for the TCP/TLS connection to the endpoint.
    # timeout: 30    # Seconds a unary call may take, and how long a server-streaming call may take to start (response headers).
    # idle_timeout: 300    # For `RpcKind::ServerStreaming`: seconds to wait for the next message before treating the stream as stalled and reconnecting.

Capabilities

Config fields