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 Quarkus documentation #6138

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

brunobat
Copy link

This PR adds documentation on how to use the zero-code OpenTelemetry instrumentation with the Quarkus java runtime.

@opentelemetrybot opentelemetrybot requested review from a team January 31, 2025 11:09
@brunobat brunobat marked this pull request as ready for review January 31, 2025 11:10
@brunobat brunobat requested a review from a team as a code owner January 31, 2025 11:10
@brunobat
Copy link
Author

CC @trask @jeanbisutti

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Hi. The build is failing, see the following log for details: https://app.netlify.com/sites/opentelemetry/deploys/679caf7a75f6fc0008075aa4. See inline suggestions for a possible fix.

content/en/docs/zero-code/java/quarkus/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/getting-started.md Outdated Show resolved Hide resolved
Copy link
Member

@jeanbisutti jeanbisutti left a comment

Choose a reason for hiding this comment

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

Thank you @brunobat!

content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/getting-started.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
@opentelemetrybot opentelemetrybot requested a review from a team February 2, 2025 20:25
@jeanbisutti jeanbisutti requested a review from chalin February 3, 2025 09:36
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

A partial copyedit pass.

content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/_index.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus/_index.md Outdated Show resolved Hide resolved
@opentelemetrybot opentelemetrybot requested a review from a team February 3, 2025 14:00
@jeanbisutti jeanbisutti requested a review from chalin February 4, 2025 13:50
content/en/docs/zero-code/java/quarkus.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/java/quarkus.md Outdated Show resolved Hide resolved
@svrnm
Copy link
Member

svrnm commented Feb 5, 2025

Hey @brunobat, thanks for raising this issue! We talked about this (and Deno) last Monday during the SIG communcations call, since both set precedence for having documentation for external projects. Overall we are excited for other projects to take on the instrumentation directly, but we need to make sure we provide some guidance here (when do we accept such a page and when do we decline, etc.), please give us some more time to evaluate.

cc @open-telemetry/docs-approvers @jack-berg

@brunobat
Copy link
Author

brunobat commented Feb 5, 2025

@svrnm do you need me in the next communications meeting?

Copy link
Member

@trask trask left a comment

Choose a reason for hiding this comment

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

I strongly support 💪

@brunobat and the Quarkus team have been active members of the OpenTelemetry Java community for a long time, and Quarkus represents an important alternative to the Spring ecosystem for our users

let me know if I can help further, thanks!

@opentelemetrybot opentelemetrybot requested review from a team February 5, 2025 15:19
@chalin
Copy link
Contributor

chalin commented Feb 5, 2025

Thanks for commenting already @svrnm. Let me share some of what I recall from our discussion during the last Comms meeting.

Actually, first let's consider that we already have:

The main question I have is What added value is there for the content of this PR vs. the Quarkus docs referenced above? Is there anything new and exclusive here? If so, why isn't it a part of the Quarkus docs? If it is just a repetition, then it introduces a maintenance overhead.

Some repetition can be ok in a blog post, so maybe that is what is needed here?

As @svrnm mentioned, we're trying to find a solution that we can apply uniformly.

My 2 cents. Open to further discussion.

cc @svrnm @tiffany76 @jack-berg

@jeanbisutti
Copy link
Member

The OpenTelemetry instrumentation developed on the Quarkus side covers one important use case in the Java world not possible with the OpenTelemetry Java agent today: instrument a Quarkus GraalVM native application with OpenTelemetry. This use case was an important reason to make the OTel starter stable.

From my side, it would make sense to highlight this in a very visible way for the OpenTelemetry users (with a new page for example).

There are also other scenarios exposed on the OpenTelemetry starter page for which the OpenTelemetry instrumentation developed on the Quarkus side is an alternative to the OpenTelemetry Java agent:

image

cc @chalin @svrnm @tiffany76 @jack-berg @trask @brunobat

@brunobat
Copy link
Author

brunobat commented Feb 5, 2025

@svrnm I think this shouldn't be about what the PR adds in terms of documentation completeness but:

  1. A recognition that the Quarkus team has done extensive OpenTelemetry instrumentation of their framework
  2. Provide another option to the users when they search about zero code instrumentation in Java.
  3. Do we want the OpenTelemetry documentation to ignore all the OpenTelemetry work done outside of the OpenTelemetry project?

@maxandersen
Copy link

"The main question I have is What added value is there for the content of this PR vs. the Quarkus docs referenced above"

mainly visibility to those looking into using OpenTelemetry standards sees that there a ways beyond just the opentelemetry github org provided libraries that enable great support for OpenTelemetry in Java ecosystem.

I definitely grok how it would be relevant to clearly mark that the Quarkus effort is from "outside" the github org/opentelemetry. Would that help to be called out more explicitly ?

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

Successfully merging this pull request may close these issues.

6 participants