Skip to content

Updating the README file #1502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 17, 2024
Merged

Updating the README file #1502

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a00f832
Updating the README file
PeterF778 Oct 16, 2024
044a18f
Addressing markdown-lint issues.
PeterF778 Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion consistent-sampling/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# Consistent sampling

This component adds various Sampler implementations for consistent sampling as defined by
There are two major components included here.

## Original proposal implementation

The original specification for consistent probability sampling is defined by
<https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/tracestate-probability-sampling.md>
and <https://github.com/open-telemetry/opentelemetry-specification/pull/2047>.
It supports sampling probabilities that are power of 2 (1, 1/2, 1/4, ...), and uses 8-bit `r-value` and 8-bit `p-value` in tracestate.

The implementation of this proposal is contained by the package `io/opentelemetry/contrib/sampler/consistent` in this repository and provides various Sampler implementations.

* **ConsistentSampler**:
abstract base class of all consistent sampler implementations below
Expand All @@ -23,6 +30,31 @@ and <https://github.com/open-telemetry/opentelemetry-specification/pull/2047>.
a rate limiting sampler based on exponential smoothing that dynamically adjusts the sampling
probability based on the estimated rate of spans occurring to satisfy a given rate of sampled spans

## Current proposal implementation

The current version of the specification for consistent probability sampling is described by
<https://github.com/open-telemetry/oteps/blob/main/text/trace/0235-sampling-threshold-in-trace-state.md>.
It uses **56** bits for representing _rejection threshold_, which corresponds to a much wider range of sampling probabilities than the original proposal.

The implementation of the current proposal is contained by the package `io/opentelemetry/contrib/sampler/consistent56` in this repository and provides implementation for a number of different Samplers.

* **ConsistentSampler**
abstract base class for all consistent sampler implementations
* **ComposableSampler**:
interface used to build hierarchies of Samplers, see [Composite Samplers](https://github.com/open-telemetry/oteps/pull/250)
* **ConsistentAlwaysOffSampler**:
* **ConsistentAlwaysOnSampler**:
* **ConsistentAnyOfSampler**:
allows combining several consistent samplers; it samples when at least one of them would sample,
* **ConsistentParentBasedSampler**:
* **ConsistentFixedThresholdSampler**:
consistent probability sampler that uses a predefined sampling probability
* **ConsistentRateLimitingSampler**:
a rate limiting sampler based on exponential smoothing that dynamically adjusts the sampling
probability based on the estimated rate of spans occurring to satisfy a given rate of sampled spans
* **ConsistentRuleBasedSampler**
a sampler that performs stratified sampling by evaluating qualifying conditions and propagating the sampling decision from one of its delegate samplers

## Component owners

- [Otmar Ertl](https://github.com/oertl), Dynatrace
Expand Down
Loading