From 3e18a286432ad472e2d36783701a6cc3b0cd993e Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 12 Nov 2024 01:53:40 +0000 Subject: [PATCH] Sync documentation of main branch --- .../main/config/quarkus-all-config.adoc | 19 +++++++++++++++++++ .../main/config/quarkus-opentelemetry.adoc | 19 +++++++++++++++++++ .../quarkus-opentelemetry_quarkus.otel.adoc | 19 +++++++++++++++++++ .../_includes/opentelemetry-config.adoc | 8 ++++++++ 4 files changed, 65 insertions(+) diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc index 6d25dc8d0f4..629364690d0 100644 --- a/_generated-doc/main/config/quarkus-all-config.adoc +++ b/_generated-doc/main/config/quarkus-all-config.adoc @@ -58982,6 +58982,25 @@ endif::add-copy-button-to-env-var[] |boolean |`true` +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-simple]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-simple[`quarkus.otel.simple`]## + +[.description] +-- +Should we use simple processor for spans and log records. This will disable batch processing and the exporter will send telemetry data right away. This is recommended for serverless applications. + +Defaults to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SIMPLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_SIMPLE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-exporter[`quarkus.otel.traces.exporter`]## [.description] diff --git a/_generated-doc/main/config/quarkus-opentelemetry.adoc b/_generated-doc/main/config/quarkus-opentelemetry.adoc index 7e32583f9d3..6fcc7ca857d 100644 --- a/_generated-doc/main/config/quarkus-opentelemetry.adoc +++ b/_generated-doc/main/config/quarkus-opentelemetry.adoc @@ -28,6 +28,25 @@ endif::add-copy-button-to-env-var[] |boolean |`true` +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-simple]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-simple[`quarkus.otel.simple`]## + +[.description] +-- +Should we use simple processor for spans and log records. This will disable batch processing and the exporter will send telemetry data right away. This is recommended for serverless applications. + +Defaults to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SIMPLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_SIMPLE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-exporter[`quarkus.otel.traces.exporter`]## [.description] diff --git a/_generated-doc/main/config/quarkus-opentelemetry_quarkus.otel.adoc b/_generated-doc/main/config/quarkus-opentelemetry_quarkus.otel.adoc index 7e32583f9d3..6fcc7ca857d 100644 --- a/_generated-doc/main/config/quarkus-opentelemetry_quarkus.otel.adoc +++ b/_generated-doc/main/config/quarkus-opentelemetry_quarkus.otel.adoc @@ -28,6 +28,25 @@ endif::add-copy-button-to-env-var[] |boolean |`true` +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-simple]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-simple[`quarkus.otel.simple`]## + +[.description] +-- +Should we use simple processor for spans and log records. This will disable batch processing and the exporter will send telemetry data right away. This is recommended for serverless applications. + +Defaults to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SIMPLE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_SIMPLE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-exporter[`quarkus.otel.traces.exporter`]## [.description] diff --git a/_versions/main/guides/_includes/opentelemetry-config.adoc b/_versions/main/guides/_includes/opentelemetry-config.adoc index cf4dcfff15f..8eb3b1ba481 100644 --- a/_versions/main/guides/_includes/opentelemetry-config.adoc +++ b/_versions/main/guides/_includes/opentelemetry-config.adoc @@ -34,3 +34,11 @@ quarkus.otel.exporter.otlp.logs.endpoint=http://logs-uri:4317 // <3> <1> The endpoint for the traces exporter. <2> The endpoint for the metrics exporter. <3> The endpoint for the logs exporter. + +If you need that your spans and logs to be exported directly as they finish +(e.g. in a serverless environment / application), you can set this property to `true`. +This replaces the default batching of data. +[source,properties] +---- +quarkus.otel.simple=true +----