Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit5967f8e

Browse files
committed
Improvements on observability docs
1 parent1ee41b9 commit5967f8e

File tree

4 files changed

+35
-3
lines changed

4 files changed

+35
-3
lines changed

‎docs/src/main/asciidoc/observability.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ The xref:jfr.adoc[`quarkus-jfr`] extension can generate observability related ev
128128

129129
=== Metrics
130130

131-
Quarkus has been using Micrometer to collect metrics from the application for a long time. Almost all the out-of-the-box metrics instrumentation in Quarkus are implemented with Micrometer.
131+
Quarkus has been using Micrometer to collect metrics from the application for a long time. Almost all the out-of-the-box metrics instrumentation in Quarkus are implemented withthe xref:telemetry-micrometer.adoc[Micrometer] extension.
132132

133133
More recently, OpenTelemetry Metrics has become available in the xref:opentelemetry.adoc[`quarkus-opentelemetry`] extension, but it's disabled by default because metrics semantic conventions are not stable yet.
134134

‎docs/src/main/asciidoc/opentelemetry-metrics.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ include::{includes}/observability-include.adoc[]
2121
[NOTE]
2222
====
2323
- OpenTelemetry Metrics is considered _tech preview_ and is disabled by default.
24+
- Automatic metrics instrumentation in Quarkus is handled by xref:telemetry-micrometer.adoc[Micrometer] and the xref:telemetry-micrometer-to-opentelemetry.adoc[quarkus-micrometer-opentelemetry] extension bridges those metrics into OpenTelemetry.
2425
- The xref:opentelemetry.adoc[OpenTelemetry Guide] is available with signal independent information about the OpenTelemetry extension.
2526
- If you search more information about OpenTelemetry Tracing, please refer to the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide].
2627
====

‎docs/src/main/asciidoc/opentelemetry.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ This will allow Quarkus based applications to be observable by tools and service
3333

3434
[NOTE]
3535
====
36-
Automatic metrics instrumentation in Quarkus is done by the xref:telemetry-micrometer.adoc[Quarkus Micrometer extension]. We plan to provide, in the future, a bridge for those metrics to be available in OpenTelemetry as well.
36+
Automatic metrics instrumentation in Quarkus is done by the xref:telemetry-micrometer.adoc[Quarkus Micrometer extension].
37+
38+
The xref:telemetry-micrometer-to-opentelemetry.adoc[quarkus-micrometer-opentelemetry] extension enables the use and export of Micrometer metrics via OpenTelemetry.
3739
====
3840

3941
Quarkus supports the OpenTelemetry Autoconfiguration. The configurations match what you can see at

‎docs/src/main/asciidoc/telemetry-micrometer.adoc‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Quarkus extensions:
3434

3535
- micrometer
3636
- micrometer-registry-prometheus
37+
- micrometer-opentelemetry
3738

3839
link:https://github.com/quarkiverse/quarkus-micrometer-registry[Quarkiverse extensions] (may be incomplete):
3940

@@ -126,9 +127,37 @@ implementation("com.acme:custom-micrometer-registry")
126127
You will then need to specify your own provider to configure and initialize the
127128
MeterRegistry, as discussed in the next section.
128129

130+
=== Send Micrometer metrics through OpenTelemetry
131+
132+
The xref:telemetry-micrometer-to-opentelemetry.adoc[quarkus-micrometer-opentelemetry] extension allows to use the Micrometer API and all existing automatic instrumentation available in Quarkus while sending all the telemetry with OpenTelemetry.
133+
134+
This is achieved with a Micrometer registry implemented with the OpenTelemetry SDK, allowing integration of Micrometer Metrics, OpenTelemetry Traces and Logs into a unified telemetry output using the OTLP protocol.
135+
136+
If you already have your Quarkus project configured, you can add the `quarkus-micrometer-opentelemetry` extension to your project by running the following command in your project base directory:
137+
138+
:add-extension-extensions: micrometer-opentelemetry
139+
include::{includes}/devtools/extension-add.adoc[]
140+
141+
This will add the following to your build file:
142+
143+
[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
144+
.pom.xml
145+
----
146+
<dependency>
147+
<groupId>io.quarkus</groupId>
148+
<artifactId>quarkus-micrometer-opentelemetry</artifactId>
149+
</dependency>
150+
----
151+
152+
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
153+
.build.gradle
154+
----
155+
implementation("io.quarkus:quarkus-micrometer-opentelemetry")
156+
----
157+
129158
=== Create a customized MeterRegistry
130159

131-
Use a custom `@Produces` method to create and configureayour own `MeterRegistry` if you need to.
160+
Use a custom `@Produces` method to create and configure your own `MeterRegistry` if you need to.
132161

133162
The following example customizes the line format used for StatsD:
134163

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp