Skip to content

docs(tracer): add callout about ADOT #1581

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

Merged
merged 1 commit into from
Jul 5, 2023
Merged

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

As discussed with other maintainers, after hearing customer feedback we have decided to add a callout to the Tracer documentation to explain why we use X-Ray over ADOT/OTEL.

This PR introduces the banner shown in the screenshot below:

Screenshot 2023-07-05 at 13 28 34

Related issues, RFCs

Issue number: #1580

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

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.

@dreamorosi dreamorosi requested a review from a team July 5, 2023 11:31
@dreamorosi dreamorosi self-assigned this Jul 5, 2023
@dreamorosi dreamorosi linked an issue Jul 5, 2023 that may be closed by this pull request
1 task
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jul 5, 2023
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Jul 5, 2023
@dreamorosi dreamorosi requested a review from am29d July 5, 2023 11:31
@am29d am29d merged commit 2f0ecb9 into main Jul 5, 2023
@am29d am29d deleted the 1580-docs-adot-in-tracer branch July 5, 2023 12:00
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 PR between 0-9 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: clarify why we currently prefer X-Ray over ADOT in Tracer
2 participants