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

Improve OpenTelemetry Java manual instrumentation documentation #19424

Merged
merged 6 commits into from
Dec 14, 2023
Merged

Improve OpenTelemetry Java manual instrumentation documentation #19424

merged 6 commits into from
Dec 14, 2023

Conversation

PerfectSlayer
Copy link
Contributor

@PerfectSlayer PerfectSlayer commented Aug 18, 2023 •
edited
Loading

What does this PR do?

This PR adds a better definition of which OpenTelemetry features are supported from APM Tracing using the Java tracer library. It also brings few code samples about the most requested use cases.

Motivation

There was an increasing number of escalations regarding the usage of this feature.
Providing more details of what is supported from what isn't could be useful to the customers.

Additional Notes

I plan to update the page as soon as we get more features covered.
For example, annotations support contribution is in review and could bring more code samples. Same for the Context API support.

Reviewer checklist

  • Review the changed files.
  • Review the URLs listed in the Preview section.
  • Check images for PII
  • Review any mentions of "Contact Datadog support" for internal support documentation.

@PerfectSlayer PerfectSlayer added tracing Content changed in the tracing folder opentelemetry labels Aug 18, 2023
@PerfectSlayer PerfectSlayer requested a review from a team as a code owner August 18, 2023 11:18
@github-actions
Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

brett0000FF
brett0000FF approved these changes Aug 18, 2023
View reviewed changes
Copy link
Contributor

@brett0000FF brett0000FF 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 this content! I just added a few small suggestions. Let me know if you need me to merge this.

content/en/tracing/trace_collection/otel_instrumentation/java.md Outdated Show resolved Hide resolved
content/en/tracing/trace_collection/otel_instrumentation/java.md Outdated Show resolved Hide resolved
content/en/tracing/trace_collection/otel_instrumentation/java.md Outdated Show resolved Hide resolved
@PerfectSlayer
Copy link
Contributor Author

Thanks for the review.
I am in discussion with team leads and PM to make sure it is the right content for the customer.
I will get back to you as soon as I get it approved.

katiehockman
katiehockman reviewed Aug 29, 2023
View reviewed changes
content/en/tracing/trace_collection/otel_instrumentation/java.md
@@ -19,22 +19,62 @@ further_reading:

The following OpenTelemetry features implemented in the Datadog library as noted:

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd suggest noting that for those listed as "Unsupported", there may be progress on moving those to "Supported" in the near future, and if a customer wants one of those features, they should escalate to support about this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed. I just add the instrumentation annotation for example.
But the contributing guideline does not recommend such content (ref):

Avoid temporal words like "currently", "now", "will", etc. Describe the present state of the product.

So, what would be the right sentence to add below this table?

The support of OpenTelemetry features is an ongoing effort. If there is any missing feature of your interest, please escalate to support about it.

@PerfectSlayer PerfectSlayer changed the title Improve OpenTelemetry Javan manual instrumentation documentation Improve OpenTelemetry Java manual instrumentation documentation Sep 14, 2023
@bantonsson bantonsson force-pushed the bbujon/otel-instrumentation branch 2 times, most recently from 2855224 to 1d66a08 Compare December 13, 2023 12:51
@bantonsson bantonsson force-pushed the bbujon/otel-instrumentation branch from 1d66a08 to 20a77d9 Compare December 13, 2023 12:59
@brett0000FF brett0000FF merged commit a319e12 into master Dec 14, 2023
11 checks passed
@brett0000FF brett0000FF deleted the bbujon/otel-instrumentation branch December 14, 2023 15:27
MaelNamNam pushed a commit that referenced this pull request Jan 17, 2024
@PerfectSlayer @brett0000FF
@bantonsson @MaelNamNam
Improve OpenTelemetry Java manual instrumentation documentation (#19424)
b7a052e 
* Improve OpenTelemetry Javan manual instrumentation documentation

* Fix case

Co-authored-by: Brett Blue <[email protected]>

* Addressing Vale check

Co-authored-by: Brett Blue <[email protected]>

* Improve wording

Co-authored-by: Brett Blue <[email protected]>

* Add OTel instrumentation annotation support

* Remove confusing SDK reference and minor cleanups

---------

Co-authored-by: Brett Blue <[email protected]>
Co-authored-by: Björn Antonsson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@katiehockman katiehockman katiehockman left review comments

@brett0000FF brett0000FF brett0000FF approved these changes

Assignees
No one assigned
Labels
opentelemetry tracing Content changed in the tracing folder
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@PerfectSlayer @katiehockman @brett0000FF @bantonsson