Skip to content

Commit

Permalink
Remove restriction that sampler description is immutable (open-teleme…
Browse files Browse the repository at this point in the history
…try#4137)

Fixes open-telemetry#2095

## Changes

State that sampler description can change over time. Provide examples.

---------

Signed-off-by: Yuri Shkuro <github@ysh.us>
Co-authored-by: Robert Pająk <pellared@hotmail.com>
  • Loading branch information
yurishkuro and pellared authored Jul 22, 2024
1 parent 59f3d4f commit 919fb55
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ release.

### Traces

- Remove restriction that sampler description is immutable.
([#4137](https://github.com/open-telemetry/opentelemetry-specification/pull/4137))

### Metrics

### Logs
Expand Down
4 changes: 3 additions & 1 deletion specification/trace/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,9 @@ Returns the sampler name or short description with the configuration. This may
be displayed on debug pages or in the logs. Example:
`"TraceIdRatioBased{0.000100}"`.

Description MUST NOT change over time and caller can cache the returned value.
Description MAY change over time, for example, if the sampler supports dynamic
configuration or otherwise adjusts its parameters.
Callers SHOULD NOT cache the returned value.

### Built-in samplers

Expand Down

0 comments on commit 919fb55

Please sign in to comment.