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.

Sign up for GitHub

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

Jump to bottom

APM SDKs #24255

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

APM SDKs #24255

wants to merge 34 commits into from

Conversation

brett0000FF
Copy link
Contributor

@brett0000FF brett0000FF commented Jul 22, 2024 •
edited
Loading

What does this PR do? What is the motivation?

This PR updates our documentation to align with consistent terminology around the APM SDK, formerly known as the Datadog tracing libraries or tracers. The updates includes a new guide explaining the terminology and replacing instances of "tracer" and "tracing library" with "SDK".

  • TODO: Draft guide detailing APM SDK terminology. Preview
  • TODO: Replace tracer and tracing library with SDK (or API) throughout all APM docs. Note: Avoiding code samples or where content refers specifically to Tracer in code example.
  • TODO: Make separate PR for Ruby changes in dd-trace-rb. Link
  • TODO: Make separate PR for docs outside /tracing/ like ASM, OTel, etc.
  • TODO: After initial work is complete, add Vale rule.

Merge instructions

  • Please merge after reviewing

Additional notes

@brett0000FF brett0000FF added the Do Not Merge Just do not merge this PR :) label Jul 22, 2024
@brett0000FF brett0000FF requested a review from a team as a code owner July 22, 2024 16:38
@github-actions github-actions bot added the Guide Content impacting a guide label Jul 22, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 22, 2024 •
edited
Loading

Preview links (active after the build_preview check completes)

New or renamed files

Modified Files

@brett0000FF brett0000FF requested a review from a team as a code owner July 23, 2024 21:42
@github-actions github-actions bot added the FAQ Content impacting a FAQ label Jul 24, 2024
@brett0000FF brett0000FF changed the title Datadog SDKs APM SDKs Jul 31, 2024
@brett0000FF brett0000FF mentioned this pull request Jul 31, 2024
Open
@brett0000FF brett0000FF added editorial review Waiting on a more in-depth review and removed Do Not Merge Just do not merge this PR :) labels Jul 31, 2024
cswatt
cswatt reviewed Jul 31, 2024
View reviewed changes
Copy link
Contributor

@cswatt cswatt left a comment

Choose a reason for hiding this comment

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

Some feedback! Note that my main note on the SDK guide is very much just an opinion and can be ignored.

content/en/tracing/guide/sdks.md Outdated Show resolved Hide resolved
content/en/tracing/guide/sdks.md Outdated Show resolved Hide resolved
content/en/tracing/guide/sdks.md Outdated Show resolved Hide resolved
content/en/tracing/trace_collection/compatibility/dotnet-core.md Outdated Show resolved Hide resolved
content/en/tracing/trace_collection/trace_context_propagation/dotnet.md Outdated Show resolved Hide resolved
content/en/tracing/trace_collection/trace_context_propagation/dotnet.md Outdated Show resolved Hide resolved
@brett0000FF brett0000FF requested a review from cswatt July 31, 2024 18:27
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Aug 1, 2024
bm1549
bm1549 reviewed Aug 2, 2024
View reviewed changes
Copy link
Contributor

@bm1549 bm1549 left a comment

Choose a reason for hiding this comment

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

LGTM aside from the comments on Go and .NET

content/en/tracing/trace_collection/compatibility/go.md Outdated Show resolved Hide resolved
content/en/tracing/trace_collection/compatibility/dotnet-framework.md Outdated Show resolved Hide resolved
content/en/tracing/trace_collection/compatibility/dotnet-core.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucaspimentel lucaspimentel lucaspimentel left review comments

@bm1549 bm1549 bm1549 left review comments

@zacharycmontoya zacharycmontoya zacharycmontoya left review comments

@cswatt cswatt cswatt approved these changes

@tushar-datadog tushar-datadog Awaiting requested review from tushar-datadog

@wantsui wantsui Awaiting requested review from wantsui

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@brett0000FF @cswatt @lucaspimentel @bm1549 @zacharycmontoya