Struct vector::transforms::sample::config::SampleConfig

pub struct SampleConfig {
    pub rate: u64,
    pub key_field: Option<String>,
    pub sample_rate_key: OptionalValuePath,
    pub group_by: Option<Template>,
    pub exclude: Option<AnyCondition>,
}

Configuration for the sample transform.

Fields

rate: u64

The rate at which events are forwarded, expressed as 1/N.

For example, rate = 1500 means 1 out of every 1500 events are forwarded and the rest are dropped.

key_field: Option<String>

The name of the field whose value is hashed to determine if the event should be sampled.

Each unique value for the key creates a bucket of related events to be sampled together and the rate is applied to the buckets themselves to sample 1/N buckets. The overall rate of sampling may differ from the configured one if values in the field are not uniformly distributed. If left unspecified, or if the event doesn’t have key_field, then the event is sampled independently.

This can be useful to, for example, ensure that all logs for a given transaction are sampled together, but that overall 1/N transactions are sampled.

sample_rate_key: OptionalValuePath

The event key in which the sample rate is stored. If set to an empty string, the sample rate will not be added to the event.

group_by: Option<Template>

The value to group events into separate buckets to be sampled independently.

If left unspecified, or if the event doesn’t have group_by, then the event is not sampled separately.

exclude: Option<AnyCondition>

A logical condition used to exclude events from sampling.

Trait Implementations

impl Clone for SampleConfig

fn clone(&self) -> SampleConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for SampleConfig

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 SampleConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SampleConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for SampleConfig

fn generate_config() -> Value

impl NamedComponent for SampleConfig

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

Gets the name of the component.

impl Serialize for SampleConfig

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 SampleConfig

fn to_value(&self) -> Value

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

impl TransformConfig for SampleConfig

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.