Struct vector::transforms::reduce::config::ReduceConfig

pub struct ReduceConfig {
    pub expire_after_ms: Duration,
    pub end_every_period_ms: Option<Duration>,
    pub flush_period_ms: Duration,
    pub max_events: Option<NonZeroUsize>,
    pub group_by: Vec<String>,
    pub merge_strategies: IndexMap<KeyString, MergeStrategy>,
    pub ends_when: Option<AnyCondition>,
    pub starts_when: Option<AnyCondition>,
}

Configuration for the reduce transform.

Fields

expire_after_ms: Duration

The maximum period of time to wait after the last event is received, in milliseconds, before a combined event should be considered complete.

end_every_period_ms: Option<Duration>

If supplied, every time this interval elapses for a given grouping, the reduced value for that grouping is flushed. Checked every flush_period_ms.

flush_period_ms: Duration

The interval to check for and flush any expired events, in milliseconds.

max_events: Option<NonZeroUsize>

The maximum number of events to group together.

group_by: Vec<String>

An ordered list of fields by which to group events.

Each group with matching values for the specified keys is reduced independently, allowing you to keep independent event streams separate. When no fields are specified, all events are combined in a single group.

For example, if group_by = ["host", "region"], then all incoming events that have the same host and region are grouped together before being reduced.

merge_strategies: IndexMap<KeyString, MergeStrategy>

A map of field names to custom merge strategies.

For each field specified, the given strategy is used for combining events rather than the default behavior.

The default behavior is as follows:

• The first value of a string field is kept and subsequent values are discarded.
• For timestamp fields the first is kept and a new field [field-name]_end is added with the last received timestamp value.
• Numeric values are summed.
• For nested paths, the field value is retrieved and then reduced using the default strategies mentioned above (unless explicitly specified otherwise).

ends_when: Option<AnyCondition>

A condition used to distinguish the final event of a transaction.

If this condition resolves to true for an event, the current transaction is immediately flushed with this event.

starts_when: Option<AnyCondition>

A condition used to distinguish the first event of a transaction.

If this condition resolves to true for an event, the previous transaction is flushed (without this event) and a new transaction is started.

Trait Implementations

impl Clone for ReduceConfig

fn clone(&self) -> ReduceConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for ReduceConfig

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 ReduceConfig

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

Formats the value using the given formatter.

impl Default for ReduceConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReduceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for ReduceConfig

fn generate_config() -> Value

impl NamedComponent for ReduceConfig

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

Gets the name of the component.

impl Serialize for ReduceConfig

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 ReduceConfig

fn to_value(&self) -> Value

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

impl TransformConfig for ReduceConfig

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, _: TableRegistry, input_definitions: &[(OutputId, Definition)], _: LogNamespace, ) -> Vec<TransformOutput>

Gets the list of outputs exposed by this transform.

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

Validates that the configuration of the transform is valid.

fn enable_concurrency(&self) -> bool

Whether or not concurrency should be enabled for this transform.

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.