Skip to content

Commit 3f32c4d

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent bca874c commit 3f32c4d

File tree

4 files changed

+149
-3
lines changed

4 files changed

+149
-3
lines changed

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

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67722,7 +67722,7 @@ Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_GRAFANA_PORT+++`
6772267722
endif::add-copy-button-to-env-var[]
6772367723
--
6772467724
|int
67725-
|`+++3000+++`
67725+
|
6772667726

6772767727
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-timeout]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-timeout[`quarkus.observability.lgtm.timeout`]##
6772867728
ifdef::add-copy-button-to-config-props[]
@@ -67892,6 +67892,48 @@ endif::add-copy-button-to-env-var[]
6789267892
|boolean
6789367893
|
6789467894

67895+
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otel-grpc-port]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otel-grpc-port[`quarkus.observability.lgtm.otel-grpc-port`]##
67896+
ifdef::add-copy-button-to-config-props[]
67897+
config_property_copy_button:+++quarkus.observability.lgtm.otel-grpc-port+++[]
67898+
endif::add-copy-button-to-config-props[]
67899+
67900+
67901+
[.description]
67902+
--
67903+
The gRPC port of the OTel container, if set it will be a fixed value.
67904+
67905+
67906+
ifdef::add-copy-button-to-env-var[]
67907+
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTEL_GRPC_PORT+++[]
67908+
endif::add-copy-button-to-env-var[]
67909+
ifndef::add-copy-button-to-env-var[]
67910+
Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTEL_GRPC_PORT+++`
67911+
endif::add-copy-button-to-env-var[]
67912+
--
67913+
|int
67914+
|
67915+
67916+
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otel-http-port]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otel-http-port[`quarkus.observability.lgtm.otel-http-port`]##
67917+
ifdef::add-copy-button-to-config-props[]
67918+
config_property_copy_button:+++quarkus.observability.lgtm.otel-http-port+++[]
67919+
endif::add-copy-button-to-config-props[]
67920+
67921+
67922+
[.description]
67923+
--
67924+
The HTTP port of the OTel container, if set it will be a fixed value.
67925+
67926+
67927+
ifdef::add-copy-button-to-env-var[]
67928+
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTEL_HTTP_PORT+++[]
67929+
endif::add-copy-button-to-env-var[]
67930+
ifndef::add-copy-button-to-env-var[]
67931+
Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTEL_HTTP_PORT+++`
67932+
endif::add-copy-button-to-env-var[]
67933+
--
67934+
|int
67935+
|
67936+
6789567937

6789667938
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-enabled]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-enabled[`quarkus.observability.enabled`]##
6789767939
ifdef::add-copy-button-to-config-props[]

‎_generated-doc/main/config/quarkus-observability-devservices.adoc‎

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_GRAFANA_PORT+++`
141141
endif::add-copy-button-to-env-var[]
142142
--
143143
|int
144-
|`+++3000+++`
144+
|
145145

146146
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-timeout]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-timeout[`quarkus.observability.lgtm.timeout`]##
147147
ifdef::add-copy-button-to-config-props[]
@@ -311,6 +311,48 @@ endif::add-copy-button-to-env-var[]
311311
|boolean
312312
|
313313

314+
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otel-grpc-port]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otel-grpc-port[`quarkus.observability.lgtm.otel-grpc-port`]##
315+
ifdef::add-copy-button-to-config-props[]
316+
config_property_copy_button:+++quarkus.observability.lgtm.otel-grpc-port+++[]
317+
endif::add-copy-button-to-config-props[]
318+
319+
320+
[.description]
321+
--
322+
The gRPC port of the OTel container, if set it will be a fixed value.
323+
324+
325+
ifdef::add-copy-button-to-env-var[]
326+
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTEL_GRPC_PORT+++[]
327+
endif::add-copy-button-to-env-var[]
328+
ifndef::add-copy-button-to-env-var[]
329+
Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTEL_GRPC_PORT+++`
330+
endif::add-copy-button-to-env-var[]
331+
--
332+
|int
333+
|
334+
335+
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otel-http-port]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otel-http-port[`quarkus.observability.lgtm.otel-http-port`]##
336+
ifdef::add-copy-button-to-config-props[]
337+
config_property_copy_button:+++quarkus.observability.lgtm.otel-http-port+++[]
338+
endif::add-copy-button-to-config-props[]
339+
340+
341+
[.description]
342+
--
343+
The HTTP port of the OTel container, if set it will be a fixed value.
344+
345+
346+
ifdef::add-copy-button-to-env-var[]
347+
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTEL_HTTP_PORT+++[]
348+
endif::add-copy-button-to-env-var[]
349+
ifndef::add-copy-button-to-env-var[]
350+
Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTEL_HTTP_PORT+++`
351+
endif::add-copy-button-to-env-var[]
352+
--
353+
|int
354+
|
355+
314356

315357
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-enabled]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-enabled[`quarkus.observability.enabled`]##
316358
ifdef::add-copy-button-to-config-props[]

‎_generated-doc/main/config/quarkus-observability-devservices_quarkus.observability.adoc‎

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_GRAFANA_PORT+++`
141141
endif::add-copy-button-to-env-var[]
142142
--
143143
|int
144-
|`+++3000+++`
144+
|
145145

146146
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-timeout]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-timeout[`quarkus.observability.lgtm.timeout`]##
147147
ifdef::add-copy-button-to-config-props[]
@@ -311,6 +311,48 @@ endif::add-copy-button-to-env-var[]
311311
|boolean
312312
|
313313

314+
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otel-grpc-port]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otel-grpc-port[`quarkus.observability.lgtm.otel-grpc-port`]##
315+
ifdef::add-copy-button-to-config-props[]
316+
config_property_copy_button:+++quarkus.observability.lgtm.otel-grpc-port+++[]
317+
endif::add-copy-button-to-config-props[]
318+
319+
320+
[.description]
321+
--
322+
The gRPC port of the OTel container, if set it will be a fixed value.
323+
324+
325+
ifdef::add-copy-button-to-env-var[]
326+
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTEL_GRPC_PORT+++[]
327+
endif::add-copy-button-to-env-var[]
328+
ifndef::add-copy-button-to-env-var[]
329+
Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTEL_GRPC_PORT+++`
330+
endif::add-copy-button-to-env-var[]
331+
--
332+
|int
333+
|
334+
335+
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otel-http-port]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otel-http-port[`quarkus.observability.lgtm.otel-http-port`]##
336+
ifdef::add-copy-button-to-config-props[]
337+
config_property_copy_button:+++quarkus.observability.lgtm.otel-http-port+++[]
338+
endif::add-copy-button-to-config-props[]
339+
340+
341+
[.description]
342+
--
343+
The HTTP port of the OTel container, if set it will be a fixed value.
344+
345+
346+
ifdef::add-copy-button-to-env-var[]
347+
Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTEL_HTTP_PORT+++[]
348+
endif::add-copy-button-to-env-var[]
349+
ifndef::add-copy-button-to-env-var[]
350+
Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTEL_HTTP_PORT+++`
351+
endif::add-copy-button-to-env-var[]
352+
--
353+
|int
354+
|
355+
314356

315357
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-enabled]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-enabled[`quarkus.observability.enabled`]##
316358
ifdef::add-copy-button-to-config-props[]

‎_versions/main/guides/observability-devservices-lgtm.adoc‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,12 @@ Each dashboard is tuned for the specific application setup. The available dashbo
185185
Some panels in the dashboards might take a few minutes to show accurate data when their values are calculated over a sliding time window.
186186
====
187187

188+
==== Custom dashboards
189+
190+
Users can add their own Grafana dashboards aka their configuration. All you need to do is to place a `grafana-dashboard-[your name].json` into a `META-INF/grafana` directory in your application, and LGTM DevResource will pick this up automatically, and include this dashboard configuration in the overall Grafana dashboards yaml configuration.
191+
192+
e.g. /META-INF/grafana/grafana-dashboard-my-simple-prometheus-dashboard.json configuration file creates `My Simple Promeheus Dashboard` titled dashboard
193+
188194
=== Additional configuration
189195

190196
This extension will configure your `quarkus-opentelemetry` and `quarkus-micrometer-registry-otlp` extensions to send data to the OTel Collector bundled with the Grafana OTel LGTM image.
@@ -197,6 +203,20 @@ quarkus.observability.enabled=false
197203
quarkus.observability.dev-resources=true
198204
----
199205

206+
By default Quarkus lets Testcontainers expose random ports for Grafana and OTel, but you can force the usage of user-side fixed ports via setting the ports yourself - but then be aware of port conflicts.
207+
208+
[source,properties]
209+
----
210+
quarkus.observability.lgtm.grafana-port=3001
211+
quarkus.observability.lgtm.otel-grpc-port=5317
212+
quarkus.observability.lgtm.otel-http-port=5318
213+
----
214+
215+
[NOTE]
216+
====
217+
Internal container ports stay the same; e.g. 3000 for Grafana, 4317 for OTel gRPC, 4318 for OTel HTTP, etc
218+
====
219+
200220
=== Tests
201221

202222
And for the least 'auto-magical' usage in the tests, simply disable both (Dev Resources are already disabled by default):

0 commit comments

Comments
 (0)