Struct splunk::hec::HecClient

pub struct HecClient {
    pub serverconfig: ServerConfig,
    pub index: Option<String>,
    pub sourcetype: Option<String>,
    pub source: Option<String>,
    pub timeout: u64,
    /* private fields */
}

HEC Client

Fields

serverconfig: ServerConfig

See ServerConfig

index: Option<String>

The target index - if this is None then it’ll just let the server decide

sourcetype: Option<String>

The target sourcetype - if this is None then it’ll just let the server decide

source: Option<String>

The target source - if this is None then it’ll just let the server decide

timeout: u64

Connection timeout, defaults to 60 seconds

Implementations

impl HecClient

pub fn new(token: impl ToString, hostname: impl ToString) -> Self

Create a new HEC client, specifying the token and hostname. Defaults to port 8088

pub fn with_serverconfig(serverconfig: ServerConfig) -> Self

Start the HEC Client with a given server config

pub fn useragent(&mut self, useragent: impl ToString)

Configure a custom user-agent string

pub async fn get_health(&self) -> Result<HecHealthResult, String>

Do a healthcheck and return the response

pub async fn get_health_ack(&self) -> Result<HecHealthResult, String>

The separate HEC health endpoint for ACK-related/enabled hosts

pub fn with_index(self, index: impl ToString) -> Self

Set the index on the events you’ll send

pub fn with_sourcetype(self, sourcetype: impl ToString) -> Self

Set the sourcetype on all events you send

pub fn with_source(self, source: impl ToString) -> Self

Set the source on all events you send

pub async fn send_event(&self, event: Value) -> Result<(), Error>

send a single event to the HEC endpoint

pub async fn send_events(&self, events: Vec<Value>) -> Result<(), Error>

send data to the HEC endpoint

pub async fn enqueue(&mut self, event: Value)

add a new queue item

pub async fn queue_size(&self) -> usize

get the current queue size

pub async fn flush(&mut self, batch_size: Option<u32>) -> Result<usize, Error>

Flush the queue out to HEC, defaults to batches of 1000

Trait Implementations

impl Debug for HecClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HecClient

fn default() -> Self

Returns the “default value” for a type.