Skip to content

Docs: Clarify why we currently prefer X-Ray over ADOT in Tracing #344

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

Closed
1 task done
hjgraca opened this issue Jul 5, 2023 · 0 comments · Fixed by #347
Closed
1 task done

Docs: Clarify why we currently prefer X-Ray over ADOT in Tracing #344

hjgraca opened this issue Jul 5, 2023 · 0 comments · Fixed by #347
Labels
area/tracing Core tracing utility documentation Improvements or additions to documentation status/confirmed The scope is clear, ready for implementation

Comments

@hjgraca
Copy link
Contributor

hjgraca commented Jul 5, 2023

What were you searching in the docs?

In the Tracer docs, when introducing the utility, we should clarify why we use X-Ray over ADOT/OTEL - which appears to be the recommended way of tracing functions by other AWS teams. The Python docs for Tracer have a banner that explains the reasoning, and since it's a somewhat common question from customers we should add the same banner.

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/dotnet/core/tracing/#installation

How can we improve?

We should add a banner similar to the one present in the Python docs that specifies that we use X-Ray for latency reasons, see here: https://docs.powertools.aws.dev/lambda/python/latest/core/tracer/#getting-started

Got a suggestion in mind?

!!! note "Tracer relies on AWS X-Ray SDK over [OpenTelememetry Distro (ADOT)](https://aws-otel.github.io/docs/getting-started/lambda){target="_blank"} for optimal cold start (lower latency)."

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@hjgraca hjgraca added documentation Improvements or additions to documentation area/tracing Core tracing utility status/confirmed The scope is clear, ready for implementation labels Jul 5, 2023
@hjgraca hjgraca moved this to 📋 Backlog in Powertools for AWS Lambda (.NET) Jul 5, 2023
@hjgraca hjgraca changed the title Docs: Clarify why we currently prefer X-Ray over ADOT in Tracer Docs: Clarify why we currently prefer X-Ray over ADOT in Tracing Jul 5, 2023
@hjgraca hjgraca moved this from 📋 Backlog to 🏗 In progress in Powertools for AWS Lambda (.NET) Jul 6, 2023
@hjgraca hjgraca moved this from 🏗 In progress to 👀 In review in Powertools for AWS Lambda (.NET) Jul 6, 2023
@hjgraca hjgraca linked a pull request Jul 6, 2023 that will close this issue
7 tasks
@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label Jul 14, 2023
@hjgraca hjgraca removed the pending-release Fix or implementation already in dev waiting to be released label Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tracing Core tracing utility documentation Improvements or additions to documentation status/confirmed The scope is clear, ready for implementation
Projects
Status: 👀 In review
Development

Successfully merging a pull request may close this issue.

1 participant