Struct vector_lib::event::EventMetadata

pub struct EventMetadata(/* private fields */);

Expand description

The event metadata structure is a Arc wrapper around the actual metadata to avoid cloning the underlying data until it becomes necessary to provide a mut copy.

Implementations§

§

impl EventMetadata

pub fn default_with_value(value: Value) -> EventMetadata

Creates EventMetadata with the given Value, and the rest of the fields with default values

pub fn value(&self) -> &Value

Returns a reference to the metadata value

pub fn value_mut(&mut self) -> &mut Value

Returns a mutable reference to the metadata value

pub fn secrets(&self) -> &Secrets

Returns a reference to the secrets

pub fn secrets_mut(&mut self) -> &mut Secrets

Returns a mutable reference to the secrets

pub fn source_id(&self) -> Option<&Arc<ComponentKey>>

Returns a reference to the metadata source id.

pub fn source_type(&self) -> Option<&str>

Returns a reference to the metadata source type.

pub fn upstream_id(&self) -> Option<&OutputId>

Returns a reference to the metadata parent id. This is the OutputId of the previous component the event was sent through (if any).

pub fn set_source_id(&mut self, source_id: Arc<ComponentKey>)

Sets the source_id in the metadata to the provided value.

pub fn set_source_type<S>(&mut self, source_type: S)
where S: Into<Cow<'static, str>>,

Sets the source_type in the metadata to the provided value.

pub fn set_upstream_id(&mut self, upstream_id: Arc<OutputId>)

Sets the upstream_id in the metadata to the provided value.

pub fn datadog_api_key(&self) -> Option<Arc<str>>

Return the datadog API key, if it exists

pub fn set_datadog_api_key(&mut self, secret: Arc<str>)

Set the datadog API key to passed value

pub fn splunk_hec_token(&self) -> Option<Arc<str>>

Return the splunk hec token, if it exists

pub fn set_splunk_hec_token(&mut self, secret: Arc<str>)

Set the splunk hec token to passed value

pub fn add_dropped_field(&mut self, meaning: KeyString, value: Value)

Adds the value to the dropped fields list. There is currently no way to remove a field from this list, so if a field is dropped and then the field is re-added with a new value - the dropped value will still be retrieved.

pub fn dropped_field(&self, meaning: impl AsRef<str>) -> Option<&Value>

Fetches the dropped field by meaning.

pub fn datadog_origin_metadata(&self) -> Option<&DatadogMetricOriginMetadata>

Returns a reference to the DatadogMetricOriginMetadata.

pub fn source_event_id(&self) -> Option<Uuid>

Returns a reference to the event id.

§

impl EventMetadata

pub fn with_finalizer(self, finalizer: EventFinalizer) -> EventMetadata

Replaces the existing event finalizers with the given one.

pub fn with_finalizers(self, finalizers: EventFinalizers) -> EventMetadata

Replaces the existing event finalizers with the given ones.

pub fn with_batch_notifier(self, batch: &BatchNotifier) -> EventMetadata

Replace the finalizer with a new one created from the given batch notifier.

pub fn with_batch_notifier_option( self, batch: &Option<BatchNotifier>, ) -> EventMetadata

Replace the finalizer with a new one created from the given optional batch notifier.

pub fn with_schema_definition( self, schema_definition: &Arc<Definition>, ) -> EventMetadata

Replace the schema definition with the given one.

pub fn with_source_type<S>(self, source_type: S) -> EventMetadata
where S: Into<Cow<'static, str>>,

Replaces the existing source_type with the given one.

pub fn with_origin_metadata( self, origin_metadata: DatadogMetricOriginMetadata, ) -> EventMetadata

Replaces the existing DatadogMetricOriginMetadata with the given one.

pub fn with_source_event_id( self, source_event_id: Option<Uuid>, ) -> EventMetadata

Replaces the existing source_event_id with the given one.

pub fn merge(&mut self, other: EventMetadata)

Merge the other EventMetadata into this. If a Datadog API key is not set in self, the one from other will be used. If a Splunk HEC token is not set in self, the one from other will be used.

pub fn update_status(&self, status: EventStatus)

Update the finalizer(s) status.

pub fn update_sources(&mut self)

Update the finalizers’ sources.

pub fn finalizers(&self) -> &EventFinalizers

Gets a reference to the event finalizers.

pub fn add_finalizer(&mut self, finalizer: EventFinalizer)

Add a new event finalizer to the existing list of event finalizers.

pub fn take_finalizers(&mut self) -> EventFinalizers

Consumes all event finalizers and returns them, leaving the list of event finalizers empty.

pub fn merge_finalizers(&mut self, finalizers: EventFinalizers)

Merges the given event finalizers into the existing list of event finalizers.

pub fn schema_definition(&self) -> &Arc<Definition>

Get the schema definition.

pub fn set_schema_definition(&mut self, definition: &Arc<Definition>)

Set the schema definition.

pub fn add_schema_meaning( &mut self, target_path: OwnedTargetPath, meaning: &str, )

Helper function to add a semantic meaning to the schema definition.

This replaces the common code sequence of:

let new_schema = log_event
    .metadata()
    .schema_definition()
    .as_ref()
    .clone()
    .with_meaning(target_path, meaning);
log_event
    .metadata_mut()
    .set_schema_definition(new_schema);