Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Apr 20, 2024
1 parent 1f74508 commit 0437c2c
Show file tree
Hide file tree
Showing 15 changed files with 798 additions and 53 deletions.
22 changes: 22 additions & 0 deletions _data/versioned/main/index/quarkus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1845,6 +1845,28 @@ types:
- io.quarkus:quarkus-narayana-lra
type: guide
url: /guides/lra
- title: Observability Dev Services
filename: observability-devservices.adoc
summary: Entry point for Observability DevServices
categories: observability
topics:
- observability
- grafana
- lgtm
- prometheus
- victoriametrics
- jaeger
- otel
- otlp
extensions:
- io.quarkus:quarkus-observability-devservices
type: guide
url: /guides/observability-devservices
- title: Observability Dev Services with Grafana OTel LGTM
filename: observability-devservices-lgtm.adoc
summary: "OTel-LGTM is all-in-one Docker image containing OpenTelemetry’s OTLP as the protocol to transport metrics, tracing and logging data to an OpenTelemetry Collector which then stores signals data into Prometheus (metrics), Tempo (traces) and Loki (logs), only to have it visualized by Grafana."
type: guide
url: /guides/observability-devservices-lgtm
- title: Packaging And Releasing With JReleaser
filename: jreleaser.adoc
summary: This guide covers packaging and releasing CLI applications using the JReleaser tool.
Expand Down
74 changes: 74 additions & 0 deletions _data/versioned/main/index/relations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1561,6 +1561,10 @@
url: /guides/telemetry-opentracing-to-otel-tutorial
type: tutorial
matches: 1
- title: Observability Dev Services
url: /guides/observability-devservices
type: guide
matches: 1
- title: SmallRye Health
url: /guides/smallrye-health
type: guide
Expand Down Expand Up @@ -9005,6 +9009,10 @@
url: /guides/telemetry-opentracing-to-otel-tutorial
type: tutorial
matches: 1
- title: Observability Dev Services
url: /guides/observability-devservices
type: guide
matches: 1
- title: SmallRye Health
url: /guides/smallrye-health
type: guide
Expand Down Expand Up @@ -9179,6 +9187,10 @@
url: /guides/telemetry-opentracing-to-otel-tutorial
type: tutorial
matches: 1
- title: Observability Dev Services
url: /guides/observability-devservices
type: guide
matches: 1
- title: SmallRye Health
url: /guides/smallrye-health
type: guide
Expand Down Expand Up @@ -9840,6 +9852,44 @@
url: /guides/native-and-ssl
type: guide
matches: 1
/guides/observability-devservices:
sameTopics:
- title: Collect metrics using Micrometer
url: /guides/telemetry-micrometer-tutorial
type: tutorial
matches: 2
- title: "Centralized log management (Graylog, Logstash, Fluentd)"
url: /guides/centralized-log-management
type: guide
matches: 1
- title: Logging configuration
url: /guides/logging
type: reference
matches: 1
- title: Management interface reference
url: /guides/management-interface-reference
type: reference
matches: 1
- title: Micrometer Metrics
url: /guides/telemetry-micrometer
type: reference
matches: 1
- title: Migrate from OpenTracing to OpenTelemetry tracing
url: /guides/telemetry-opentracing-to-otel-tutorial
type: tutorial
matches: 1
- title: SmallRye Health
url: /guides/smallrye-health
type: guide
matches: 1
- title: SmallRye Metrics
url: /guides/smallrye-metrics
type: guide
matches: 1
- title: Using OpenTelemetry
url: /guides/opentelemetry
type: guide
matches: 1
/guides/openapi-swaggerui:
sameTopics:
- title: Authorization of web endpoints
Expand Down Expand Up @@ -9920,6 +9970,10 @@
url: /guides/telemetry-micrometer
type: reference
matches: 1
- title: Observability Dev Services
url: /guides/observability-devservices
type: guide
matches: 1
- title: SmallRye Health
url: /guides/smallrye-health
type: guide
Expand Down Expand Up @@ -17797,6 +17851,10 @@
url: /guides/telemetry-opentracing-to-otel-tutorial
type: tutorial
matches: 1
- title: Observability Dev Services
url: /guides/observability-devservices
type: guide
matches: 1
- title: SmallRye Metrics
url: /guides/smallrye-metrics
type: guide
Expand Down Expand Up @@ -17831,6 +17889,10 @@
url: /guides/telemetry-opentracing-to-otel-tutorial
type: tutorial
matches: 1
- title: Observability Dev Services
url: /guides/observability-devservices
type: guide
matches: 1
- title: SmallRye Health
url: /guides/smallrye-health
type: guide
Expand Down Expand Up @@ -18906,6 +18968,10 @@
url: /guides/telemetry-opentracing-to-otel-tutorial
type: tutorial
matches: 1
- title: Observability Dev Services
url: /guides/observability-devservices
type: guide
matches: 1
- title: SmallRye Health
url: /guides/smallrye-health
type: guide
Expand All @@ -18929,6 +18995,10 @@
url: /guides/telemetry-micrometer
type: reference
matches: 2
- title: Observability Dev Services
url: /guides/observability-devservices
type: guide
matches: 2
- title: "Centralized log management (Graylog, Logstash, Fluentd)"
url: /guides/centralized-log-management
type: guide
Expand Down Expand Up @@ -18988,6 +19058,10 @@
url: /guides/telemetry-micrometer
type: reference
matches: 1
- title: Observability Dev Services
url: /guides/observability-devservices
type: guide
matches: 1
- title: SmallRye Health
url: /guides/smallrye-health
type: guide
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"configDocKey":{"type":"io.quarkus.observability.common.config.LgtmConfig","key":"quarkus.observability.lgtm","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"lgtm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.observability","since":null,"environmentVariable":"QUARKUS_OBSERVABILITY_LGTM","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.observability.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.\n\nWhen DevServices is enabled Quarkus will attempt to automatically configure and start a containers when running in Dev or Test mode and when Docker is running.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.observability","since":null,"environmentVariable":"QUARKUS_OBSERVABILITY_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.observability.dev-resources","additionalKeys":[],"configDoc":"Enable simplified usage of dev resources, instead of full observability processing. Make sure @code++{++enabled++}++ is set to false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"dev-resources","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.observability","since":null,"environmentVariable":"QUARKUS_OBSERVABILITY_DEV_RESOURCES","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.observability.parallel","additionalKeys":[],"configDoc":"Do we start the dev services in parallel.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"parallel","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.observability","since":null,"environmentVariable":"QUARKUS_OBSERVABILITY_PARALLEL","enum":false}}]
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"string","key":"quarkus.websockets-next.supported-subprotocols","additionalKeys":[],"configDoc":"See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol]","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"supported-subprotocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SUPPORTED_SUBPROTOCOLS","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.timeout","additionalKeys":[],"configDoc":"TODO Not implemented yet. The default timeout to complete processing of a message.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_TIMEOUT","enum":false}}]
[{"configDocKey":{"type":"string","key":"quarkus.websockets-next.supported-subprotocols","additionalKeys":[],"configDoc":"See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol]","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"supported-subprotocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SUPPORTED_SUBPROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.per-message-compression-supported","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"per-message-compression-supported","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_PER_MESSAGE_COMPRESSION_SUPPORTED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_MAX_MESSAGE_SIZE","enum":false}}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
io.quarkus.observability.runtime.config.ObservabilityConfiguration
120 changes: 114 additions & 6 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58067,6 +58067,79 @@ endif::add-copy-button-to-env-var[]
|`DEBUG`


h|[[quarkus-observability-devservices_quarkus-observability-devservices-quarkus-observability-dev-services-runtime]]link:#quarkus-observability-devservices_quarkus-observability-devservices-quarkus-observability-dev-services-runtime[Quarkus - Observability Dev Services - Runtime]

h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm]]`link:#quarkus-observability-devservices_quarkus-observability-lgtm[quarkus.observability.lgtm]`


[.description]
--
ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM+++`
endif::add-copy-button-to-env-var[]
--|LgtmConfig
|required icon:exclamation-circle[title=Configuration property is required]


a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-enabled]]`link:#quarkus-observability-devservices_quarkus-observability-enabled[quarkus.observability.enabled]`


[.description]
--
If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.

When DevServices is enabled Quarkus will attempt to automatically configure and start a containers when running in Dev or Test mode and when Docker is running.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OBSERVABILITY_ENABLED+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`true`


a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-dev-resources]]`link:#quarkus-observability-devservices_quarkus-observability-dev-resources[quarkus.observability.dev-resources]`


[.description]
--
Enable simplified usage of dev resources, instead of full observability processing. Make sure @code++{++enabled++}++ is set to false.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_DEV_RESOURCES+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OBSERVABILITY_DEV_RESOURCES+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-parallel]]`link:#quarkus-observability-devservices_quarkus-observability-parallel[quarkus.observability.parallel]`


[.description]
--
Do we start the dev services in parallel.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_PARALLEL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OBSERVABILITY_PARALLEL+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


h|[[quarkus-spring-boot-properties_quarkus-spring-boot-properties-quarkus-extension-for-spring-boot-properties]]link:#quarkus-spring-boot-properties_quarkus-spring-boot-properties-quarkus-extension-for-spring-boot-properties[Quarkus Extension for Spring Boot properties]

h|Type
Expand Down Expand Up @@ -69941,21 +70014,56 @@ endif::add-copy-button-to-env-var[]
|


a| [[quarkus-websockets-next_quarkus-websockets-next-timeout]]`link:#quarkus-websockets-next_quarkus-websockets-next-timeout[quarkus.websockets-next.timeout]`
a| [[quarkus-websockets-next_quarkus-websockets-next-per-message-compression-supported]]`link:#quarkus-websockets-next_quarkus-websockets-next-per-message-compression-supported[quarkus.websockets-next.per-message-compression-supported]`


[.description]
--
TODO Not implemented yet. The default timeout to complete processing of a message.
Compression Extensions for WebSocket are supported by default.

See also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_TIMEOUT+++[]
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_PER_MESSAGE_COMPRESSION_SUPPORTED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_TIMEOUT+++`
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_PER_MESSAGE_COMPRESSION_SUPPORTED+++`
endif::add-copy-button-to-env-var[]
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
--|boolean
|`true`


a| [[quarkus-websockets-next_quarkus-websockets-next-compression-level]]`link:#quarkus-websockets-next_quarkus-websockets-next-compression-level[quarkus.websockets-next.compression-level]`


[.description]
--
The compression level must be a value between 0 and 9. The default value is `HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_COMPRESSION_LEVEL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_COMPRESSION_LEVEL+++`
endif::add-copy-button-to-env-var[]
--|int
|


a| [[quarkus-websockets-next_quarkus-websockets-next-max-message-size]]`link:#quarkus-websockets-next_quarkus-websockets-next-max-message-size[quarkus.websockets-next.max-message-size]`


[.description]
--
The maximum size of a message in bytes. The default values is `HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_MAX_MESSAGE_SIZE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_MAX_MESSAGE_SIZE+++`
endif::add-copy-button-to-env-var[]
--|int
|


Expand Down
Loading

0 comments on commit 0437c2c

Please sign in to comment.