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 3 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.

Comment on lines +11 to +14
````xml

{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}}

Copy link
Contributor

Choose a reason for hiding this comment

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

This second and nested tabpane seems to have been added by mistake (and it caused an extra escaping of the xml):

Suggested change
````xml
{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}}

<groupId>io.quarkus</groupId>
<artifactId>quarkus-opentelemetry</artifactId>
</dependency>
````
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
````
```

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!

@@ -0,0 +1,23 @@
---
title: Quarkus
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps to not confuse with the OTel agent instrumentation

Suggested change
title: Quarkus
title: Quarkus native instrumentation

Comment on lines +7 to +8
software developers build efficient cloud-native applications both in JVM and
native modes.
Copy link
Member

Choose a reason for hiding this comment

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

To not confuse with the OpenTelemetry native instrumentation

Suggested change
software developers build efficient cloud-native applications both in JVM and
native modes.
software developers build efficient cloud-native applications both with JVM and
Quarkus native image applications.

defined for the
[OpenTelemetry SDK](https://opentelemetry.io/docs/languages/java/configuration/)
- [Vert.x](https://vertx.io/) based OTLP exporter
- Can be used in JVM and native mode (where the Java agent doesn't work)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Can be used in JVM and native mode (where the Java agent doesn't work)
- Can be used with JVM and native image applications (where the OpenTelemetry Java agent doesn't work)

- Can be used in JVM and native mode (where the Java agent doesn't work)

The Quarkus can also be instrumented with the
[OpenTelemetry Java agent](../agent) but only on JVM mode.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
[OpenTelemetry Java agent](../agent) but only on JVM mode.
[OpenTelemetry Java agent](../agent) but only with a JVM.

{{% alert title="Note" color="info" %}}

You can also use the [Java agent](../../agent) to instrument your Quarkus
application in JVM mode. For the pros and cons, see
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
application in JVM mode. For the pros and cons, see
application with a JVM. For the pros and cons, see


You can also use the [Java agent](../../agent) to instrument your Quarkus
application in JVM mode. For the pros and cons, see
[Java zero-code instrumentation](..).
Copy link
Member

Choose a reason for hiding this comment

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

There is nothing about it on the Java zero-code instrumentation part? We have written things about it for Spring. Perhaps we could remove this part for Quarkus today, and in another step see how we could provide pros and cons both for Spring and Quarkus.

[Quarkus OpenTelemetry extension](https://quarkus.io/guides/opentelemetry)
provides:

- Automatic instrumentation
Copy link
Member

Choose a reason for hiding this comment

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

Out of the box instrumentation is now used in the OpenTelemetry documentation

Suggested change
- Automatic instrumentation
- Out of the box instrumentation

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.

3 participants