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

docs: Clarify why we currently prefer X-Ray over ADOT in Tracing #347

Merged
merged 1 commit into from
Jul 14, 2023

Conversation

hjgraca
Copy link
Contributor

@hjgraca hjgraca commented Jul 6, 2023

Please provide the issue number

Issue number: #344

Summary

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.

Changes

Please provide a summary of what's being changed

Add note

!!! 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)."

User experience

Please share what the user experience looks like before and after this change

Checklist

Please leave checklist items unchecked if they do not apply to your change.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@auto-assign auto-assign bot requested review from amirkaws and sliedig July 6, 2023 15:52
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jul 6, 2023
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 6, 2023
@hjgraca hjgraca linked an issue Jul 6, 2023 that may be closed by this pull request
1 task
@codecov-commenter
Copy link

Codecov Report

Patch coverage has no change and project coverage change: -0.15 ⚠️

Comparison is base (38130a1) 69.31% compared to head (13b3bad) 69.16%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #347      +/-   ##
===========================================
- Coverage    69.31%   69.16%   -0.15%     
===========================================
  Files           79       79              
  Lines         3464     3464              
===========================================
- Hits          2401     2396       -5     
- Misses        1063     1068       +5     
Flag Coverage Δ
unittests 69.16% <ø> (-0.15%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@amirkaws amirkaws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hjgraca hjgraca merged commit 6e6d2a7 into aws-powertools:develop Jul 14, 2023
@hjgraca hjgraca deleted the docs-clarify-xray-over-adot branch July 14, 2023 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Clarify why we currently prefer X-Ray over ADOT in Tracing
3 participants