From c71c9efd5d9dda3512db652be4cd42d30916ea6d Mon Sep 17 00:00:00 2001 From: brunobat Date: Fri, 31 Jan 2025 10:42:00 +0000 Subject: [PATCH 01/12] Quarkus documentation --- .../en/docs/zero-code/java/quarkus/_index.md | 15 ++++++ .../java/quarkus/additional-documentation.md | 11 +++++ .../zero-code/java/quarkus/getting-started.md | 46 +++++++++++++++++++ 3 files changed, 72 insertions(+) create mode 100644 content/en/docs/zero-code/java/quarkus/_index.md create mode 100644 content/en/docs/zero-code/java/quarkus/additional-documentation.md create mode 100644 content/en/docs/zero-code/java/quarkus/getting-started.md diff --git a/content/en/docs/zero-code/java/quarkus/_index.md b/content/en/docs/zero-code/java/quarkus/_index.md new file mode 100644 index 000000000000..7413f8d49d24 --- /dev/null +++ b/content/en/docs/zero-code/java/quarkus/_index.md @@ -0,0 +1,15 @@ +--- +title: Quarkus +linkTitle: Quarkus +--- + +[Quarkus](https://quarkus.io/) is an open-source framework designed to help software developers build efficient cloud-native applications both in JVM and native modes. + +Quarkus uses extensions to provide optimized support for a wide range of libraries. +The [Quarkus OpenTelemetry extension](https://quarkus.io/guides/opentelemetry) provides: +* Automatic instrumentation +* OpenTelemetry SDK autoconfiguration, supporting almost all system properties 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) + +The Quarkus can also be instrumented with the [OpenTelemetry Java agent](../agent) but only on JVM mode. diff --git a/content/en/docs/zero-code/java/quarkus/additional-documentation.md b/content/en/docs/zero-code/java/quarkus/additional-documentation.md new file mode 100644 index 000000000000..43c7f8130bb0 --- /dev/null +++ b/content/en/docs/zero-code/java/quarkus/additional-documentation.md @@ -0,0 +1,11 @@ +--- +title: Additional Documentation +weight: 30 +--- + +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. diff --git a/content/en/docs/zero-code/java/quarkus/getting-started.md b/content/en/docs/zero-code/java/quarkus/getting-started.md new file mode 100644 index 000000000000..cf41096cafbc --- /dev/null +++ b/content/en/docs/zero-code/java/quarkus/getting-started.md @@ -0,0 +1,46 @@ +--- +title: Getting started with Quarkus +weight: 20 +--- + + + +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 + +{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}} + +```xml + + io.quarkus + quarkus-opentelemetry + +``` + +{{% /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 +``` + +The remaining configurations are available in the [Quarkus OpenTelemetry configuration reference](https://quarkus.io/guides/opentelemetry#configuration-reference). + + +{{% 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 [Java zero-code instrumentation](..). + +{{% /alert %}} From d42eb8cc08f5a4037eefd8f9a72a9bc40f129194 Mon Sep 17 00:00:00 2001 From: brunobat Date: Fri, 31 Jan 2025 10:56:29 +0000 Subject: [PATCH 02/12] Quarkus version --- content/en/docs/zero-code/java/quarkus/getting-started.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/en/docs/zero-code/java/quarkus/getting-started.md b/content/en/docs/zero-code/java/quarkus/getting-started.md index cf41096cafbc..fa0c6c395594 100644 --- a/content/en/docs/zero-code/java/quarkus/getting-started.md +++ b/content/en/docs/zero-code/java/quarkus/getting-started.md @@ -35,6 +35,7 @@ Only the **tracing** signal will be enabled by default. To enable **metrics** an 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). From 9f5470114b8fd1091552526ca6d7b7d408a9b451 Mon Sep 17 00:00:00 2001 From: brunobat Date: Fri, 31 Jan 2025 11:04:35 +0000 Subject: [PATCH 03/12] Quarkus documentation formating --- .../en/docs/zero-code/java/quarkus/_index.md | 24 ++++++++++++------ .../java/quarkus/additional-documentation.md | 16 ++++++++---- .../zero-code/java/quarkus/getting-started.md | 25 +++++++++++-------- 3 files changed, 41 insertions(+), 24 deletions(-) diff --git a/content/en/docs/zero-code/java/quarkus/_index.md b/content/en/docs/zero-code/java/quarkus/_index.md index 7413f8d49d24..5a220cd9435a 100644 --- a/content/en/docs/zero-code/java/quarkus/_index.md +++ b/content/en/docs/zero-code/java/quarkus/_index.md @@ -3,13 +3,21 @@ title: Quarkus linkTitle: Quarkus --- -[Quarkus](https://quarkus.io/) is an open-source framework designed to help software developers build efficient cloud-native applications both in JVM and native modes. +[Quarkus](https://quarkus.io/) is an open source framework designed to help +software developers build efficient cloud-native applications both in JVM and +native modes. -Quarkus uses extensions to provide optimized support for a wide range of libraries. -The [Quarkus OpenTelemetry extension](https://quarkus.io/guides/opentelemetry) provides: -* Automatic instrumentation -* OpenTelemetry SDK autoconfiguration, supporting almost all system properties 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) +Quarkus uses extensions to provide optimized support for a wide range of +libraries. The +[Quarkus OpenTelemetry extension](https://quarkus.io/guides/opentelemetry) +provides: -The Quarkus can also be instrumented with the [OpenTelemetry Java agent](../agent) but only on JVM mode. +- Automatic instrumentation +- OpenTelemetry SDK autoconfiguration, supporting almost all system properties + 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) + +The Quarkus can also be instrumented with the +[OpenTelemetry Java agent](../agent) but only on JVM mode. diff --git a/content/en/docs/zero-code/java/quarkus/additional-documentation.md b/content/en/docs/zero-code/java/quarkus/additional-documentation.md index 43c7f8130bb0..359a34659e8f 100644 --- a/content/en/docs/zero-code/java/quarkus/additional-documentation.md +++ b/content/en/docs/zero-code/java/quarkus/additional-documentation.md @@ -3,9 +3,15 @@ title: Additional Documentation weight: 30 --- -The Quarkus documentation provides in-depth information on how to use Quarkus with OpenTelemetry. +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. +- [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. diff --git a/content/en/docs/zero-code/java/quarkus/getting-started.md b/content/en/docs/zero-code/java/quarkus/getting-started.md index fa0c6c395594..13114c65cb9b 100644 --- a/content/en/docs/zero-code/java/quarkus/getting-started.md +++ b/content/en/docs/zero-code/java/quarkus/getting-started.md @@ -3,14 +3,12 @@ title: Getting started with Quarkus weight: 20 --- +To enable OpenTelemetry in your Quarkus application, add the +`quarkus-opentelemetry` extension dependency to your project. +{{< tabpane >}} {{< tab header="Maven (`pom.xml`)" lang=Maven >}} -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 +````xml {{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}} @@ -19,7 +17,7 @@ To enable OpenTelemetry in your Quarkus application, add the `quarkus-openteleme io.quarkus quarkus-opentelemetry -``` +```` {{% /tab %}} {{% tab header="Gradle (`build.gradle`)" lang=Gradle %}} @@ -29,19 +27,24 @@ 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: +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). +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). {{% 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 [Java zero-code instrumentation](..). +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](..). {{% /alert %}} From 9b2f0cd73bc502f2a09501f928cbaa197d0d7bce Mon Sep 17 00:00:00 2001 From: brunobat Date: Sun, 2 Feb 2025 20:25:13 +0000 Subject: [PATCH 04/12] Address review comments --- content/en/docs/zero-code/java/_index.md | 4 ++-- content/en/docs/zero-code/java/quarkus/_index.md | 12 ++++++------ .../docs/zero-code/java/quarkus/getting-started.md | 9 ++------- 3 files changed, 10 insertions(+), 15 deletions(-) diff --git a/content/en/docs/zero-code/java/_index.md b/content/en/docs/zero-code/java/_index.md index bd2a0d74e923..3290cce95c11 100644 --- a/content/en/docs/zero-code/java/_index.md +++ b/content/en/docs/zero-code/java/_index.md @@ -10,6 +10,6 @@ cascade: otel: 1.47.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/). diff --git a/content/en/docs/zero-code/java/quarkus/_index.md b/content/en/docs/zero-code/java/quarkus/_index.md index 5a220cd9435a..0aa4f4705b66 100644 --- a/content/en/docs/zero-code/java/quarkus/_index.md +++ b/content/en/docs/zero-code/java/quarkus/_index.md @@ -1,23 +1,23 @@ --- -title: Quarkus +title: Quarkus instrumentation linkTitle: Quarkus --- [Quarkus](https://quarkus.io/) is an open source framework designed to help -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. Quarkus uses extensions to provide optimized support for a wide range of libraries. The [Quarkus OpenTelemetry extension](https://quarkus.io/guides/opentelemetry) provides: -- Automatic instrumentation +- Out of the box instrumentation - OpenTelemetry SDK autoconfiguration, supporting almost all system properties 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) +- The same instrumentations can be used with JVM and native image applications (where the OpenTelemetry Java agent doesn't work). The Quarkus can also be instrumented with the -[OpenTelemetry Java agent](../agent) but only on JVM mode. +[OpenTelemetry Java agent](../agent) but only with a JVM. diff --git a/content/en/docs/zero-code/java/quarkus/getting-started.md b/content/en/docs/zero-code/java/quarkus/getting-started.md index 13114c65cb9b..cdbef558b483 100644 --- a/content/en/docs/zero-code/java/quarkus/getting-started.md +++ b/content/en/docs/zero-code/java/quarkus/getting-started.md @@ -8,16 +8,12 @@ To enable OpenTelemetry in your Quarkus application, add the {{< tabpane >}} {{< tab header="Maven (`pom.xml`)" lang=Maven >}} -````xml - -{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}} - ```xml io.quarkus quarkus-opentelemetry -```` +``` {{% /tab %}} {{% tab header="Gradle (`build.gradle`)" lang=Gradle %}} @@ -44,7 +40,6 @@ The remaining configurations are available in the {{% 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 -[Java zero-code instrumentation](..). +application in a JVM. {{% /alert %}} From ad2db0c0883eef06196b5d1521c55b89afd5e54b Mon Sep 17 00:00:00 2001 From: brunobat Date: Mon, 3 Feb 2025 13:59:31 +0000 Subject: [PATCH 05/12] Address review comments and consolidate --- content/en/docs/zero-code/java/_index.md | 2 +- .../en/docs/zero-code/java/quarkus/_index.md | 68 +++++++++++++++++-- .../java/quarkus/additional-documentation.md | 17 ----- .../zero-code/java/quarkus/getting-started.md | 45 ------------ 4 files changed, 65 insertions(+), 67 deletions(-) delete mode 100644 content/en/docs/zero-code/java/quarkus/additional-documentation.md delete mode 100644 content/en/docs/zero-code/java/quarkus/getting-started.md diff --git a/content/en/docs/zero-code/java/_index.md b/content/en/docs/zero-code/java/_index.md index 3290cce95c11..54f15696a11e 100644 --- a/content/en/docs/zero-code/java/_index.md +++ b/content/en/docs/zero-code/java/_index.md @@ -11,5 +11,5 @@ cascade: --- 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 +Starter, or Quarkus. To learn how to manually instrument your service or app code, see [Manual instrumentation](/docs/languages/java/instrumentation/). diff --git a/content/en/docs/zero-code/java/quarkus/_index.md b/content/en/docs/zero-code/java/quarkus/_index.md index 0aa4f4705b66..034588bf6a6f 100644 --- a/content/en/docs/zero-code/java/quarkus/_index.md +++ b/content/en/docs/zero-code/java/quarkus/_index.md @@ -3,8 +3,10 @@ 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 +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 @@ -17,7 +19,65 @@ provides: defined for the [OpenTelemetry SDK](https://opentelemetry.io/docs/languages/java/configuration/) - [Vert.x](https://vertx.io/) based OTLP exporter -- The same instrumentations can be used with JVM and native image applications (where the OpenTelemetry Java agent doesn't work). +- The same instrumentations can be used with JVM and native image applications, where the OpenTelemetry Java agent doesn't work. + +Quarkus can also be instrumented with the +[OpenTelemetry Java agent](../agent/) but only with a JVM. + +## 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 + + io.quarkus + quarkus-opentelemetry + +``` + +{{% /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). + +{{% alert title="Note" color="info" %}} + +You can also use the [Java agent](../../agent) to instrument your Quarkus +application in a JVM. + +{{% /alert %}} + +## Additional Documentation + +The Quarkus documentation provides in-depth information on how to use Quarkus +with OpenTelemetry. -The Quarkus can also be instrumented with the -[OpenTelemetry Java agent](../agent) but only with a JVM. +- [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. diff --git a/content/en/docs/zero-code/java/quarkus/additional-documentation.md b/content/en/docs/zero-code/java/quarkus/additional-documentation.md deleted file mode 100644 index 359a34659e8f..000000000000 --- a/content/en/docs/zero-code/java/quarkus/additional-documentation.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Additional Documentation -weight: 30 ---- - -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. diff --git a/content/en/docs/zero-code/java/quarkus/getting-started.md b/content/en/docs/zero-code/java/quarkus/getting-started.md deleted file mode 100644 index cdbef558b483..000000000000 --- a/content/en/docs/zero-code/java/quarkus/getting-started.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Getting started with Quarkus -weight: 20 ---- - -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 - - io.quarkus - quarkus-opentelemetry - -``` - -{{% /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). - -{{% alert title="Note" color="info" %}} - -You can also use the [Java agent](../../agent) to instrument your Quarkus -application in a JVM. - -{{% /alert %}} From bd9c827ba8d68aaecd5d20dc9da984cb71abee5e Mon Sep 17 00:00:00 2001 From: brunobat Date: Tue, 4 Feb 2025 16:41:41 +0000 Subject: [PATCH 06/12] rename and move page --- content/en/docs/zero-code/java/{quarkus/_index.md => quarkus.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename content/en/docs/zero-code/java/{quarkus/_index.md => quarkus.md} (100%) diff --git a/content/en/docs/zero-code/java/quarkus/_index.md b/content/en/docs/zero-code/java/quarkus.md similarity index 100% rename from content/en/docs/zero-code/java/quarkus/_index.md rename to content/en/docs/zero-code/java/quarkus.md From 38ed8e9e8c356de39ebd2f1ef30c948841ef12a9 Mon Sep 17 00:00:00 2001 From: brunobat Date: Wed, 5 Feb 2025 11:49:04 +0000 Subject: [PATCH 07/12] Reviews and formatting --- content/en/docs/zero-code/java/_index.md | 4 ++-- content/en/docs/zero-code/java/quarkus.md | 16 +++++----------- 2 files changed, 7 insertions(+), 13 deletions(-) diff --git a/content/en/docs/zero-code/java/_index.md b/content/en/docs/zero-code/java/_index.md index 54f15696a11e..983d65c598cc 100644 --- a/content/en/docs/zero-code/java/_index.md +++ b/content/en/docs/zero-code/java/_index.md @@ -10,6 +10,6 @@ cascade: otel: 1.47.0 --- -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 +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/). diff --git a/content/en/docs/zero-code/java/quarkus.md b/content/en/docs/zero-code/java/quarkus.md index 034588bf6a6f..f109ff1467f9 100644 --- a/content/en/docs/zero-code/java/quarkus.md +++ b/content/en/docs/zero-code/java/quarkus.md @@ -17,12 +17,13 @@ provides: - Out of the box instrumentation - OpenTelemetry SDK autoconfiguration, supporting almost all system properties defined for the - [OpenTelemetry SDK](https://opentelemetry.io/docs/languages/java/configuration/) + [OpenTelemetry SDK](/docs/languages/java/configuration/) - [Vert.x](https://vertx.io/) based OTLP exporter -- The same instrumentations can be used with JVM and native image applications, where the OpenTelemetry Java agent doesn't work. +- 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/) but only with a JVM. +Quarkus can also be instrumented with the [OpenTelemetry Java agent](../agent/) +if you are not running a native image application. ## Getting started @@ -60,13 +61,6 @@ 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). -{{% alert title="Note" color="info" %}} - -You can also use the [Java agent](../../agent) to instrument your Quarkus -application in a JVM. - -{{% /alert %}} - ## Additional Documentation The Quarkus documentation provides in-depth information on how to use Quarkus From 2c60a56a730766e6695e61031c57fc5803e83e84 Mon Sep 17 00:00:00 2001 From: brunobat Date: Tue, 18 Feb 2025 11:20:19 +0000 Subject: [PATCH 08/12] Quarkus community support --- content/en/docs/zero-code/java/quarkus.md | 11 +++++++---- static/refcache.json | 24 +++++++++++++++++++++++ 2 files changed, 31 insertions(+), 4 deletions(-) diff --git a/content/en/docs/zero-code/java/quarkus.md b/content/en/docs/zero-code/java/quarkus.md index f109ff1467f9..4ac95ab73f7d 100644 --- a/content/en/docs/zero-code/java/quarkus.md +++ b/content/en/docs/zero-code/java/quarkus.md @@ -16,11 +16,14 @@ provides: - Out of the box instrumentation - OpenTelemetry SDK autoconfiguration, supporting almost all system properties - defined for the - [OpenTelemetry SDK](/docs/languages/java/configuration/) + 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. +- The same instrumentations can be used with native image applications, which + are not supported by the OpenTelemetry Java agent. + +> [!NOTE] Quarkus OpenTelemetry instrumentation is maintained and supported by +> Quarkus. For details, please check the +> [Quarkus community support page](https://quarkus.io/support/). Quarkus can also be instrumented with the [OpenTelemetry Java agent](../agent/) if you are not running a native image application. diff --git a/static/refcache.json b/static/refcache.json index 05f7c8eff683..24e2c0ea38da 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -15811,6 +15811,26 @@ "StatusCode": 206, "LastSeen": "2025-01-06T11:32:19.346196-05:00" }, + "https://quarkus.io/guides/opentelemetry#configuration-reference": { + "StatusCode": 206, + "LastSeen": "2025-02-05T16:11:20.963349Z" + }, + "https://quarkus.io/guides/opentelemetry-logging": { + "StatusCode": 206, + "LastSeen": "2025-02-05T16:11:25.084436Z" + }, + "https://quarkus.io/guides/opentelemetry-metrics": { + "StatusCode": 206, + "LastSeen": "2025-02-05T16:11:23.661159Z" + }, + "https://quarkus.io/guides/opentelemetry-tracing": { + "StatusCode": 206, + "LastSeen": "2025-02-05T16:11:22.258268Z" + }, + "https://quarkus.io/support/": { + "StatusCode": 206, + "LastSeen": "2025-02-18T11:15:32.834331Z" + }, "https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json": { "StatusCode": 206, "LastSeen": "2025-01-30T14:41:18.255078-05:00" @@ -16691,6 +16711,10 @@ "StatusCode": 206, "LastSeen": "2024-11-14T11:48:37.997877+01:00" }, + "https://vertx.io/": { + "StatusCode": 200, + "LastSeen": "2025-02-05T16:11:19.760497Z" + }, "https://vote.heliosvoting.org/helios/elections/176e7ca8-647d-11ef-9b9a-2a30e2a223da/view": { "StatusCode": 200, "LastSeen": "2024-09-02T11:59:00.266487+01:00" From fe491bfd0d2e89f2836470a14d41c9b784ad6474 Mon Sep 17 00:00:00 2001 From: brunobat Date: Tue, 18 Feb 2025 14:31:10 +0000 Subject: [PATCH 09/12] Address review comments --- content/en/docs/zero-code/java/_index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/en/docs/zero-code/java/_index.md b/content/en/docs/zero-code/java/_index.md index 983d65c598cc..1d590aee942d 100644 --- a/content/en/docs/zero-code/java/_index.md +++ b/content/en/docs/zero-code/java/_index.md @@ -10,6 +10,7 @@ cascade: otel: 1.47.0 --- -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 +Common options for zero-code instrumentation with Java are the Java agent JAR, +Spring Boot Starter, or the Quarkus OpenTelemetry Extension. To learn how to +manually instrument your service or app code, see [Manual instrumentation](/docs/languages/java/instrumentation/). From 94c0e5e01d3cb7f8c70e30645659060416b1213f Mon Sep 17 00:00:00 2001 From: brunobat Date: Tue, 18 Feb 2025 16:15:30 +0000 Subject: [PATCH 10/12] Address review comments --- content/en/docs/zero-code/java/_index.md | 2 +- content/en/docs/zero-code/java/quarkus.md | 41 +++++++++++------------ 2 files changed, 21 insertions(+), 22 deletions(-) diff --git a/content/en/docs/zero-code/java/_index.md b/content/en/docs/zero-code/java/_index.md index 1d590aee942d..eb4f3169ed6f 100644 --- a/content/en/docs/zero-code/java/_index.md +++ b/content/en/docs/zero-code/java/_index.md @@ -11,6 +11,6 @@ cascade: --- Common options for zero-code instrumentation with Java are the Java agent JAR, -Spring Boot Starter, or the Quarkus OpenTelemetry Extension. To learn how to +Spring Boot Starter, and the Quarkus OpenTelemetry Extension. To learn how to manually instrument your service or app code, see [Manual instrumentation](/docs/languages/java/instrumentation/). diff --git a/content/en/docs/zero-code/java/quarkus.md b/content/en/docs/zero-code/java/quarkus.md index 4ac95ab73f7d..fa87d605cfdf 100644 --- a/content/en/docs/zero-code/java/quarkus.md +++ b/content/en/docs/zero-code/java/quarkus.md @@ -3,8 +3,6 @@ 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. @@ -21,9 +19,12 @@ provides: - The same instrumentations can be used with native image applications, which are not supported by the OpenTelemetry Java agent. -> [!NOTE] Quarkus OpenTelemetry instrumentation is maintained and supported by -> Quarkus. For details, please check the -> [Quarkus community support page](https://quarkus.io/support/). +{{% alert-md title="Note" color="secondary" %}} + +Quarkus OpenTelemetry instrumentation is maintained and supported by Quarkus. +For details, see [Quarkus community support](https://quarkus.io/support/). + +{{% /alert-md %}} Quarkus can also be instrumented with the [OpenTelemetry Java agent](../agent/) if you are not running a native image application. @@ -33,7 +34,7 @@ if you are not running a native image application. To enable OpenTelemetry in your Quarkus application, add the `quarkus-opentelemetry` extension dependency to your project. -{{< tabpane >}} {{< tab header="Maven (`pom.xml`)" lang=Maven >}} +{{< tabpane >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}} ```xml @@ -50,31 +51,29 @@ 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: +Only the **tracing** signal is enabled by default. To enable **metrics** and +**logs**, 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. +OpenTelemetry logging is supported by Quarkus 3.16.0+. -The remaining configurations are available in the +For details concerning these and other configuration options, see [Quarkus OpenTelemetry configuration reference](https://quarkus.io/guides/opentelemetry#configuration-reference). -## Additional Documentation +## Learn more 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. +- [Using OpenTelemetry](https://quarkus.io/guides/opentelemetry), a general + reference covering all + [configuration](https://quarkus.io/guides/opentelemetry#configuration-reference) + options +- Signal-specific guides for + - [Tracing](https://quarkus.io/guides/opentelemetry-tracing) + - [Metrics](https://quarkus.io/guides/opentelemetry-metrics) + - [Logs](https://quarkus.io/guides/opentelemetry-logging) From 174ce5bc14c3a76cdde754c1452e453518db8e8d Mon Sep 17 00:00:00 2001 From: brunobat Date: Tue, 18 Feb 2025 16:34:32 +0000 Subject: [PATCH 11/12] Address review comments --- content/en/docs/zero-code/java/quarkus.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/en/docs/zero-code/java/quarkus.md b/content/en/docs/zero-code/java/quarkus.md index fa87d605cfdf..8b666d4069d0 100644 --- a/content/en/docs/zero-code/java/quarkus.md +++ b/content/en/docs/zero-code/java/quarkus.md @@ -62,13 +62,10 @@ quarkus.otel.logs.enabled=true OpenTelemetry logging is supported by Quarkus 3.16.0+. For details concerning these and other configuration options, see -[Quarkus OpenTelemetry configuration reference](https://quarkus.io/guides/opentelemetry#configuration-reference). +[OpenTelemetry configuration reference](https://quarkus.io/guides/opentelemetry#configuration-reference). ## Learn more -The Quarkus documentation provides in-depth information on how to use Quarkus -with OpenTelemetry. - - [Using OpenTelemetry](https://quarkus.io/guides/opentelemetry), a general reference covering all [configuration](https://quarkus.io/guides/opentelemetry#configuration-reference) From 8ec58a84f2f040fa899c36d0f731cceb6db36fc4 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 19 Feb 2025 10:34:47 -0500 Subject: [PATCH 12/12] Fix tabpane issue --- content/en/docs/zero-code/java/quarkus.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/zero-code/java/quarkus.md b/content/en/docs/zero-code/java/quarkus.md index 8b666d4069d0..8a6ca6407e15 100644 --- a/content/en/docs/zero-code/java/quarkus.md +++ b/content/en/docs/zero-code/java/quarkus.md @@ -34,7 +34,7 @@ if you are not running a native image application. To enable OpenTelemetry in your Quarkus application, add the `quarkus-opentelemetry` extension dependency to your project. -{{< tabpane >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}} +{{< tabpane text=true >}} {{% tab header="Maven (`pom.xml`)" lang=Maven %}} ```xml