Struct vector::transforms::remap::RemapConfig

pub struct RemapConfig {
    pub source: Option<String>,
    pub file: Option<PathBuf>,
    pub files: Option<Vec<PathBuf>>,
    pub metric_tag_values: MetricTagValues,
    pub timezone: Option<TimeZone>,
    pub drop_on_error: bool,
    pub drop_on_abort: bool,
    pub reroute_dropped: bool,
    pub runtime: VrlRuntime,
    pub cache: Mutex<Vec<((TableRegistry, Definition), Result<(Program, String, MeaningList), String>)>>,
}

Configuration for the remap transform.

Fields

source: Option<String>

The Vector Remap Language (VRL) program to execute for each event.

Required if file is missing.

file: Option<PathBuf>

File path to the Vector Remap Language (VRL) program to execute for each event.

If a relative path is provided, its root is the current working directory.

Required if source is missing.

files: Option<Vec<PathBuf>>

File paths to the Vector Remap Language (VRL) programs to execute for each event.

If a relative path is provided, its root is the current working directory.

Required if source or file are missing.

metric_tag_values: MetricTagValues

When set to single, metric tag values are exposed as single strings, the same as they were before this config option. Tags with multiple values show the last assigned value, and null values are ignored.

When set to full, all metric tags are exposed as arrays of either string or null values.

timezone: Option<TimeZone>

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

This overrides the global timezone option. The time zone name may be any name in the TZ database, or local to indicate system local time.

drop_on_error: bool

Drops any event that encounters an error during processing.

Normally, if a VRL program encounters an error when processing an event, the original, unmodified event is sent downstream. In some cases, you may not want to send the event any further, such as if certain transformation or enrichment is strictly required. Setting drop_on_error to true allows you to ensure these events do not get processed any further.

Additionally, dropped events can potentially be diverted to a specially named output for further logging and analysis by setting reroute_dropped.

drop_on_abort: bool

Drops any event that is manually aborted during processing.

If a VRL program is manually aborted (using abort) when processing an event, this option controls whether the original, unmodified event is sent downstream without any modifications or if it is dropped.

Additionally, dropped events can potentially be diverted to a specially-named output for further logging and analysis by setting reroute_dropped.

reroute_dropped: bool

Reroutes dropped events to a named output instead of halting processing on them.

When using drop_on_error or drop_on_abort, events that are “dropped” are processed no further. In some cases, it may be desirable to keep the events around for further analysis, debugging, or retrying.

In these cases, reroute_dropped can be set to true which forwards the original event to a specially-named output, dropped. The original event is annotated with additional fields describing why the event was dropped.

runtime: VrlRuntime

cache: Mutex<Vec<((TableRegistry, Definition), Result<(Program, String, MeaningList), String>)>>

Cache can’t be BTreeMap or HashMap because of TableRegistry, which doesn’t allow us to inspect tables inside it. And even if we allowed the inspection, the tables can be huge, resulting in a long comparison or hash computation while using Vec allows us to use just a shallow comparison

Trait Implementations

impl Clone for RemapConfig

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for RemapConfig

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 RemapConfig

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

Formats the value using the given formatter.

impl Default for RemapConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RemapConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for RemapConfig

fn generate_config() -> Value

impl NamedComponent for RemapConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for RemapConfig

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 RemapConfig

fn to_value(&self) -> Value

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

impl TransformConfig for RemapConfig

fn build<'life0, 'life1, 'async_trait>( &'life0 self, context: &'life1 TransformContext, ) -> Pin<Box<dyn Future<Output = Result<Transform>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Builds the transform with the given context.

fn input(&self) -> Input

Gets the input configuration for this transform.

fn outputs( &self, enrichment_tables: TableRegistry, input_definitions: &[(OutputId, Definition)], _: LogNamespace, ) -> Vec<TransformOutput>

Gets the list of outputs exposed by this transform.

fn enable_concurrency(&self) -> bool

Whether or not concurrency should be enabled for this transform.

fn validate(&self, _merged_definition: &Definition) -> Result<(), Vec<String>>

Validates that the configuration of the transform is valid.

fn nestable(&self, _parents: &HashSet<&'static str>) -> bool

Whether or not this transform can be nested, given the types of transforms it would be nested within.