Skip to content
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.

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

Update Doc for aws propagator default sampling behavior #658

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
5 changes: 5 additions & 0 deletions sdk-extension/opentelemetry-sdk-extension-aws/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ Or by setting this propagator in your instrumented application:
from opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format import AwsXRayFormat

set_global_textmap(AwsXRayFormat())

**NOTE**: Because the parent context parsed from the `X-Amzn-Trace-Id` header
assumes the context is _not_ sampled by default, users should make sure to add
`Sampled=1` to their `X-Amzn-Trace-Id` headers so that the child spans are
sampled.

Usage (AWS Resource Detectors)
------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@

set_global_textmap(AwsXRayFormat())

**NOTE**: Because the parent context parsed from the `X-Amzn-Trace-Id` header
assumes the context is _not_ sampled by default, users should make sure to add
`Sampled=1` to their `X-Amzn-Trace-Id` headers so that the child spans are
sampled.

API
---
.. _trace header: https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader
Expand Down