java library instrumentation doc #3568

nerudadhich · 2023-11-17T17:19:13Z

Fixes #2471

Preview: https://deploy-preview-3568--opentelemetry.netlify.app/docs/instrumentation/java/libraries/

content/en/docs/instrumentation/java/libraries.md

cijothomas · 2023-11-20T22:44:53Z

@nerudadhich Do you need review from .NET approvers for this or it was accidentally requested..?

cartermp · 2023-11-20T23:16:02Z

@cijothomas I took the .NET (and semconv) owners off

svrnm · 2023-11-21T10:21:33Z

content-modules/semantic-conventions

We need to rebase this PR before merging to remove this. @nerudadhich No action needed, this is just a note to maintainers, we tackle this last minute, for future PRs: make sure that you always work from a synced based that has no changes to content-modules ( you can verify with git status or git diff before creating commits

svrnm

Thank you! Would like to get some feedback from @open-telemetry/java-approvers as well. Here are a few initial comments by me

content/en/docs/instrumentation/java/libraries.md

svrnm · 2023-11-21T10:25:41Z

content/en/docs/instrumentation/java/libraries.md

+    implementation("io.opentelemetry.instrumentation:opentelemetry-java-http-client:1.31.0-alpha");
+}
+```
+


Add a not here that maven can be used of course as well and that the relevant dependency here is io.opentelemetry.instrumentation:opentelemetry-java-http-client:1.31.0-alpha

Added, Please check.

@svrnm - shouldn't we use tabbed panes in this case instead?

that would be nice here too: https://opentelemetry.io/docs/instrumentation/java/getting-started/#dependencies

@chalin @trask I have improved with tabbed panes now, Please suggest if any more text need to add for same ?

Tabbed pane seems file. I'll let @svrnm give the final work as to whether this comment is resolved to his liking.

that would be nice here too: https://opentelemetry.io/docs/instrumentation/java/getting-started/#dependencies

@trask - maybe we can open a separate issue for this?

@nerudadhich would it be a lot of effort to make this work with gradle and maven out of the box? If yes, let's keep it as is and have a separate issue for that, if no, feel free to update the PR accordingly. This would than nicely fit with the other existing documentation where we provide both

Hi @svrnm I tired spending some time on this but I am not Maven expert if we can get someone's help would be great or I can still spend more time if we are not in rush.

svrnm

Overall lgtm, @open-telemetry/java-approvers PTAL!

content/en/docs/instrumentation/java/libraries.md

chalin

As mentioned in #3568 (comment), this PR needs to be rebased. Since @svrnm has approved, I'm issuing this "request changes" as a safeguard to ensure that the PR doesn't get merged by mistake containing a retrograde of the semconv submodule.

content/en/docs/instrumentation/java/libraries.md

nerudadhich · 2024-01-10T10:02:51Z

@open-telemetry/java-approvers Could you please review ?
cc - @trask

trask · 2024-01-10T16:01:16Z

hi @nerudadhich, sorry for the delay.

@jeanbisutti can you take a look at this when you have a chance? thx!

content/en/docs/instrumentation/java/libraries.md

chalin · 2024-01-11T00:03:40Z

content/en/docs/instrumentation/java/libraries.md

+    implementation("io.opentelemetry.instrumentation:opentelemetry-java-http-client:1.31.0-alpha");
+}
+```
+


Tabbed pane seems file. I'll let @svrnm give the final work as to whether this comment is resolved to his liking.

that would be nice here too: https://opentelemetry.io/docs/instrumentation/java/getting-started/#dependencies

@trask - maybe we can open a separate issue for this?

chalin

We're getting there! See inline for a tweak to the alert.

jeanbisutti · 2024-01-16T16:58:30Z

content/en/docs/instrumentation/java/libraries.md

+
+The following example shows how you can instrument external API calls using
+[Java HTTP client library](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/java-http-client/library):
+


Perhaps mentioned that with Spring Boot the SDK (OpenTelemetry object) can be initialized with the OpenTelemetry starter: https://opentelemetry.io/docs/languages/java/automatic/spring-boot

Sure @jeanbisutti

jeanbisutti · 2024-01-16T17:23:44Z

It looks globally good to me. Perhaps this PR could be merged with the last suggestions from @chalin, and the Java library page could be improved with other PRs? @chalin @svrnm @trask What do you think?

chalin

Once the tweak to the alert is merged, since others are ok (generally speaking) with this update, I'm giving a 👍🏻 to a merge.

I agree with @jeanbisutti that I'd prefer that we address other changes separately.

svrnm · 2024-01-17T08:50:14Z

@nerudadhich you need to resolve the merge conflict locally. The issue comes from the rename of instrumentation to languages via #3761. Let me know if you need help with that.

@open-telemetry/java-approvers please take another look, I think this came a long way and is ready to be merged:-)

nerudadhich · 2024-01-17T10:46:29Z

@svrnm I have addressed the review comments, I think we are ready to merge. Just need help in Links build that is failing.

Signed-off-by: svrnm <neumanns@cisco.com>

jeanbisutti · 2024-01-18T13:38:02Z

Once the tweak to the alert is merged, since others are ok (generally speaking) with this update, I'm giving a 👍🏻 to a merge.

I agree with @jeanbisutti that I'd prefer that we address other changes separately.

@trask Is it ok for you to merge?

nerudadhich · 2024-01-22T09:40:11Z

@trask Could please confirm if we can merge ? Also @svrnm How can I see report of broken links in local or somewhere so that I can fix it ?

svrnm · 2024-01-22T09:52:36Z

Also @svrnm How can I see report of broken links in local or somewhere so that I can fix it ?

You can run npm run test-and-fix locally to get most problems resolved, or it will dump you the error. You can also do check:links for pure link checking

svrnm · 2024-01-25T09:22:41Z

@open-telemetry/java-approvers please take a look

Signed-off-by: svrnm <neumanns@cisco.com>

svrnm · 2024-01-26T08:19:16Z

Thank you for working through this, @nerudadhich, great contribution!

nerudadhich · 2024-01-29T14:22:05Z

Thank you for working through this, @nerudadhich, great contribution!

Thanks for helping everyone ❤️

nerudadhich marked this pull request as ready for review November 17, 2023 17:45

nerudadhich requested review from a team November 17, 2023 17:45

nerudadhich force-pushed the issue-2471-java-library-doc branch from b0af7ed to 364ed7e Compare November 17, 2023 17:46

nerudadhich mentioned this pull request Nov 17, 2023

Add Libraries doc or section for Java, showing how to set up library instrumentation without an agent #2471

Closed

laurit reviewed Nov 17, 2023

View reviewed changes

content/en/docs/instrumentation/java/libraries.md Outdated Show resolved Hide resolved

svrnm added the sig:java label Nov 20, 2023

nerudadhich requested review from a team November 20, 2023 17:50

nerudadhich force-pushed the issue-2471-java-library-doc branch from 5bf335e to 771af68 Compare November 20, 2023 17:53

nerudadhich requested a review from laurit November 20, 2023 18:02

nerudadhich force-pushed the issue-2471-java-library-doc branch from 2bbf5f2 to 673ec35 Compare November 20, 2023 18:07

cartermp removed request for a team November 20, 2023 23:15

svrnm reviewed Nov 21, 2023

View reviewed changes

svrnm requested changes Nov 21, 2023

View reviewed changes

nerudadhich requested a review from svrnm November 22, 2023 11:20

svrnm approved these changes Nov 23, 2023

View reviewed changes

trask reviewed Nov 27, 2023

View reviewed changes

content/en/docs/instrumentation/java/libraries.md Outdated Show resolved Hide resolved

content/en/docs/instrumentation/java/libraries.md Outdated Show resolved Hide resolved

nerudadhich requested a review from trask November 28, 2023 00:01

trask reviewed Nov 28, 2023

View reviewed changes

content/en/docs/instrumentation/java/libraries.md Outdated Show resolved Hide resolved

content/en/docs/instrumentation/java/libraries.md Outdated Show resolved Hide resolved

content/en/docs/instrumentation/java/libraries.md Outdated Show resolved Hide resolved

nerudadhich requested a review from trask November 28, 2023 10:38

chalin requested changes Nov 28, 2023

View reviewed changes

chalin reviewed Nov 28, 2023

View reviewed changes

content/en/docs/instrumentation/java/libraries.md Outdated Show resolved Hide resolved

chalin reviewed Nov 28, 2023

View reviewed changes

content/en/docs/instrumentation/java/libraries.md Outdated Show resolved Hide resolved

chalin reviewed Jan 11, 2024

View reviewed changes

chalin self-requested a review January 11, 2024 12:46

jeanbisutti reviewed Jan 16, 2024

View reviewed changes

theletterf approved these changes Jan 16, 2024

View reviewed changes

chalin approved these changes Jan 16, 2024

View reviewed changes

nerudadhich added 2 commits January 17, 2024 10:14

java library instrumentation doc added

8c3bd3e

content fixed and note added for maven

d35c625

nerudadhich force-pushed the issue-2471-java-library-doc branch from 65ebe4a to d35c625 Compare January 17, 2024 10:14

alert content updated

3e220af

svrnm added 2 commits January 17, 2024 12:07

Merge branch 'main' into issue-2471-java-library-doc

a3eddd3

fix links

aaf7f90

Signed-off-by: svrnm <neumanns@cisco.com>

jeanbisutti approved these changes Jan 25, 2024

View reviewed changes

trask approved these changes Jan 25, 2024

View reviewed changes

svrnm removed the sig-approval-missing Co-owning SIG didn't provide an approval label Jan 26, 2024

svrnm added 2 commits January 26, 2024 09:00

Merge branch 'main' into issue-2471-java-library-doc

b8f08c5

fix links

7d51622

Signed-off-by: svrnm <neumanns@cisco.com>

svrnm merged commit d51c97f into open-telemetry:main Jan 26, 2024
14 checks passed

jaydeluca pushed a commit to jaydeluca/opentelemetry.io that referenced this pull request Jan 31, 2024

java library instrumentation doc (open-telemetry#3568)

888674f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

java library instrumentation doc #3568

java library instrumentation doc #3568

nerudadhich commented Nov 17, 2023 •

edited by chalin

Loading

cijothomas commented Nov 20, 2023

cartermp commented Nov 20, 2023

svrnm Nov 21, 2023

svrnm left a comment

svrnm Nov 21, 2023

nerudadhich Nov 22, 2023

chalin Nov 28, 2023

trask Nov 28, 2023

nerudadhich Nov 28, 2023

chalin Jan 11, 2024

svrnm Jan 11, 2024

nerudadhich Jan 16, 2024

svrnm left a comment

chalin left a comment

nerudadhich commented Jan 10, 2024

trask commented Jan 10, 2024

chalin Jan 11, 2024

chalin left a comment

jeanbisutti Jan 16, 2024

nerudadhich Jan 16, 2024

jeanbisutti commented Jan 16, 2024

chalin left a comment

svrnm commented Jan 17, 2024

nerudadhich commented Jan 17, 2024 •

edited

Loading

jeanbisutti commented Jan 18, 2024

nerudadhich commented Jan 22, 2024

svrnm commented Jan 22, 2024

svrnm commented Jan 25, 2024

svrnm commented Jan 26, 2024

nerudadhich commented Jan 29, 2024


		The following example shows how you can instrument external API calls using
		[Java HTTP client library](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/java-http-client/library):

java library instrumentation doc #3568

java library instrumentation doc #3568

Conversation

nerudadhich commented Nov 17, 2023 • edited by chalin Loading

cijothomas commented Nov 20, 2023

cartermp commented Nov 20, 2023

Choose a reason for hiding this comment

svrnm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

svrnm left a comment

Choose a reason for hiding this comment

chalin left a comment

Choose a reason for hiding this comment

nerudadhich commented Jan 10, 2024

trask commented Jan 10, 2024

Choose a reason for hiding this comment

chalin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeanbisutti commented Jan 16, 2024

chalin left a comment

Choose a reason for hiding this comment

svrnm commented Jan 17, 2024

nerudadhich commented Jan 17, 2024 • edited Loading

jeanbisutti commented Jan 18, 2024

nerudadhich commented Jan 22, 2024

svrnm commented Jan 22, 2024

svrnm commented Jan 25, 2024

svrnm commented Jan 26, 2024

nerudadhich commented Jan 29, 2024

nerudadhich commented Nov 17, 2023 •

edited by chalin

Loading

nerudadhich commented Jan 17, 2024 •

edited

Loading