-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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.
````xml | ||
|
||
{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}} | ||
|
There was a problem hiding this comment.
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):
````xml | |
{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}} |
<groupId>io.quarkus</groupId> | ||
<artifactId>quarkus-opentelemetry</artifactId> | ||
</dependency> | ||
```` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
```` | |
``` |
There was a problem hiding this 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 |
There was a problem hiding this comment.
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
title: Quarkus | |
title: Quarkus native instrumentation |
software developers build efficient cloud-native applications both in JVM and | ||
native modes. |
There was a problem hiding this comment.
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
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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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](..). |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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
- Automatic instrumentation | |
- Out of the box instrumentation |
This PR adds documentation on how to use the zero-code OpenTelemetry instrumentation with the Quarkus java runtime.