Struct vector::sinks::elasticsearch::DataStreamConfig

pub struct DataStreamConfig {
    pub dtype: Template,
    pub dataset: Template,
    pub namespace: Template,
    pub auto_routing: bool,
    pub sync_fields: bool,
}

Elasticsearch data stream mode configuration.

Fields

dtype: Template

The data stream type used to construct the data stream at index time.

dataset: Template

The data stream dataset used to construct the data stream at index time.

namespace: Template

The data stream namespace used to construct the data stream at index time.

auto_routing: bool

Automatically routes events by deriving the data stream name using specific event fields.

The format of the data stream name is <type>-<dataset>-<namespace>, where each value comes from the data_stream configuration field of the same name.

If enabled, the value of the data_stream.type, data_stream.dataset, and data_stream.namespace event fields are used if they are present. Otherwise, the values set in this configuration are used.

sync_fields: bool

Automatically adds and syncs the data_stream.* event fields if they are missing from the event.

This ensures that fields match the name of the data stream that is receiving events.

Implementations

impl DataStreamConfig

pub fn remap_timestamp(&self, log: &mut LogEvent)

If there is a timestamp field, rename it to the expected @timestamp for Elastic Common Schema.

pub fn dtype<'a>(&self, event: impl Into<EventRef<'a>>) -> Option<String>

pub fn dataset<'a>(&self, event: impl Into<EventRef<'a>>) -> Option<String>

pub fn namespace<'a>(&self, event: impl Into<EventRef<'a>>) -> Option<String>

pub fn sync_fields(&self, log: &mut LogEvent)

pub fn index(&self, log: &LogEvent) -> Option<String>

Trait Implementations

impl Clone for DataStreamConfig

fn clone(&self) -> DataStreamConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for DataStreamConfig

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 DataStreamConfig

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

Formats the value using the given formatter.

impl Default for DataStreamConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DataStreamConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DataStreamConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for DataStreamConfig

fn to_value(&self) -> Value

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