Struct vector::config::GlobalOptions

pub struct GlobalOptions {
    pub data_dir: Option<PathBuf>,
    pub log_schema: LogSchema,
    pub telemetry: Telemetry,
    pub timezone: Option<TimeZone>,
    pub proxy: ProxyConfig,
    pub acknowledgements: AcknowledgementsConfig,
    pub expire_metrics: Option<Duration>,
    pub expire_metrics_secs: Option<f64>,
}

Global configuration options.

Fields

data_dir: Option<PathBuf>

The directory used for persisting Vector state data.

This is the directory where Vector will store any state data, such as disk buffers, file checkpoints, and more.

Vector must have write permissions to this directory.

log_schema: LogSchema

Default log schema for all events.

This is used if a component does not have its own specific log schema. All events use a log schema, whether or not the default is used, to assign event fields on incoming events.

telemetry: Telemetry

Telemetry options.

Determines whether source and service tags should be emitted with the component_sent_* and component_received_* events.

timezone: Option<TimeZone>

The name of the time zone to apply to timestamp conversions that do not contain an explicit time zone.

The time zone name may be any name in the TZ database or local to indicate system local time.

proxy: ProxyConfig

acknowledgements: AcknowledgementsConfig

Controls how acknowledgements are handled for all sinks by default.

See End-to-end Acknowledgements for more information on how Vector handles event acknowledgement.

expire_metrics: Option<Duration>

The amount of time, in seconds, that internal metrics will persist after having not been updated before they expire and are removed.

Not set by default, which allows all internal metrics to grow unbounded over time. If you have a configuration that emits many high-cardinality metrics, you may want to consider setting this to a value that ensures that metrics live long enough to be emitted and captured, but not so long that they continue to build up indefinitely, as this will consume a small amount of memory for each metric.

expire_metrics_secs: Option<f64>

The amount of time, in seconds, that internal metrics will persist after having not been updated before they expire and are removed.

Not set by default, which allows all internal metrics to grow unbounded over time. If you have a configuration that emits many high-cardinality metrics, you may want to consider setting this to a value that ensures that metrics live long enough to be emitted and captured, but not so long that they continue to build up indefinitely, as this will consume a small amount of memory for each metric.

Implementations

impl GlobalOptions

pub fn resolve_and_validate_data_dir( &self, local_data_dir: Option<&PathBuf>, ) -> Result<PathBuf, Box<dyn Error + Sync + Send>>

Resolve the data_dir option in either the global or local config, and validate that it exists and is writable.

Errors

Function will error if it is unable to make data directory.

pub fn resolve_and_make_data_subdir( &self, local: Option<&PathBuf>, subdir: &str, ) -> Result<PathBuf, Box<dyn Error + Sync + Send>>

Resolve the data_dir option using resolve_and_validate_data_dir and then ensure a named subdirectory exists.

Errors

Function will error if it is unable to make data subdirectory.

pub fn merge(&self, with: GlobalOptions) -> Result<GlobalOptions, Vec<String>>

Merge a second global configuration into self, and return the new merged data.

Errors

Returns a list of textual errors if there is a merge conflict between the two global configs.

pub fn timezone(&self) -> TimeZone

Get the configured time zone, using “local” time if none is set.

Trait Implementations

impl Clone for GlobalOptions

fn clone(&self) -> GlobalOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for GlobalOptions

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 GlobalOptions

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

Formats the value using the given formatter.

impl Default for GlobalOptions

fn default() -> GlobalOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GlobalOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GlobalOptions

fn eq(&self, other: &GlobalOptions) -> 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 GlobalOptions

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 GlobalOptions

fn to_value(&self) -> Value

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

impl StructuralPartialEq for GlobalOptions