config

Documentation

Index

• type AttributeCfg
• type AttributeRange
• type Config
• type NumericAttributeCfg
• type PropertiesCfg
• type StringAttributeCfg
• type TraceAcceptCfg
• type TraceRejectCfg

Types

type AttributeCfg

type AttributeCfg struct {
	// Tag that the filter is going to be matching against.
	Key string `mapstructure:"key"`
	// Values is the set of attribute values that if any is equal to the actual attribute value to be considered a match.
	Values []string `mapstructure:"values"`
	// UseRegex (default=false) treats the values provided as regular expressions when matching the string values
	UseRegex bool `mapstructure:"use_regex"`
	// Ranges keep numeric attribute ranges
	Ranges []AttributeRange `mapstructure:"ranges"`
}

AttributeCfg holds a universal config specification for a given key

type AttributeRange

type AttributeRange struct {
	MinValue int64 `mapstructure:"min"`
	MaxValue int64 `mapstructure:"max"`
}

AttributeRange defines min/max range for single entry

type Config

type Config struct {
	// CollectorInstances is the number of collectors sharing single configuration for
	// cascadingfilter processor. This number is used to calculate global and policy limits
	// for spans_per_second. Default value is 1.
	CollectorInstances uint `mapstructure:"collector_instances"`
	// DecisionWait is the desired wait time from the arrival of the first span of
	// trace until the decision about sampling it or not is evaluated.
	DecisionWait time.Duration `mapstructure:"decision_wait"`
	// SpansPerSecond specifies the total budget that should never be exceeded.
	// When set to zero (default value) - it is automatically calculated basing on the accept trace and
	// probabilistic filtering rate (if present)
	SpansPerSecond int32 `mapstructure:"spans_per_second"`
	// PriorSpansRate specifies the budget for traces where decision was already made previously
	// By default, it equals to half of SpansPerSecond
	PriorSpansRate *int32 `mapstructure:"prior_spans_rate"`
	// ProbabilisticFilteringRatio describes which part (0.0-1.0) of the SpansPerSecond budget
	// is exclusively allocated for probabilistically selected spans
	ProbabilisticFilteringRatio *float32 `mapstructure:"probabilistic_filtering_ratio"`
	// ProbabilisticFilteringRate describes how many spans per second are exclusively allocated
	// for probabilistically selected spans
	ProbabilisticFilteringRate *int32 `mapstructure:"probabilistic_filtering_rate"`
	// NumTraces is the number of traces kept on memory. Typically, most of the data
	// of a trace is released after a sampling decision is taken.
	NumTraces uint64 `mapstructure:"num_traces"`
	// HistorySize is the number of past decisions kept in memory. The implementation uses LRU, so
	// decisions for long-running spans are honored. By default it equals to NumTraces
	HistorySize *uint64 `mapstructure:"history_size"`
	// ExpectedNewTracesPerSec sets the expected number of new traces sending to the Cascading Filter processor
	// per second. This helps with allocating data structures with closer to actual usage size.
	ExpectedNewTracesPerSec uint64 `mapstructure:"expected_new_traces_per_sec"`
	// PolicyCfgs (depracated) sets the cascading-filter-based sampling policy which makes a sampling decision
	// for a given trace when requested.
	PolicyCfgs []TraceAcceptCfg `mapstructure:"policies"`
	// TraceAcceptCfgs sets the cascading-filter-based sampling policy which makes a sampling decision
	// for a given trace when requested.
	TraceAcceptCfgs []TraceAcceptCfg `mapstructure:"trace_accept_filters"`
	// TraceRejectCfgs sets the criteria for which traces are evaluated before applying sampling rules. If
	// trace matches them, it is no further processed
	TraceRejectCfgs []TraceRejectCfg `mapstructure:"trace_reject_filters"`
}

Config holds the configuration for cascading-filter-based sampling.

type NumericAttributeCfg

type NumericAttributeCfg struct {
	// Tag that the filter is going to be matching against.
	Key string `mapstructure:"key"`
	// MinValue is the minimum value of the attribute to be considered a match.
	MinValue int64 `mapstructure:"min_value"`
	// MaxValue is the maximum value of the attribute to be considered a match.
	MaxValue int64 `mapstructure:"max_value"`
}

NumericAttributeCfg holds the configurable settings to create a numeric attribute filter sampling policy evaluator.

type PropertiesCfg

type PropertiesCfg struct {
	// NamePattern (optional) describes a regular expression that must be met by any span operation name.
	NamePattern *string `mapstructure:"name_pattern"`
	// MinDuration (optional) is the minimum duration of trace to be considered a match.
	MinDuration *time.Duration `mapstructure:"min_duration"`
	// MinNumberOfSpans (optional) is the minimum number spans that must be present in a matching trace.
	MinNumberOfSpans *int `mapstructure:"min_number_of_spans"`
	// MinNumberOfErrors (optional) is the minimum number of spans with the status set to error that must be present in a matching trace.
	MinNumberOfErrors *int `mapstructure:"min_number_of_errors"`
}

PropertiesCfg holds the configurable settings to create a duration filter

type StringAttributeCfg

type StringAttributeCfg struct {
	// Tag that the filter is going to be matching against.
	Key string `mapstructure:"key"`
	// Values is the set of attribute values that if any is equal to the actual attribute value to be considered a match.
	Values []string `mapstructure:"values"`
	// UseRegex (default=false) treats the values provided as regular expressions when matching the values
	UseRegex bool `mapstructure:"use_regex"`
}

StringAttributeCfg holds the configurable settings to create a string attribute filter sampling policy evaluator.

type TraceAcceptCfg

type TraceAcceptCfg struct {
	// Name given to the instance of the policy to make easy to identify it in metrics and logs.
	Name string `mapstructure:"name"`
	// Configs for numeric attribute filter sampling policy evaluator.
	NumericAttributeCfg *NumericAttributeCfg `mapstructure:"numeric_attribute"`
	// Configs for string attribute filter sampling policy evaluator.
	StringAttributeCfg *StringAttributeCfg `mapstructure:"string_attribute"`
	// AttributesCfg keeps generic string/numeric attributes for multiple keys
	AttributeCfg []AttributeCfg `mapstructure:"attributes"`
	// Configs for properties sampling policy evaluator.
	PropertiesCfg PropertiesCfg `mapstructure:"properties"`
	// SpansPerSecond specifies the rule budget that should never be exceeded for it
	SpansPerSecond int32 `mapstructure:"spans_per_second"`
	// InvertMatch specifies if the match should be inverted. Default: false
	InvertMatch bool `mapstructure:"invert_match"`
}

TraceAcceptCfg holds the common configuration to all sampling policies.

type TraceRejectCfg

type TraceRejectCfg struct {
	// Name given to the instance of dropped traces policy to make easy to identify it in metrics and logs.
	Name string `mapstructure:"name"`
	// NumericAttributeCfg (optional) configs numeric attribute filter evaluator
	NumericAttributeCfg *NumericAttributeCfg `mapstructure:"numeric_attribute"`
	// StringAttributeCfg (config) configs string attribute filter evaluator.
	StringAttributeCfg *StringAttributeCfg `mapstructure:"string_attribute"`
	// AttributesCfg keeps generic string/numeric attributes for multiple keys
	AttributeCfg []AttributeCfg `mapstructure:"attributes"`
	// NamePattern (optional) describes a regular expression that must be met by any span operation name
	NamePattern *string `mapstructure:"name_pattern"`
}

TraceRejectCfg holds the configurable settings which drop all traces matching the specified criteria (all of them) before further processing