Skip to content

Add spec for AlwaysRecord sampler #4699

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −0
Open

Add spec for AlwaysRecord sampler #4699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions specification/trace/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ weight: 3
* [ComposableParentThreshold](#composableparentthreshold)
* [ComposableRuleBased](#composablerulebased)
* [ComposableAnnotating](#composableannotating)
+ [AlwaysRecord](#alwaysrecord)
* [Sampling Requirements](#sampling-requirements)
+ [TraceID randomness](#traceid-randomness)
+ [Random trace flag](#random-trace-flag)
Expand Down Expand Up @@ -731,6 +732,20 @@ This example creates a configuration where:
- Other root spans are sampled at 10%
- Child spans follow their parent's sampling decision

#### AlwaysRecord
Copy link
Member

@jack-berg jack-berg Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#nit: I think we should put this above the CompositeSampler to avoid it being confused as a Built-In ComposableSampler.

Sampling SIG: does it make sense to add a Built-In ComposableSampler variation of this?

Copy link
Contributor

@carlosalberto carlosalberto Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ping @majanjua-amzn

(also we need a CHANGELOG entry)

Copy link
Contributor

@MrAlias MrAlias Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to the suggested ordering from @jack-berg


**Status**: [Development](../document-status.md)

This is a sampler decorator. `AlwaysRecord` helps to have spans between always be processed by `SpanProcessor`s. It returns the following given a sampled flag from the root sampler:
Copy link
Contributor

@MrAlias MrAlias Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make the line length wrapping consistent with the reset of the document and the rest of the changes here.

* Root sampler returns `DROP` -> AlwaysRecord returns `RECORD_ONLY`
Copy link
Contributor

@MrAlias MrAlias Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Root sampler returns `DROP` -> AlwaysRecord returns `RECORD_ONLY`
* Root sampler returns `DROP` -> AlwaysRecord returns `RECORD_ONLY`

* Root sampler returns `RECORD_ONLY` -> AlwaysRecord returns `RECORD_ONLY`
* Root sampler returns `RECORD_AND_SAMPLE` -> AlwaysRecord returns `RECORD_AND_SAMPLE`

**Required parameters:**
Copy link
Contributor

@MrAlias MrAlias Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following formatting from the rest of this document.

Suggested change
**Required parameters:**
Required parameters:


* `root(Sampler)` - A delegate sampler called to determine whether a span
is sampled or dropped

### Sampling Requirements

**Status**: [Development](../document-status.md)
Expand Down
Loading