Struct HecMetricsSinkConfig

pub struct HecMetricsSinkConfig {
    pub default_namespace: Option<String>,
    pub default_token: SensitiveString,
    pub endpoint: String,
    pub host_key: OptionalValuePath,
    pub index: Option<Template>,
    pub sourcetype: Option<Template>,
    pub source: Option<Template>,
    pub compression: Compression,
    pub batch: BatchConfig<SplunkHecDefaultBatchSettings>,
    pub request: TowerRequestConfig,
    pub tls: Option<TlsConfig>,
    pub acknowledgements: HecClientAcknowledgementsConfig,
}

Configuration of the splunk_hec_metrics sink.

Fields

default_namespace: Option<String>

Sets the default namespace for any metrics sent.

This namespace is only used if a metric has no existing namespace. When a namespace is present, it is used as a prefix to the metric name, and separated with a period (.).

default_token: SensitiveString

Default Splunk HEC token.

If an event has a token set in its metadata, 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: OptionalValuePath

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.

index: Option<Template>

The name of the index where to send the 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.

compression: Compression

batch: BatchConfig<SplunkHecDefaultBatchSettings>

request: TowerRequestConfig

tls: Option<TlsConfig>

acknowledgements: HecClientAcknowledgementsConfig

Implementations

impl HecMetricsSinkConfig

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

Trait Implementations

impl Clone for HecMetricsSinkConfig

fn clone(&self) -> HecMetricsSinkConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for HecMetricsSinkConfig

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 HecMetricsSinkConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HecMetricsSinkConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for HecMetricsSinkConfig

fn generate_config() -> Value

impl NamedComponent for HecMetricsSinkConfig

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

Gets the name of the component.

impl Serialize for HecMetricsSinkConfig

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 HecMetricsSinkConfig

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 files_to_watch(&self) -> Vec<&PathBuf>

Gets the files to watch to trigger reload

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

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

impl ToValue for HecMetricsSinkConfig

fn to_value(&self) -> Value

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