Struct vector::config::TransformContext

pub struct TransformContext {
    pub key: Option<ComponentKey>,
    pub globals: GlobalOptions,
    pub enrichment_tables: TableRegistry,
    pub schema_definitions: HashMap<Option<String>, HashMap<OutputId, Definition>>,
    pub merged_schema_definition: Definition,
    pub schema: Options,
    pub extra_context: ExtraContext,
}

Fields

key: Option<ComponentKey>

globals: GlobalOptions

enrichment_tables: TableRegistry

schema_definitions: HashMap<Option<String>, HashMap<OutputId, Definition>>

Tracks the schema IDs assigned to schemas exposed by the transform.

Given a transform can expose multiple TransformOutput channels, the ID is tied to the identifier of that TransformOutput.

merged_schema_definition: Definition

The schema definition created by merging all inputs of the transform.

This information can be used by transforms that behave differently based on schema information, such as the remap transform, which passes this information along to the VRL compiler such that type coercion becomes less of a need for operators writing VRL programs.

schema: Options

extra_context: ExtraContext

Extra context data provided by the running app and shared across all components. This can be used to pass shared settings or other data from outside the components.

Implementations

impl TransformContext

pub fn new_with_globals(globals: GlobalOptions) -> Self

pub fn log_namespace(&self, namespace: Option<bool>) -> LogNamespace

Gets the log namespacing to use. The passed in value is from the transform itself and will override any global default if it’s set.

This should only be used for transforms that don’t originate from a log (eg: metric_to_log) Most transforms will keep the log_namespace value that already exists on the event.

Trait Implementations

impl Default for TransformContext

fn default() -> Self

Returns the “default value” for a type.