Struct HumioLogsConfig

pub struct HumioLogsConfig {

    pub token: SensitiveString,
    pub endpoint: String,
    pub source: Option<Template>,
    pub encoding: EncodingConfig,
    pub event_type: Option<Template>,
    pub host_key: OptionalTargetPath,
    pub indexed_fields: Vec<ConfigValuePath>,
    pub index: Option<Template>,
    pub compression: Compression,
    pub request: TowerRequestConfig,
    pub batch: BatchConfig<SplunkHecDefaultBatchSettings>,
    pub tls: Option<TlsConfig>,
    pub timestamp_nanos_key: Option<String>,
    pub acknowledgements: AcknowledgementsConfig,
    pub timestamp_key: OptionalTargetPath,
}

Configuration for the humio_logs sink.

Fields

token: SensitiveString

The Humio ingestion token.

endpoint: String

The base URL of the Humio instance.

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

source: Option<Template>

The source of events sent to this sink.

Typically the filename the logs originated from. Maps to @source in Humio.

encoding: EncodingConfig

event_type: Option<Template>

The type of events sent to this sink. Humio uses this as the name of the parser to use to ingest the data.

If unset, Humio defaults it to none.

host_key: OptionalTargetPath

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

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>

Event fields to be added to Humio’s extra fields.

Can be used to tag events by specifying fields starting with #.

For more information, see Humio’s Format of Data.

index: Option<Template>

Optional name of the repository to ingest into.

In public-facing APIs, this must (if present) be equal to the repository used to create the ingest token used for authentication.

In private cluster setups, Humio can be configured to allow these to be different.

For more information, see Humio’s Format of Data.

compression: Compression

request: TowerRequestConfig

batch: BatchConfig<SplunkHecDefaultBatchSettings>

tls: Option<TlsConfig>

timestamp_nanos_key: Option<String>

Overrides the name of the log field used to retrieve the nanosecond-enabled timestamp to send to Humio.

acknowledgements: AcknowledgementsConfig

timestamp_key: OptionalTargetPath

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

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.

Trait Implementations

impl Clone for HumioLogsConfig

fn clone(&self) -> HumioLogsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for HumioLogsConfig

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 HumioLogsConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HumioLogsConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for HumioLogsConfig

fn generate_config() -> Value

impl NamedComponent for HumioLogsConfig

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

Gets the name of the component.

impl Serialize for HumioLogsConfig

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 HumioLogsConfig

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 HumioLogsConfig

fn to_value(&self) -> Value

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