Skip to content

Commit b0baaf2

Browse files
committed
Address review comments and consolidate
1 parent bb403ad commit b0baaf2

File tree

4 files changed

+65
-67
lines changed

4 files changed

+65
-67
lines changed

content/en/docs/zero-code/java/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ cascade:
1111
---
1212

1313
Zero-code instrumentation with Java uses a Java agent JAR, Spring Boot
14-
Starter or Quarkus. To learn how to manually instrument your service or app code, see
14+
Starter, or Quarkus. To learn how to manually instrument your service or app code, see
1515
[Manual instrumentation](/docs/languages/java/instrumentation/).

content/en/docs/zero-code/java/quarkus/_index.md

+64-4
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@ title: Quarkus instrumentation
33
linkTitle: Quarkus
44
---
55

6+
## Quarkus OpenTelemetry instrumentation
7+
68
[Quarkus](https://quarkus.io/) is an open source framework designed to help
7-
software developers build efficient cloud-native applications both with JVM and
9+
software developers build efficient cloud native applications both with JVM and
810
Quarkus native image applications.
911

1012
Quarkus uses extensions to provide optimized support for a wide range of
@@ -17,7 +19,65 @@ provides:
1719
defined for the
1820
[OpenTelemetry SDK](https://opentelemetry.io/docs/languages/java/configuration/)
1921
- [Vert.x](https://vertx.io/) based OTLP exporter
20-
- The same instrumentations can be used with JVM and native image applications (where the OpenTelemetry Java agent doesn't work).
22+
- The same instrumentations can be used with JVM and native image applications, where the OpenTelemetry Java agent doesn't work.
23+
24+
Quarkus can also be instrumented with the
25+
[OpenTelemetry Java agent](../agent/) but only with a JVM.
26+
27+
## Getting started
28+
29+
To enable OpenTelemetry in your Quarkus application, add the
30+
`quarkus-opentelemetry` extension dependency to your project.
31+
32+
{{< tabpane >}} {{< tab header="Maven (`pom.xml`)" lang=Maven >}}
33+
34+
```xml
35+
<dependency>
36+
<groupId>io.quarkus</groupId>
37+
<artifactId>quarkus-opentelemetry</artifactId>
38+
</dependency>
39+
```
40+
41+
{{% /tab %}} {{% tab header="Gradle (`build.gradle`)" lang=Gradle %}}
42+
43+
```kotlin
44+
implementation("io.quarkus:quarkus-opentelemetry")
45+
```
46+
47+
{{% /tab %}} {{< /tabpane>}}
48+
49+
Only the **tracing** signal will be enabled by default. To enable **metrics**
50+
and **logs**, you need to add the following configuration to your
51+
`application.properties` file:
52+
53+
```properties
54+
quarkus.otel.metrics.enabled=true
55+
quarkus.otel.logs.enabled=true
56+
```
57+
58+
OpenTelemetry logging is available after Quarkus 3.16.0.
59+
60+
The remaining configurations are available in the
61+
[Quarkus OpenTelemetry configuration reference](https://quarkus.io/guides/opentelemetry#configuration-reference).
62+
63+
{{% alert title="Note" color="info" %}}
64+
65+
You can also use the [Java agent](../../agent) to instrument your Quarkus
66+
application in a JVM.
67+
68+
{{% /alert %}}
69+
70+
## Additional Documentation
71+
72+
The Quarkus documentation provides in-depth information on how to use Quarkus
73+
with OpenTelemetry.
2174

22-
The Quarkus can also be instrumented with the
23-
[OpenTelemetry Java agent](../agent) but only with a JVM.
75+
- [Using OpenTelemetry guide](https://quarkus.io/guides/opentelemetry), the
76+
general reference including all
77+
**[configurations](https://quarkus.io/guides/opentelemetry#configuration-reference)**.
78+
- [Using OpenTelemetry Tracing](https://quarkus.io/guides/opentelemetry-tracing),
79+
the guide on how to **trace** your Quarkus application.
80+
- [Using OpenTelemetry Metrics](https://quarkus.io/guides/opentelemetry-metrics),
81+
the guide about OpenTelemetry **metrics** on Quarkus applications.
82+
- [Using OpenTelemetry Logs](https://quarkus.io/guides/opentelemetry-logging),
83+
the guide about OpenTelemetry **logs** on Quarkus applications.

content/en/docs/zero-code/java/quarkus/additional-documentation.md

-17
This file was deleted.

content/en/docs/zero-code/java/quarkus/getting-started.md

-45
This file was deleted.

0 commit comments

Comments
 (0)