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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/en/docs/zero-code/java/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ cascade:
otel: 1.46.0
---

Zero-code instrumentation with Java uses a Java agent JAR or Spring Boot
Starter. To learn how to manually instrument your service or app code, see
Zero-code instrumentation with Java uses a Java agent JAR, Spring Boot Starter,
or Quarkus. To learn how to manually instrument your service or app code, see
[Manual instrumentation](/docs/languages/java/instrumentation/).
77 changes: 77 additions & 0 deletions content/en/docs/zero-code/java/quarkus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: Quarkus instrumentation
linkTitle: Quarkus
---

## Quarkus OpenTelemetry instrumentation

[Quarkus](https://quarkus.io/) is an open source framework designed to help
software developers build efficient cloud native applications both with JVM and
Quarkus native image applications.

Quarkus uses extensions to provide optimized support for a wide range of
libraries. The
[Quarkus OpenTelemetry extension](https://quarkus.io/guides/opentelemetry)
provides:

- Out of the box instrumentation
- OpenTelemetry SDK autoconfiguration, supporting almost all system properties
defined for the
[OpenTelemetry SDK](/docs/languages/java/configuration/)
- [Vert.x](https://vertx.io/) based OTLP exporter
- The same instrumentations can be used with native image applications,
which are not supported by the OpenTelemetry Java agent.

Quarkus can also be instrumented with the [OpenTelemetry Java agent](../agent/)
if you are not running a native image application.

## Getting started

To enable OpenTelemetry in your Quarkus application, add the
`quarkus-opentelemetry` extension dependency to your project.

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

```xml
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-opentelemetry</artifactId>
</dependency>
```

{{% /tab %}} {{% tab header="Gradle (`build.gradle`)" lang=Gradle %}}

```kotlin
implementation("io.quarkus:quarkus-opentelemetry")
```

{{% /tab %}} {{< /tabpane>}}

Only the **tracing** signal will be enabled by default. To enable **metrics**
and **logs**, you need to add the following configuration to your
`application.properties` file:

```properties
quarkus.otel.metrics.enabled=true
quarkus.otel.logs.enabled=true
```

OpenTelemetry logging is available after Quarkus 3.16.0.

The remaining configurations are available in the
[Quarkus OpenTelemetry configuration reference](https://quarkus.io/guides/opentelemetry#configuration-reference).

## Additional Documentation

The Quarkus documentation provides in-depth information on how to use Quarkus
with OpenTelemetry.

- [Using OpenTelemetry guide](https://quarkus.io/guides/opentelemetry), the
general reference including all
**[configurations](https://quarkus.io/guides/opentelemetry#configuration-reference)**.
- [Using OpenTelemetry Tracing](https://quarkus.io/guides/opentelemetry-tracing),
the guide on how to **trace** your Quarkus application.
- [Using OpenTelemetry Metrics](https://quarkus.io/guides/opentelemetry-metrics),
the guide about OpenTelemetry **metrics** on Quarkus applications.
- [Using OpenTelemetry Logs](https://quarkus.io/guides/opentelemetry-logging),
the guide about OpenTelemetry **logs** on Quarkus applications.
Loading