Struct ClickhouseLoggerPlugin 

pub struct ClickhouseLoggerPlugin {
    sink: BatchSink,
    log_format: Option<HashMap<String, Value>>,
    include_req_body: bool,
    include_resp_body: bool,
}

Node that batches access-log entries and inserts them into ClickHouse.

Fields

sink: BatchSink

log_format: Option<HashMap<String, Value>>

include_req_body: bool

include_resp_body: bool

Implementations

impl ClickhouseLoggerPlugin

pub fn from_config( config: &HashMap<String, Value>, resources: &Arc<PluginResources>, ) -> Result<Self, String>

Builds the plugin from node config.

Accepted keys:

• endpoint_addr (string) / endpoint_addrs (array of strings): ClickHouse HTTP URL(s), e.g. http://clickhouse:8123. At least one is required.
• database (string, required): target database (sent via the X-ClickHouse-Database header).
• logtable (string, required): target table, used in the INSERT INTO <logtable> statement.
• user / password (strings, default ""): ClickHouse credentials, sent as X-ClickHouse-User / X-ClickHouse-Key.
• ssl_verify (bool, default true): verify TLS certificates.
• timeout (integer seconds, default 3): per-flush HTTP deadline.
• include_req_body / include_resp_body (bool, default false).
• log_format (object, optional): custom flat entry.
• Batch tuning (see BatchConfig).

type: clickhouse-logger
config:
  endpoint_addr: http://clickhouse:8123
  database: default
  logtable: gateway_logs
  user: default
  password: ${CLICKHOUSE_PASSWORD}
  timeout: 3

Trait Implementations

impl Plugin for ClickhouseLoggerPlugin

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”).

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, ctx: Context, _named_inputs: &'life1 HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes the plugin logic against the request/response context.