Improvements to OTel logging docs

quarkusio · Feb 24, 2025 · 06ee70b · 06ee70b
1 parent 2fb6595
commit 06ee70b
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 10 deletions.
diff --git a/docs/src/main/asciidoc/opentelemetry.adoc b/docs/src/main/asciidoc/opentelemetry.adoc
@@ -144,6 +144,21 @@ If false will disable the default OTLP exporter at *build* time.
 |`quarkus.otel.metrics.exporter`
 |cdi
 |List of exporters to be used for metrics, separated by commas. Has one of the values from _ExporterType_: `otlp`, `cdi`, `none`. This is a *build* time property and setting it to `none` will disable metrics data output.
+
+| Logs
+|`quarkus.otel.logs.enabled`
+|false
+|Logs are disabled by default at *build* time because they are experimental.
+
+| Logs output
+|`quarkus.otel.logs.exporter`
+|cdi
+|List of exporters to be used for logs, separated by commas. Has one of the values from _ExporterType_: `otlp`, `cdi`, `none`. This is a *build* time property and setting it to `none` will disable logs data output.
+
+| Logs output
+|`quarkus.otel.logs.handler.enabled`
+|true
+|If false, disable the OpenTelemetry logs handler at *runtime*. This removes the bridge between the Quarkus logging system (JBoss LogManager) and OpenTelemetry logs.
 |===
 
 If you need to enable or disable the exporter at runtime, you can use the xref:opentelemetry-tracing.adoc#sampler[sampler] because it has the ability to filter out all the spans if needed.

diff --git a/...n/java/io/quarkus/opentelemetry/runtime/config/runtime/BatchLogRecordProcessorConfig.java b/...n/java/io/quarkus/opentelemetry/runtime/config/runtime/BatchLogRecordProcessorConfig.java
@@ -10,16 +10,16 @@
 public interface BatchLogRecordProcessorConfig {
 
     /**
-     * The interval, in milliseconds, between two consecutive exports.
+     * The Batch Log Record Processor interval {@link Duration} between two consecutive exports.
      * <p>
-     * Default is `1000`.
+     * Default is `1S`.
      */
     @WithName("schedule.delay")
     @WithDefault("1s")
     Duration scheduleDelay();
 
     /**
-     * The maximum queue size.
+     * The Batch Log Record Processor maximum queue size.
      * <p>
      * Default is `2048`.
      */
@@ -28,7 +28,7 @@ public interface BatchLogRecordProcessorConfig {
     Integer maxQueueSize();
 
     /**
-     * The maximum batch size.
+     * The Batch Log Record Processor maximum batch size.
      * <p>
      * Default is `512`.
      */
@@ -37,7 +37,7 @@ public interface BatchLogRecordProcessorConfig {
     Integer maxExportBatchSize();
 
     /**
-     * The maximum allowed time, in milliseconds, to export data.
+     * The Batch Log Record Processor maximum allowed time {@link Duration} to export data.
      * <p>
      * Default is `30s`.
      */

diff --git a/...c/main/java/io/quarkus/opentelemetry/runtime/config/runtime/BatchSpanProcessorConfig.java b/...c/main/java/io/quarkus/opentelemetry/runtime/config/runtime/BatchSpanProcessorConfig.java
@@ -10,16 +10,16 @@
 public interface BatchSpanProcessorConfig {
 
     /**
-     * The interval, in milliseconds, between two consecutive exports.
+     * The Batch Span Processor interval {@link Duration} between two consecutive exports.
      * <p>
-     * Default is `5000`.
+     * Default is `5s`.
      */
     @WithName("schedule.delay")
     @WithDefault("5s")
     Duration scheduleDelay();
 
     /**
-     * The maximum queue size.
+     * The Batch Span Processor maximum queue size.
      * <p>
      * Default is `2048`.
      */
@@ -28,7 +28,7 @@ public interface BatchSpanProcessorConfig {
     Integer maxQueueSize();
 
     /**
-     * The maximum batch size.
+     * The Batch Span Processor maximum batch size.
      * <p>
      * Default is `512`.
      */
@@ -37,7 +37,7 @@ public interface BatchSpanProcessorConfig {
     Integer maxExportBatchSize();
 
     /**
-     * The maximum allowed time, in milliseconds, to export data.
+     * The Batch Span Processor maximum allowed time {@link Duration} to export data.
      * <p>
      * Default is `30s`.
      */