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.

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

Rework java manual instrumentation #3144

Merged
merged 26 commits into from
Sep 14, 2023

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Aug 8, 2023

@open-telemetry/java-approvers @open-telemetry/docs-approvers

As mentioned this is a try to improve the manual instrumentation docs for Java. I used the updated version for JavaScript as a blueprint and I put the auto-configuration at the top.

There is still some work that needs to be done, but I would appreciate some early feedback. Thanks!

Preview:
https://deploy-preview-3144--opentelemetry.netlify.app/docs/instrumentation/java/manual/

Additional pages that will be introduced:
https://deploy-preview-3144--opentelemetry.netlify.app/docs/instrumentation/java/exporters/
https://deploy-preview-3144--opentelemetry.netlify.app/docs/instrumentation/java/libraries/ (tbd)

Signed-off-by: svrnm <neumanns@cisco.com>
Signed-off-by: svrnm <neumanns@cisco.com>
Signed-off-by: svrnm <neumanns@cisco.com>
@svrnm svrnm requested review from a team August 8, 2023 14:00
Signed-off-by: svrnm <neumanns@cisco.com>
Signed-off-by: svrnm <neumanns@cisco.com>
Copy link
Contributor

@cartermp cartermp left a comment

Choose a reason for hiding this comment

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

Overall lgtm

content/en/docs/instrumentation/java/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/exporters.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/manual.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/resources.md Outdated Show resolved Hide resolved
content/en/docs/instrumentation/java/exporters.md Outdated Show resolved Hide resolved
svrnm and others added 5 commits September 6, 2023 12:18
Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>
Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>
Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>
Signed-off-by: svrnm <neumanns@cisco.com>
svrnm and others added 2 commits September 11, 2023 11:54
Signed-off-by: svrnm <neumanns@cisco.com>
Signed-off-by: svrnm <neumanns@cisco.com>
@svrnm
Copy link
Member Author

svrnm commented Sep 13, 2023

Applied additional changes to solve conflict with #3239

Signed-off-by: svrnm <neumanns@cisco.com>
@svrnm svrnm merged commit 17efa87 into open-telemetry:main Sep 14, 2023
15 checks passed
@svrnm svrnm deleted the java-manual-instrumentation branch September 14, 2023 12:44
@svrnm
Copy link
Member Author

svrnm commented Sep 14, 2023

@breedx-splk @jack-berg @mateuszrzeszutek @chalin @cartermp thanks for reviewing this PR, it was a major effort to get this through :-) It's not perfect, but it moves the needle for having a more consistent documentation, thank you so much!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants