Skip to content

[APM Go] fix and clarify dd-trace-go v2 docs for release #28292

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

Open
wants to merge 17 commits into
base: master
Choose a base branch
from

Conversation

hannahkm
Copy link
Contributor

@hannahkm hannahkm commented Mar 21, 2025

What does this PR do? What is the motivation?

To minimize confusion with the differences between v1 and v2, we clarify when there are not significant changes to the specific product and link customers to the migration guide whenever possible.

Also see profiling changes here.

  • Add reusable snippet to link users to migration guide. This will ease maintenance burden too.
  • Swap order of v1 and v2 tabs--put v2 first.
  • Remove mention of v2 in Preview.
  • Add GA date to support table (subject to change).
  • Refine migration guide to include more context. Preview
  • TODO: Swap v2 code statements to come first OR remove v1 import statements entirely.

Merge instructions

Merge whenever possible, preferably before or around the dd-trace-go v2 GA release.

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. Your branch name MUST follow the <slack_username>/<branch_name> convention, or your pull request will not pass in CI. If your branch doesn't follow this format, rename it or create a new branch and PR.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

Copy link
Contributor

github-actions bot commented Mar 21, 2025

Preview links (active after the build_preview check completes)

Modified Files

@github-actions github-actions bot added Guide Content impacting a guide FAQ Content impacting a FAQ labels Mar 21, 2025
@hannahkm hannahkm changed the title fix mgo link [APM Go] fix and clarify dd-trace-go v2 docs Mar 21, 2025
@hannahkm
Copy link
Contributor Author

Most important to review here is whether statements left under DSM and OTel files are accurate; has v2 made significant changes to their APIs? I don't think it has, but I'd like to confirm this.

@brett0000FF brett0000FF changed the title [APM Go] fix and clarify dd-trace-go v2 docs [APM Go] fix and clarify dd-trace-go v2 docs for release Mar 26, 2025
@brett0000FF brett0000FF requested a review from darccio March 26, 2025 18:23
@hannahkm hannahkm requested a review from felixge April 2, 2025 19:55
Copy link
Member

@felixge felixge left a comment

Choose a reason for hiding this comment

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

Thanks for working on this 🙇 . I left some comments. But since this is still draft, I'm not sure if I should try to do a complete review at this point? LMK


### Package structure changes

The package organization has changed in v2. Many functions previously in `ddtrace/tracer` have been moved to the `ddtrace` package. While the `v2check` migration tool handles these changes automatically, you may need to manually update some import paths.
Copy link
Member

@felixge felixge Apr 7, 2025

Choose a reason for hiding this comment

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

Did we have a good reason for making this change? If yes, maybe we can communicate it here?

Edit: On second thought, did we even really make this change 🤔? Looking at the v2-dev branch, it doesn't seem to be the case?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looks like a typo! I think it should be that functions previously in ddtrace are now in ddtrace/tracer. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It also looks like the examples were incorrect. @darccio I updated them to be more representative, but let me know if there's a more concise/better example of the ddtrace --> ddtrace/tracer change?

@hannahkm hannahkm marked this pull request as ready for review April 7, 2025 14:52
@hannahkm hannahkm requested review from a team as code owners April 7, 2025 14:52
@hannahkm
Copy link
Contributor Author

hannahkm commented Apr 7, 2025

@felixge Thank you for the eyes! Might as well make this PR open to review. 🏁

@brett0000FF brett0000FF self-assigned this Apr 7, 2025
@brett0000FF brett0000FF added the editorial review Waiting on a more in-depth review label Apr 7, 2025
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review FAQ Content impacting a FAQ Guide Content impacting a guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants