Struct Options 

pub struct Options {
    pub enabled: bool,
    pub validation: bool,
    pub log_namespace: Option<bool>,
}

Schema options.

Note: The enabled and validation options are experimental and should only be enabled if you understand the limitations. While the infrastructure exists for schema tracking and validation, the full vision of automatic semantic field mapping and comprehensive schema enforcement was never fully realized.

If you encounter issues with these features, please report them here.

Fields

enabled: bool

When enabled, Vector tracks the schema (field types and structure) of events as they flow from sources through transforms to sinks. This allows Vector to understand what data each component receives and produces.

validation: bool

When enabled, Vector validates that events flowing into each sink match the schema requirements of that sink. If a sink requires certain fields or types that are missing from the incoming events, Vector will report an error during configuration validation.

This helps catch pipeline configuration errors early, before runtime.

log_namespace: Option<bool>

Controls how metadata is stored in log events.

When set to false (legacy mode), metadata fields like host, timestamp, and source_type are stored as top-level fields alongside your log data.

When set to true (Vector namespace mode), metadata is stored in a separate metadata namespace, keeping it distinct from your actual log data.

See the Log Namespacing guide for detailed information about when to use Vector namespace mode and how to migrate from legacy mode.

Implementations

impl Options

pub fn log_namespace(self) -> LogNamespace

Gets the value of the globally configured log namespace, or the default if it wasn’t set.

pub fn append(&mut self, with: Self, errors: &mut Vec<String>)

Merges two schema options together.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for Options

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 Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

where Options: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Options

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Options

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 Options

fn to_value(&self) -> Value

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

impl Copy for Options

impl Eq for Options

impl StructuralPartialEq for Options