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

Add docs for OpenTelemetry Java #5968

Merged
merged 4 commits into from
Dec 21, 2022
Merged

Add docs for OpenTelemetry Java #5968

merged 4 commits into from
Dec 21, 2022

Conversation

adinauer
Copy link
Member

Java SDK has added support for OpenTelemetry, these are the docs for it :-)

@adinauer adinauer requested a review from a team December 15, 2022 12:39
@adinauer adinauer requested a review from a team as a code owner December 15, 2022 12:39
@vercel
Copy link

vercel bot commented Dec 15, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Dec 19, 2022 at 2:31PM (UTC)

sentry.instrumenter=otel
```

You also have to manually provide the `OpenTelemetryLinkErrorEventProcessor` bean to ensure errors are properly linked to transactions that were created by the OpenTelemetry integration:
Copy link
Member Author

Choose a reason for hiding this comment

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

Decided to keep this as is for now as there doesn't seem to be an easy way to detect whether the sentry-opentelemetry-agent is used or not and this seems like a rather niche use case.

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Please take a look at my suggestions.

@@ -0,0 +1 @@
You can download the latest version of the `sentry-opentelemetry-agent-{{ packages.version('sentry.java.opentelemetry-agent') }}.zip` from [GitHub](https://github.com/getsentry/sentry-java/releases/) which contains the `JAR` file used in this docs page.
Copy link
Contributor

Choose a reason for hiding this comment

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

Just want to double check that we're pointing to the right page. I don't see a .zip file named "sentry.java.opentelemetry-agent", but it may be part of one of the other files. Just wanted to make sure.

Copy link
Member Author

Choose a reason for hiding this comment

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

It's only visible if you hit "Show all 33 assets".

Comment on lines +1 to +2
#### Initializing OpenTelemetry

Copy link
Contributor

Choose a reason for hiding this comment

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

It would be great to add an introductory sentence before the code snippet to give the user more context and an easier way to scan the page.


<PlatformContent includePath="performance/opentelemetry-install/without-java-agent" />

### Usage
Copy link
Contributor

Choose a reason for hiding this comment

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

Would be great to add an introductory sentence to introduce the user to the section and make the page easier to read. Please avoid stacking headings without text in-between.

@adinauer
Copy link
Member Author

Please take a look at my suggestions.

@lizokm I've updated the PR, can you please give the changes another pass 🙏

Copy link
Member

@markushi markushi left a comment

Choose a reason for hiding this comment

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

LGTM!

@adinauer
Copy link
Member Author

Going to merge now, if you have any more feedback just let me know. I can improve docs in another PR if needed but would like to merge this now in case people need the docs during holidays.

@adinauer adinauer merged commit 04098fb into master Dec 21, 2022
@adinauer adinauer deleted the feat/java-otel-docs branch December 21, 2022 09:40
@github-actions github-actions bot locked and limited conversation to collaborators Jan 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants