Struct vector::config::LogSchema

pub struct LogSchema { /* private fields */ }

Log schema.

A log schema is used by Vector not only to uniformly process the fields of an event, but also to specify which fields should hold specific data that is also set by Vector once an event is flowing through a topology.

Implementations

impl LogSchema

pub fn message_key(&self) -> Option<&OwnedValuePath>

pub fn owned_message_path(&self) -> OwnedTargetPath

Returns an OwnedTargetPath of the message key. This parses the path and will panic if it is invalid.

This should only be used where the result will either be cached, or performance isn’t critical, since this requires memory allocation.

Panics

Panics if the path in self.message_key is invalid.

pub fn timestamp_key(&self) -> Option<&OwnedValuePath>

pub fn host_key(&self) -> Option<&OwnedValuePath>

pub fn source_type_key(&self) -> Option<&OwnedValuePath>

pub fn metadata_key(&self) -> Option<&OwnedValuePath>

pub fn message_key_target_path(&self) -> Option<&OwnedTargetPath>

pub fn timestamp_key_target_path(&self) -> Option<&OwnedTargetPath>

pub fn host_key_target_path(&self) -> Option<&OwnedTargetPath>

pub fn source_type_key_target_path(&self) -> Option<&OwnedTargetPath>

pub fn metadata_key_target_path(&self) -> Option<&OwnedTargetPath>

pub fn set_message_key(&mut self, path: Option<OwnedTargetPath>)

pub fn set_timestamp_key(&mut self, path: Option<OwnedTargetPath>)

pub fn set_host_key(&mut self, path: Option<OwnedTargetPath>)

pub fn set_source_type_key(&mut self, path: Option<OwnedTargetPath>)

pub fn set_metadata_key(&mut self, path: Option<OwnedTargetPath>)

pub fn merge(&mut self, other: &LogSchema) -> Result<(), Vec<String>>

Merge two LogSchema instances together.

Errors

This function will fail when the LogSchema to be merged contains conflicting keys.

Trait Implementations

impl Clone for LogSchema

fn clone(&self) -> LogSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for LogSchema

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 LogSchema

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

Formats the value using the given formatter.

impl Default for LogSchema

fn default() -> LogSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LogSchema

where LogSchema: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<LogSchema, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LogSchema

fn eq(&self, other: &LogSchema) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LogSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for LogSchema

fn to_value(&self) -> Value

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

impl Eq for LogSchema

impl StructuralPartialEq for LogSchema