mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-29 05:04:05 +08:00
Import missing components for docs (#198)
This commit is contained in:

committed by
GitHub

parent
f0f6a194e6
commit
1454f46388
@ -2,5 +2,7 @@
|
||||
|
||||
## Unreleased
|
||||
|
||||
- Import missing components for docs
|
||||
([#198](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/198))
|
||||
- Provide components needed to Configure OTel SDK for Tracing with AWS X-Ray
|
||||
([#130](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/130))
|
||||
|
@ -24,9 +24,19 @@ Usage (AWS X-Ray IDs Generator)
|
||||
Configure the OTel SDK TracerProvider with the provided custom IDs Generator to
|
||||
make spans compatible with the AWS X-Ray backend tracing service.
|
||||
|
||||
Install the OpenTelemetry SDK package.
|
||||
|
||||
::
|
||||
|
||||
pip install opentelemetry-sdk-extension-aws
|
||||
|
||||
Next, use the provided `AwsXRayIdsGenerator` to initialize the `TracerProvider`.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import opentelemetry.trace as trace
|
||||
from opentelemetry.sdk.extension.aws.trace import AwsXRayIdsGenerator
|
||||
from opentelemetry.sdk.trace import TracerProvider
|
||||
|
||||
trace.set_tracer_provider(
|
||||
TracerProvider(ids_generator=AwsXRayIdsGenerator())
|
||||
@ -36,14 +46,25 @@ make spans compatible with the AWS X-Ray backend tracing service.
|
||||
Usage (AWS X-Ray Propagator)
|
||||
----------------------------
|
||||
|
||||
Set this environment variable to have the OTel SDK use the provided AWS X-Ray
|
||||
Propagator:
|
||||
Use the provided AWS X-Ray Propagator to inject the necessary context into
|
||||
traces sent to external systems.
|
||||
|
||||
This can be done by either setting this environment variable:
|
||||
|
||||
::
|
||||
|
||||
export OTEL_PROPAGATORS = aws_xray
|
||||
|
||||
|
||||
Or by setting this propagator in your instrumented application:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from opentelemetry import propagators
|
||||
from opentelemetry.sdk.extension.aws.trace.propagation.aws_xray_format import AwsXRayFormat
|
||||
|
||||
propagators.set_global_textmap(AwsXRayFormat())
|
||||
|
||||
References
|
||||
----------
|
||||
|
||||
|
Reference in New Issue
Block a user