Skip to content

Commit 120a3cf

Browse files
committed
Sync documentation of main branch
1 parent cedef7a commit 120a3cf

File tree

5 files changed

+116
-0
lines changed

5 files changed

+116
-0
lines changed

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76950,6 +76950,23 @@ endif::add-copy-button-to-env-var[]
7695076950
|int
7695176951
|`100`
7695276952

76953+
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`]##
76954+
76955+
[.description]
76956+
--
76957+
If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
76958+
76959+
76960+
ifdef::add-copy-button-to-env-var[]
76961+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++[]
76962+
endif::add-copy-button-to-env-var[]
76963+
ifndef::add-copy-button-to-env-var[]
76964+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++`
76965+
endif::add-copy-button-to-env-var[]
76966+
--
76967+
|boolean
76968+
|`true`
76969+
7695376970
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`]##
7695476971

7695576972
[.description]
@@ -77126,6 +77143,23 @@ endif::add-copy-button-to-env-var[]
7712677143
|int
7712777144
|`100`
7712877145

77146+
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`]##
77147+
77148+
[.description]
77149+
--
77150+
If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
77151+
77152+
77153+
ifdef::add-copy-button-to-env-var[]
77154+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++[]
77155+
endif::add-copy-button-to-env-var[]
77156+
ifndef::add-copy-button-to-env-var[]
77157+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++`
77158+
endif::add-copy-button-to-env-var[]
77159+
--
77160+
|boolean
77161+
|`true`
77162+
7712977163
|===
7713077164

7713177165
ifndef::no-duration-note[]

_generated-doc/main/config/quarkus-websockets-next.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,23 @@ endif::add-copy-button-to-env-var[]
172172
|int
173173
|`100`
174174

175+
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`]##
176+
177+
[.description]
178+
--
179+
If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
180+
181+
182+
ifdef::add-copy-button-to-env-var[]
183+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++[]
184+
endif::add-copy-button-to-env-var[]
185+
ifndef::add-copy-button-to-env-var[]
186+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++`
187+
endif::add-copy-button-to-env-var[]
188+
--
189+
|boolean
190+
|`true`
191+
175192
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`]##
176193

177194
[.description]
@@ -348,6 +365,23 @@ endif::add-copy-button-to-env-var[]
348365
|int
349366
|`100`
350367

368+
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`]##
369+
370+
[.description]
371+
--
372+
If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
373+
374+
375+
ifdef::add-copy-button-to-env-var[]
376+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++[]
377+
endif::add-copy-button-to-env-var[]
378+
ifndef::add-copy-button-to-env-var[]
379+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++`
380+
endif::add-copy-button-to-env-var[]
381+
--
382+
|boolean
383+
|`true`
384+
351385
|===
352386

353387
ifndef::no-duration-note[]

_generated-doc/main/config/quarkus-websockets-next_quarkus.websockets-next.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,23 @@ endif::add-copy-button-to-env-var[]
172172
|int
173173
|`100`
174174

175+
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`]##
176+
177+
[.description]
178+
--
179+
If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
180+
181+
182+
ifdef::add-copy-button-to-env-var[]
183+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++[]
184+
endif::add-copy-button-to-env-var[]
185+
ifndef::add-copy-button-to-env-var[]
186+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRACES_ENABLED+++`
187+
endif::add-copy-button-to-env-var[]
188+
--
189+
|boolean
190+
|`true`
191+
175192
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`]##
176193

177194
[.description]
@@ -348,6 +365,23 @@ endif::add-copy-button-to-env-var[]
348365
|int
349366
|`100`
350367

368+
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`]##
369+
370+
[.description]
371+
--
372+
If collection of WebSocket traces is enabled. Only applicable when the OpenTelemetry extension is present.
373+
374+
375+
ifdef::add-copy-button-to-env-var[]
376+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++[]
377+
endif::add-copy-button-to-env-var[]
378+
ifndef::add-copy-button-to-env-var[]
379+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_TRACES_ENABLED+++`
380+
endif::add-copy-button-to-env-var[]
381+
--
382+
|boolean
383+
|`true`
384+
351385
|===
352386

353387
ifndef::no-duration-note[]

_versions/main/guides/opentelemetry-tracing.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -573,6 +573,7 @@ See the main xref:opentelemetry.adoc#exporters[OpenTelemetry Guide exporters] se
573573
** Kafka
574574
** Pulsar
575575
* https://quarkus.io/guides/vertx[`quarkus-vertx`] (http requests)
576+
* xref:websockets-next-reference.adoc[`websockets-next`]
576577

577578

578579
=== Disable parts of the automatic tracing

_versions/main/guides/websockets-next-reference.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1131,6 +1131,19 @@ quarkus.log.category."io.quarkus.websockets.next.traffic".level=DEBUG <3>
11311131
<2> Set the number of characters of a text message payload which will be logged.
11321132
<3> Enable `DEBUG` level is for the logger `io.quarkus.websockets.next.traffic`.
11331133

1134+
[[telemetry]]
1135+
== Telemetry
1136+
1137+
When the OpenTelemetry extension is present, traces for opened and closed WebSocket connections are collected by default.
1138+
If you do not require WebSocket traces, you can disable collecting of traces like in the example below:
1139+
1140+
[source, properties]
1141+
----
1142+
quarkus.websockets-next.server.traces.enabled=false
1143+
quarkus.websockets-next.client.traces.enabled=false
1144+
----
1145+
1146+
NOTE: Telemetry for the `BasicWebSocketConnector` is currently not supported.
11341147

11351148
[[websocket-next-configuration-reference]]
11361149
== Configuration reference

0 commit comments

Comments
 (0)