open-telemetry
/
opentelemetry-python-contrib
mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update Doc for aws propagator default sampling behavior (#656)

This commit is contained in:
(Eliseo) Nathaniel Ruiz Nowell 2021-09-08 11:43:20 -07:00 committed by GitHub
parent 704f1d9cfd
commit 97e9f2f9ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
sdk-extension/opentelemetry-sdk-extension-aws/README.rst
View File

@ -46,6 +46,11 @@ Next, use the provided `AwsXRayIdGenerator` to initialize the `TracerProvider`.
Usage (AWS X-Ray Propagator) Usage (AWS X-Ray Propagator)
---------------------------- ----------------------------
**NOTE**: Because the parent context extracted 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.
Use the provided AWS X-Ray Propagator to inject the necessary context into Use the provided AWS X-Ray Propagator to inject the necessary context into
traces sent to external systems. traces sent to external systems.

10
sdk-extension/opentelemetry-sdk-extension-aws/src/opentelemetry/sdk/extension/aws/trace/propagation/aws_xray_format.py
View File

@ -18,9 +18,17 @@ AWS X-Ray Propagator
The **AWS X-Ray Propagator** provides a propagator that when used, adds a `trace The **AWS X-Ray Propagator** provides a propagator that when used, adds a `trace
header`_ to outgoing traces that is compatible with the AWS X-Ray backend service. header`_ to outgoing traces that is compatible with the AWS X-Ray backend service.
This allows the trace context to be propagated when a trace span multiple AWS This allows the trace context to be propagated when a trace spans multiple AWS
services. services.
The same propagator setup is used to extract a context sent by external systems
so that child span have the correct parent context.
**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 Usage
----- -----