Struct SplunkConfig 

pub struct SplunkConfig {
    pub address: SocketAddr,
    pub event: CodecConfig,
    pub raw: CodecConfig,
    /* private fields */
}

Configuration for the splunk_hec source.

Fields

address: SocketAddr

The socket address to listen for connections on.

The address must include a port.

event: CodecConfig

Codec configuration applied to events received on /services/collector/event.

When decoding is set, Vector applies a second decoding pass after parsing the HEC envelope. The envelope’s event field is passed through the codec, and a single envelope can fan out to multiple events. Decode failures are swallowed and do not return an error to the Splunk client.

The VRL codec can access HEC envelope metadata, such as host, sourcetype, and, channel, and the authentication token via %splunk_hec.* paths and get_secret!("splunk_hec_token") before the program executes.

raw: CodecConfig

Codec configuration applied to events received on /services/collector/raw.

When decoding is set, the (decompressed) request body is fed through the codec instead of being emitted as a single event. Decode failures are swallowed and do not return an error to the Splunk client. When unset, the endpoint preserves its existing behavior of one event per request body.

Trait Implementations

impl Clone for SplunkConfig

fn clone(&self) -> SplunkConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configurable for SplunkConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for SplunkConfig

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

Formats the value using the given formatter.

impl Default for SplunkConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SplunkConfig

where SplunkConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for SplunkConfig

fn generate_config() -> Value

impl NamedComponent for SplunkConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for SplunkConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SourceConfig for SplunkConfig

fn build<'life0, 'async_trait>( &'life0 self, cx: SourceContext, ) -> Pin<Box<dyn Future<Output = Result<Source>> + Send + 'async_trait>>

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

Builds the source with the given context.

fn outputs(&self, global_log_namespace: LogNamespace) -> Vec<SourceOutput>

Gets the list of outputs exposed by this source.

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this source.

fn can_acknowledge(&self) -> bool

Whether or not this source can acknowledge the events it emits.

fn send_timeout(&self) -> Option<Duration>

If this source supports timeout returns from the SourceSender and the configuration provides a timeout value, return it here and the out channel will be configured with it.

impl ToValue for SplunkConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.