Struct SplunkHecLoggingPlugin 

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

Batches access-log entries and POSTs them to a Splunk HEC endpoint.

Fields

sink: BatchSink

log_format: Option<HashMap<String, Value>>

include_req_body: bool

include_resp_body: bool

Implementations

impl SplunkHecLoggingPlugin

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

Builds the plugin from node config.

Accepted keys (the APISIX endpoint sub-object is flattened; both endpoint.uri and a top-level uri are accepted):

• endpoint.uri (string, required): the HEC collector URL, e.g. https://splunk:8088/services/collector.
• endpoint.token (string, required): HEC token, sent as Authorization: Splunk <token>.
• endpoint.channel (string, optional): sent as the X-Splunk-Request-Channel header.
• endpoint.timeout (integer seconds, default 10): whole-call deadline per flush.
• source (string, default featherbit-splunk-hec-logging): HEC event source field.
• ssl_verify (bool, default true): verify TLS certificates.
• log_format, include_req_body, include_resp_body — see the shared log-entry builder.
• Batch keys — see BatchConfig.

type: splunk-hec-logging
config:
  endpoint:
    uri: https://splunk:8088/services/collector
    token: 00000000-0000-0000-0000-000000000000
  ssl_verify: true
  batch_max_size: 1000

Trait Implementations

impl Plugin for SplunkHecLoggingPlugin

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.