Skip to content

Commit

Permalink
Merge pull request #43930 from brunobat/otel-docks-tech-preview
Browse files Browse the repository at this point in the history
Clarify tech preview status of OTel logs and metrics in docs
  • Loading branch information
gsmet authored Oct 25, 2024
2 parents 2b33f97 + fb3a997 commit e6dd03e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
5 changes: 4 additions & 1 deletion docs/src/main/asciidoc/opentelemetry-logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Using OpenTelemetry Logging
include::_attributes.adoc[]
:extension-status: preview
:categories: observability
:summary: This guide explains how your Quarkus application can utilize OpenTelemetry Logging to provide distributed logging for interactive web applications.
:topics: observability,opentelemetry,logging
Expand All @@ -13,9 +14,11 @@ include::_attributes.adoc[]
This guide explains how your Quarkus application can utilize https://opentelemetry.io/[OpenTelemetry] (OTel) to provide
distributed logging for interactive web applications.

include::{includes}/extension-status.adoc[]

[NOTE]
====
- OpenTelemetry Logging is disabled by default.
- OpenTelemetry Logging is considered _tech preview_ and is disabled by default.
- The xref:opentelemetry.adoc[OpenTelemetry Guide] is available with signal independent information about the OpenTelemetry extension.
====

Expand Down
5 changes: 4 additions & 1 deletion docs/src/main/asciidoc/opentelemetry-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Using OpenTelemetry Metrics
include::_attributes.adoc[]
:extension-status: preview
:categories: observability
:summary: This guide explains how your Quarkus application can utilize OpenTelemetry to provide metrics for interactive web applications.
:topics: observability,opentelemetry,metrics
Expand All @@ -13,9 +14,11 @@ include::_attributes.adoc[]
This guide explains how your Quarkus application can utilize https://opentelemetry.io/[OpenTelemetry] (OTel) to provide
metrics for interactive web applications.

include::{includes}/extension-status.adoc[]

[NOTE]
====
- OpenTelemetry Metrics is disabled by default and Quarkus does not produce automatic metrics for it.
- OpenTelemetry Metrics is considered _tech preview_ and is disabled by default.
- The xref:opentelemetry.adoc[OpenTelemetry Guide] is available with signal independent information about the OpenTelemetry extension.
- If you search more information about OpenTelemetry Tracing, please refer to the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide].
====
Expand Down
5 changes: 2 additions & 3 deletions docs/src/main/asciidoc/opentelemetry.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,14 @@ On these page we show the signal independent features of the extension.

[NOTE]
====
- The old OpenTelemetry guide has been split into this generic guide, the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide] and the new xref:opentelemetry-metrics.adoc[OpenTelemetry Metrics Guide] has been created.
- OpenTelemetry Logging is not yet supported.
- The old OpenTelemetry guide has been split into this generic guide, the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide], the new xref:opentelemetry-metrics.adoc[OpenTelemetry Metrics Guide] and the xref:opentelemetry-logging.adoc[OpenTelemetry Logging Guide].
- The use of *the https://opentelemetry.io/docs/instrumentation/java/automatic/[OpenTelemetry Agent] is not needed nor recommended*. Quarkus Extensions and the libraries they provide, are directly instrumented. That agent doesn't work with native mode.
====

== Introduction
https://opentelemetry.io/docs/what-is-opentelemetry/[OpenTelemetry] is an Observability framework and toolkit designed to create and manage telemetry data such as traces, metrics, and logs. Crucially, OpenTelemetry is vendor- and tool-agnostic.

Quarkus provides manual and automatic instrumentation for tracing and manual instrumentation capabilities for metrics.
Quarkus provides manual and automatic instrumentation for tracing and manual instrumentation capabilities for metrics.

This will allow Quarkus based applications to be observable by tools and services supporting OpenTelemetry.

Expand Down

0 comments on commit e6dd03e

Please sign in to comment.