Struct vector::sinks::splunk_hec::logs::config::HecLogsSinkConfig

pub struct HecLogsSinkConfig {

    pub default_token: SensitiveString,
    pub endpoint: String,
    pub host_key: Option<OptionalTargetPath>,
    pub indexed_fields: Vec<ConfigValuePath>,
    pub index: Option<Template>,
    pub sourcetype: Option<Template>,
    pub source: Option<Template>,
    pub encoding: EncodingConfig,
    pub compression: Compression,
    pub batch: BatchConfig<SplunkHecDefaultBatchSettings>,
    pub request: TowerRequestConfig,
    pub tls: Option<TlsConfig>,
    pub acknowledgements: HecClientAcknowledgementsConfig,
    pub timestamp_nanos_key: Option<String>,
    pub timestamp_key: Option<OptionalTargetPath>,
    pub auto_extract_timestamp: Option<bool>,
    pub endpoint_target: EndpointTarget,
}

Configuration for the splunk_hec_logs sink.

Fields

default_token: SensitiveString

Default Splunk HEC token.

If an event has a token set in its secrets (splunk_hec_token), it prevails over the one set here.

endpoint: String

The base URL of the Splunk instance.

The scheme (http or https) must be specified. No path should be included since the paths defined by the Splunk API are used.

host_key: Option<OptionalTargetPath>

Overrides the name of the log field used to retrieve the hostname to send to Splunk HEC.

By default, the global log_schema.host_key option is used if log events are Legacy namespaced, or the semantic meaning of “host” is used, if defined.

indexed_fields: Vec<ConfigValuePath>

Fields to be added to Splunk index.

index: Option<Template>

The name of the index to send events to.

If not specified, the default index defined within Splunk is used.

sourcetype: Option<Template>

The sourcetype of events sent to this sink.

If unset, Splunk defaults to httpevent.

source: Option<Template>

The source of events sent to this sink.

This is typically the filename the logs originated from.

If unset, the Splunk collector sets it.

encoding: EncodingConfig

compression: Compression

batch: BatchConfig<SplunkHecDefaultBatchSettings>

request: TowerRequestConfig

tls: Option<TlsConfig>

acknowledgements: HecClientAcknowledgementsConfig

timestamp_nanos_key: Option<String>

timestamp_key: Option<OptionalTargetPath>

Overrides the name of the log field used to retrieve the timestamp to send to Splunk HEC. When set to “”, a timestamp is not set in the events sent to Splunk HEC.

By default, either the global log_schema.timestamp_key option is used if log events are Legacy namespaced, or the semantic meaning of “timestamp” is used, if defined.

auto_extract_timestamp: Option<bool>

Passes the auto_extract_timestamp option to Splunk.

This option is only relevant to Splunk v8.x and above, and is only applied when endpoint_target is set to event.

Setting this to true causes Splunk to extract the timestamp from the message text rather than use the timestamp embedded in the event. The timestamp must be in the format yyyy-mm-dd hh:mm:ss.

endpoint_target: EndpointTarget

Implementations

impl HecLogsSinkConfig

pub fn build_processor( &self, client: HttpClient, _: SinkContext, ) -> Result<VectorSink>

Trait Implementations

impl Clone for HecLogsSinkConfig

fn clone(&self) -> HecLogsSinkConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for HecLogsSinkConfig

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 HecLogsSinkConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HecLogsSinkConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for HecLogsSinkConfig

fn generate_config() -> Value

impl NamedComponent for HecLogsSinkConfig

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

Gets the name of the component.

impl Serialize for HecLogsSinkConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SinkConfig for HecLogsSinkConfig

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

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

Builds the sink with the given context.

fn input(&self) -> Input

Gets the input configuration for this sink.

fn acknowledgements(&self) -> &AcknowledgementsConfig

Gets the acknowledgements configuration for this sink.

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

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

impl ToValue for HecLogsSinkConfig

fn to_value(&self) -> Value

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