Sync documentation of main branch

quarkusio · Nov 2, 2024 · 120a3cf · 120a3cf
1 parent cedef7a
commit 120a3cf
Show file tree

Hide file tree

Showing 5 changed files with 116 additions and 0 deletions.
diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc
@@ -76950,6 +76950,23 @@ endif::add-copy-button-to-env-var[]
 |int
 |`100`
 
+a| [[quarkus-websockets-next_quarkus-websockets-next-client-traces-enabled]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-traces-enabled[`quarkus.websockets-next.client.traces.enabled`]##
+
+[.description]
+--
+If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 a| [[quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols[`quarkus.websockets-next.server.supported-subprotocols`]##
 
 [.description]
@@ -77126,6 +77143,23 @@ endif::add-copy-button-to-env-var[]
 |int
 |`100`
 
+a| [[quarkus-websockets-next_quarkus-websockets-next-server-traces-enabled]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-traces-enabled[`quarkus.websockets-next.server.traces.enabled`]##
+
+[.description]
+--
+If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 |===
 
 ifndef::no-duration-note[]

diff --git a/_generated-doc/main/config/quarkus-websockets-next.adoc b/_generated-doc/main/config/quarkus-websockets-next.adoc
@@ -172,6 +172,23 @@ endif::add-copy-button-to-env-var[]
 |int
 |`100`
 
+a| [[quarkus-websockets-next_quarkus-websockets-next-client-traces-enabled]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-traces-enabled[`quarkus.websockets-next.client.traces.enabled`]##
+
+[.description]
+--
+If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 a| [[quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols[`quarkus.websockets-next.server.supported-subprotocols`]##
 
 [.description]
@@ -348,6 +365,23 @@ endif::add-copy-button-to-env-var[]
 |int
 |`100`
 
+a| [[quarkus-websockets-next_quarkus-websockets-next-server-traces-enabled]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-traces-enabled[`quarkus.websockets-next.server.traces.enabled`]##
+
+[.description]
+--
+If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 |===
 
 ifndef::no-duration-note[]

diff --git a/_generated-doc/main/config/quarkus-websockets-next_quarkus.websockets-next.adoc b/_generated-doc/main/config/quarkus-websockets-next_quarkus.websockets-next.adoc
@@ -172,6 +172,23 @@ endif::add-copy-button-to-env-var[]
 |int
 |`100`
 
+a| [[quarkus-websockets-next_quarkus-websockets-next-client-traces-enabled]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-traces-enabled[`quarkus.websockets-next.client.traces.enabled`]##
+
+[.description]
+--
+If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 a| [[quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols[`quarkus.websockets-next.server.supported-subprotocols`]##
 
 [.description]
@@ -348,6 +365,23 @@ endif::add-copy-button-to-env-var[]
 |int
 |`100`
 
+a| [[quarkus-websockets-next_quarkus-websockets-next-server-traces-enabled]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-traces-enabled[`quarkus.websockets-next.server.traces.enabled`]##
+
+[.description]
+--
+If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
+
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++`
+endif::add-copy-button-to-env-var[]
+--
+|boolean
+|`true`
+
 |===
 
 ifndef::no-duration-note[]

diff --git a/_versions/main/guides/opentelemetry-tracing.adoc b/_versions/main/guides/opentelemetry-tracing.adoc
@@ -573,6 +573,7 @@ See the main xref:opentelemetry.adoc#exporters[OpenTelemetry Guide exporters] se
 ** Kafka
 ** Pulsar
 * https://quarkus.io/guides/vertx[`quarkus-vertx`] (http requests)
+* xref:websockets-next-reference.adoc[`websockets-next`]
 
 
 === Disable parts of the automatic tracing

diff --git a/_versions/main/guides/websockets-next-reference.adoc b/_versions/main/guides/websockets-next-reference.adoc
@@ -1131,6 +1131,19 @@ quarkus.log.category."io.quarkus.websockets.next.traffic".level=DEBUG <3>
 <2> Set the number of characters of a text message payload which will be logged.
 <3> Enable `DEBUG` level is for the logger `io.quarkus.websockets.next.traffic`.
 
+[[telemetry]]
+== Telemetry
+
+When the OpenTelemetry extension is present, traces for opened and closed WebSocket connections are collected by default.
+If you do not require WebSocket traces, you can disable collecting of traces like in the example below:
+
+[source, properties]
+----
+quarkus.websockets-next.server.traces.enabled=false
+quarkus.websockets-next.client.traces.enabled=false
+----
+
+NOTE: Telemetry for the `BasicWebSocketConnector` is currently not supported.
 
 [[websocket-next-configuration-reference]]
 == Configuration reference