View Source otel_sampler behaviour (opentelemetry v1.5.0)

Behaviour for defining samplers.

A sampler should provide a function run on each started span that returns whether to record and propagate, only record, or not record the span.

For more information on the concept of Sampling, see Sampling in the OpenTelemetry documentation or the Sampling spec. For examples of configuring samplers or implementing your own sampler, see the OpenTelemetry Erlang documentation.

Configuration

To configure sampling for the opentelemetry application, see the documentation.

Summary

Types

builtin_sampler/0
A built-in sampler.
description/0
The description of the sampler.
sampler_config/0
Any term used to configured a given sampler.
sampler_opts/0
Any options passed to a sampler.
sampler_spec/0
Specification to create a sampler.
sampling_decision/0
The decision that a sampler can make on a given span.
sampling_result/0
The result of a sampling decision.
t/0
A sampler.

Callbacks

description/1
Should return the description of the sampler.
setup/1
Called when a sampler is created to set up the sampler. Should return the sampler configuration that is then passed to other callbacks.
should_sample/7
Main callback that determines whether a span should be sampled.\

Functions

description(Sampler)
Returns the description of the given sampler.
new(SamplerSpec)
Returns a sampler based on the given specification.

Types

Link to this type

builtin_sampler/0

View Source 
-type builtin_sampler() ::
    always_on | always_off |
    {trace_id_ratio_based, float()} |
    {parent_based,
     #{remote_parent_sampled => sampler_spec(),
       remote_parent_not_sampled => sampler_spec(),
       local_parent_sampled => sampler_spec(),
       local_parent_not_sampled => sampler_spec(),
       root => sampler_spec()}}.
A built-in sampler.
Link to this type

description/0

View Source 
-type description() :: unicode:unicode_binary().
The description of the sampler.
Link to this type

sampler_config/0

View Source 
-type sampler_config() :: term().
Any term used to configured a given sampler.
Link to this type

sampler_opts/0

View Source 
-type sampler_opts() :: term().
Any options passed to a sampler.
Link to this type

sampler_spec/0

View Source 
-type sampler_spec() :: builtin_sampler() | {module(), sampler_opts()}.
Specification to create a sampler.
Link to this type

sampling_decision/0

View Source 
-type sampling_decision() :: drop | record_only | record_and_sample.
The decision that a sampler can make on a given span.
Link to this type

sampling_result/0

View Source 
-type sampling_result() ::
    {sampling_decision(),
     opentelemetry:attributes_map(),
     opentelemetry:tracestate() | otel_tracestate:members()}.
The result of a sampling decision.
Link to this opaque

t/0

View Source 
-opaque t()
A sampler.

Callbacks

Link to this callback

description/1

View Source 
-callback description(sampler_config()) -> description().
Should return the description of the sampler.
Link to this callback

setup/1

View Source 
-callback setup(sampler_opts()) -> sampler_config().
Called when a sampler is created to set up the sampler. Should return the sampler configuration that is then passed to other callbacks.
Link to this callback

should_sample/7

View Source 
-callback should_sample(otel_ctx:t(),
              opentelemetry:trace_id(),
              otel_links:t(),
              opentelemetry:span_name(),
              opentelemetry:span_kind(),
              opentelemetry:attributes_map(),
              sampler_config()) ->
                 sampling_result().
Main callback that determines whether a span should be sampled.\

Functions

Link to this function

description(Sampler)

View Source 
-spec description(t()) -> description().
Returns the description of the given sampler.
Link to this function

new(SamplerSpec)

View Source 
-spec new(SamplerSpec :: sampler_spec()) -> t().
Returns a sampler based on the given specification.