Documentation ¶
Index ¶
- func NewFactory() processor.Factory
- func SamplingProcessorMetricViews(level configtelemetry.Level) []*view.View
- type AndCfg
- type AndSubPolicyCfg
- type BooleanAttributeCfg
- type CompositeCfg
- type CompositeSubPolicyCfg
- type Config
- type LatencyCfg
- type NumericAttributeCfg
- type OTTLConditionCfg
- type PolicyCfg
- type PolicyType
- type ProbabilisticCfg
- type RateAllocationCfg
- type RateLimitingCfg
- type SpanCountCfg
- type StatusCodeCfg
- type StringAttributeCfg
- type TraceStateCfg
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewFactory ¶
NewFactory returns a new factory for the Tail Sampling processor.
func SamplingProcessorMetricViews ¶
func SamplingProcessorMetricViews(level configtelemetry.Level) []*view.View
SamplingProcessorMetricViews return the metrics views according to given telemetry level.
Types ¶
type AndCfg ¶ added in v0.44.0
type AndCfg struct {
SubPolicyCfg []AndSubPolicyCfg `mapstructure:"and_sub_policy"`
}
type AndSubPolicyCfg ¶ added in v0.44.0
type AndSubPolicyCfg struct {
// contains filtered or unexported fields
}
AndSubPolicyCfg holds the common configuration to all policies under and policy.
type BooleanAttributeCfg ¶ added in v0.73.0
type BooleanAttributeCfg struct { // Tag that the filter is going to be matching against. Key string `mapstructure:"key"` // Value indicate the bool value, either true or false to use when matching against attribute values. // BooleanAttribute Policy will apply exact value match on Value Value bool `mapstructure:"value"` }
BooleanAttributeCfg holds the configurable settings to create a boolean attribute filter sampling policy evaluator.
type CompositeCfg ¶ added in v0.38.0
type CompositeCfg struct { MaxTotalSpansPerSecond int64 `mapstructure:"max_total_spans_per_second"` PolicyOrder []string `mapstructure:"policy_order"` SubPolicyCfg []CompositeSubPolicyCfg `mapstructure:"composite_sub_policy"` RateAllocation []RateAllocationCfg `mapstructure:"rate_allocation"` }
CompositeCfg holds the configurable settings to create a composite sampling policy evaluator.
type CompositeSubPolicyCfg ¶ added in v0.60.0
type CompositeSubPolicyCfg struct { // Configs for and policy evaluator. AndCfg AndCfg `mapstructure:"and"` // contains filtered or unexported fields }
CompositeSubPolicyCfg holds the common configuration to all policies under composite policy.
type Config ¶
type Config struct { // 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"` // 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"` // ExpectedNewTracesPerSec sets the expected number of new traces sending to the tail sampling processor // per second. This helps with allocating data structures with closer to actual usage size. ExpectedNewTracesPerSec uint64 `mapstructure:"expected_new_traces_per_sec"` // PolicyCfgs sets the tail-based sampling policy which makes a sampling decision // for a given trace when requested. PolicyCfgs []PolicyCfg `mapstructure:"policies"` }
Config holds the configuration for tail-based sampling.
type LatencyCfg ¶ added in v0.29.0
type LatencyCfg struct { // ThresholdMs in milliseconds. ThresholdMs int64 `mapstructure:"threshold_ms"` }
LatencyCfg holds the configurable settings to create a latency filter sampling policy evaluator
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"` // InvertMatch indicates that values must not match against attribute values. // If InvertMatch is true and Values is equal to '123', all other values will be sampled except '123'. // Also, if the specified Key does not match any resource or span attributes, data will be sampled. InvertMatch bool `mapstructure:"invert_match"` }
NumericAttributeCfg holds the configurable settings to create a numeric attribute filter sampling policy evaluator.
type OTTLConditionCfg ¶ added in v0.78.0
type OTTLConditionCfg struct { ErrorMode ottl.ErrorMode `mapstructure:"error_mode"` SpanConditions []string `mapstructure:"span"` SpanEventConditions []string `mapstructure:"spanevent"` }
OTTLConditionCfg holds the configurable setting to create a OTTL condition filter sampling policy evaluator.
type PolicyCfg ¶
type PolicyCfg struct { // Configs for defining composite policy CompositeCfg CompositeCfg `mapstructure:"composite"` // Configs for defining and policy AndCfg AndCfg `mapstructure:"and"` // contains filtered or unexported fields }
PolicyCfg holds the common configuration to all policies.
type PolicyType ¶
type PolicyType string
PolicyType indicates the type of sampling policy.
const ( // AlwaysSample samples all traces, typically used for debugging. AlwaysSample PolicyType = "always_sample" // Latency sample traces that are longer than a given threshold. Latency PolicyType = "latency" // NumericAttribute sample traces that have a given numeric attribute in a specified // range, e.g.: attribute "http.status_code" >= 399 and <= 999. NumericAttribute PolicyType = "numeric_attribute" // Probabilistic samples a given percentage of traces. Probabilistic PolicyType = "probabilistic" // StatusCode sample traces that have a given status code. StatusCode PolicyType = "status_code" // StringAttribute sample traces that an attribute, of type string, matching // one of the listed values. StringAttribute PolicyType = "string_attribute" // RateLimiting allows all traces until the specified limits are satisfied. RateLimiting PolicyType = "rate_limiting" // Composite allows defining a composite policy, combining the other policies in one Composite PolicyType = "composite" // And allows defining a And policy, combining the other policies in one And PolicyType = "and" // SpanCount sample traces that are have more spans per Trace than a given threshold. SpanCount PolicyType = "span_count" // TraceState sample traces with specified values by the given key TraceState PolicyType = "trace_state" // BooleanAttribute sample traces having an attribute, of type bool, that matches // the specified boolean value [true|false]. BooleanAttribute PolicyType = "boolean_attribute" // OTTLCondition sample traces which match user provided OpenTelemetry Transformation Language // conditions. OTTLCondition PolicyType = "ottl_condition" )
type ProbabilisticCfg ¶ added in v0.34.0
type ProbabilisticCfg struct { // HashSalt allows one to configure the hashing salts. This is important in scenarios where multiple layers of collectors // have different sampling rates: if they use the same salt all passing one layer may pass the other even if they have // different sampling rates, configuring different salts avoids that. HashSalt string `mapstructure:"hash_salt"` // SamplingPercentage is the percentage rate at which traces are going to be sampled. Defaults to zero, i.e.: no sample. // Values greater or equal 100 are treated as "sample all traces". SamplingPercentage float64 `mapstructure:"sampling_percentage"` }
ProbabilisticCfg holds the configurable settings to create a probabilistic sampling policy evaluator.
type RateAllocationCfg ¶ added in v0.38.0
type RateAllocationCfg struct { Policy string `mapstructure:"policy"` Percent int64 `mapstructure:"percent"` }
RateAllocationCfg used within composite policy
type RateLimitingCfg ¶
type RateLimitingCfg struct { // SpansPerSecond sets the limit on the maximum nuber of spans that can be processed each second. SpansPerSecond int64 `mapstructure:"spans_per_second"` }
RateLimitingCfg holds the configurable settings to create a rate limiting sampling policy evaluator.
type SpanCountCfg ¶ added in v0.54.0
type SpanCountCfg struct { // Minimum number of spans in a Trace MinSpans int32 `mapstructure:"min_spans"` MaxSpans int32 `mapstructure:"max_spans"` }
SpanCountCfg holds the configurable settings to create a Span Count filter sampling policy evaluator
type StatusCodeCfg ¶ added in v0.30.0
type StatusCodeCfg struct {
StatusCodes []string `mapstructure:"status_codes"`
}
StatusCodeCfg holds the configurable settings to create a status code filter sampling policy evaluator.
type StringAttributeCfg ¶
type StringAttributeCfg struct { // Tag that the filter is going to be matching against. Key string `mapstructure:"key"` // Values indicate the set of values or regular expressions to use when matching against attribute values. // StringAttribute Policy will apply exact value match on Values unless EnabledRegexMatching is true. Values []string `mapstructure:"values"` // EnabledRegexMatching determines whether match attribute values by regexp string. EnabledRegexMatching bool `mapstructure:"enabled_regex_matching"` // CacheMaxSize is the maximum number of attribute entries of LRU Cache that stores the matched result // from the regular expressions defined in Values. // CacheMaxSize will not be used if EnabledRegexMatching is set to false. CacheMaxSize int `mapstructure:"cache_max_size"` // InvertMatch indicates that values or regular expressions must not match against attribute values. // If InvertMatch is true and Values is equal to 'acme', all other values will be sampled except 'acme'. // Also, if the specified Key does not match on any resource or span attributes, data will be sampled. InvertMatch bool `mapstructure:"invert_match"` }
StringAttributeCfg holds the configurable settings to create a string attribute filter sampling policy evaluator.
type TraceStateCfg ¶ added in v0.54.0
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
internal
|
|
idbatcher
Package idbatcher defines a pipeline of fixed size in which the elements are batches of ids.
|
Package idbatcher defines a pipeline of fixed size in which the elements are batches of ids. |
sampling
Package sampling contains the interfaces and data types used to implement the various sampling policies.
|
Package sampling contains the interfaces and data types used to implement the various sampling policies. |