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

Tracing with the AWS Distro for OpenTelemetry Python SDK and X-Ray documentation incorrect #81

Closed
hkford opened this issue Jul 29, 2022 · 3 comments

Comments

@hkford
Copy link

hkford commented Jul 29, 2022

Describe the bug
Tracing with ADOT Python SDK and X-Ray documentation uses some old classes.

What did you expect to see?
Sending Traces to AWS X-Ray should be like the following because BatchExportSpanProcessor is renamed to BatchSpanProcessor at this PR and AwsXRayIdsGenerator is renamed to AwsXRayIdGenerator at this PR.

from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.sdk.extension.aws.trace import AwsXRayIdGenerator
# Sends generated traces in the OTLP format to an ADOT Collector running on port 4317
otlp_exporter = OTLPSpanExporter(endpoint="http://localhost:4317")
# Processes traces in batches as opposed to immediately one after the other
span_processor = BatchSpanProcessor(otlp_exporter)

What did you see instead?
At Sending Traces to AWS X-Ray, doc says:

from opentelemetry.sdk.trace.export import BatchExportSpanProcessor
from opentelemetry.sdk.extension.aws.trace import AwsXRayIdsGenerator
# Sends generated traces in the OTLP format to an ADOT Collector running on port 4317
otlp_exporter = OTLPSpanExporter(endpoint="http://localhost:4317")
# Processes traces in batches as opposed to immediately one after the other
span_processor = BatchExportSpanProcessor(otlp_exporter)
@bryan-aguilar
Copy link
Contributor

Hi thank you for the contribution! Looks like the documentation is out of date. As a note, we do accept contributions to the website repo if you were interested in filing a PR.

@hkford
Copy link
Author

hkford commented Aug 21, 2022

Raised a PR

@bryan-aguilar
Copy link
Contributor

Merged, ty for your contribution @hkford

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants