Skip to content

Commit 24640dd

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 67cadbd commit 24640dd

11 files changed

+103
-24
lines changed

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,32 @@ endif::add-copy-button-to-env-var[]
197197
|boolean
198198
|`+++false+++`
199199

200+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-jdbc-metrics-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-metrics-enabled[`quarkus.datasource.jdbc.metrics.enabled`]##
201+
ifdef::add-copy-button-to-config-props[]
202+
config_property_copy_button:+++quarkus.datasource.jdbc.metrics.enabled+++[]
203+
endif::add-copy-button-to-config-props[]
204+
205+
206+
`quarkus.datasource."datasource-name".jdbc.metrics.enabled`
207+
ifdef::add-copy-button-to-config-props[]
208+
config_property_copy_button:+++quarkus.datasource."datasource-name".jdbc.metrics.enabled+++[]
209+
endif::add-copy-button-to-config-props[]
210+
211+
[.description]
212+
--
213+
Enable metrics collection for this datasource.
214+
215+
216+
ifdef::add-copy-button-to-env-var[]
217+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_METRICS_ENABLED+++[]
218+
endif::add-copy-button-to-env-var[]
219+
ifndef::add-copy-button-to-env-var[]
220+
Environment variable: `+++QUARKUS_DATASOURCE_JDBC_METRICS_ENABLED+++`
221+
endif::add-copy-button-to-env-var[]
222+
--
223+
|boolean
224+
|`+++false+++`
225+
200226
a| [[quarkus-agroal_quarkus-datasource-jdbc-url]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-url[`quarkus.datasource.jdbc.url`]##
201227
ifdef::add-copy-button-to-config-props[]
202228
config_property_copy_button:+++quarkus.datasource.jdbc.url+++[]

‎_generated-doc/main/config/quarkus-agroal_quarkus.datasource.adoc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,32 @@ endif::add-copy-button-to-env-var[]
197197
|boolean
198198
|`+++false+++`
199199

200+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-jdbc-metrics-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-metrics-enabled[`quarkus.datasource.jdbc.metrics.enabled`]##
201+
ifdef::add-copy-button-to-config-props[]
202+
config_property_copy_button:+++quarkus.datasource.jdbc.metrics.enabled+++[]
203+
endif::add-copy-button-to-config-props[]
204+
205+
206+
`quarkus.datasource."datasource-name".jdbc.metrics.enabled`
207+
ifdef::add-copy-button-to-config-props[]
208+
config_property_copy_button:+++quarkus.datasource."datasource-name".jdbc.metrics.enabled+++[]
209+
endif::add-copy-button-to-config-props[]
210+
211+
[.description]
212+
--
213+
Enable metrics collection for this datasource.
214+
215+
216+
ifdef::add-copy-button-to-env-var[]
217+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_METRICS_ENABLED+++[]
218+
endif::add-copy-button-to-env-var[]
219+
ifndef::add-copy-button-to-env-var[]
220+
Environment variable: `+++QUARKUS_DATASOURCE_JDBC_METRICS_ENABLED+++`
221+
endif::add-copy-button-to-env-var[]
222+
--
223+
|boolean
224+
|`+++false+++`
225+
200226
a| [[quarkus-agroal_quarkus-datasource-jdbc-url]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-url[`quarkus.datasource.jdbc.url`]##
201227
ifdef::add-copy-button-to-config-props[]
202228
config_property_copy_button:+++quarkus.datasource.jdbc.url+++[]

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

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,32 @@ endif::add-copy-button-to-env-var[]
197197
|boolean
198198
|`+++false+++`
199199

200+
a|icon:lock[title=Fixed at build time] [[quarkus-agroal_quarkus-datasource-jdbc-metrics-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-metrics-enabled[`quarkus.datasource.jdbc.metrics.enabled`]##
201+
ifdef::add-copy-button-to-config-props[]
202+
config_property_copy_button:+++quarkus.datasource.jdbc.metrics.enabled+++[]
203+
endif::add-copy-button-to-config-props[]
204+
205+
206+
`quarkus.datasource."datasource-name".jdbc.metrics.enabled`
207+
ifdef::add-copy-button-to-config-props[]
208+
config_property_copy_button:+++quarkus.datasource."datasource-name".jdbc.metrics.enabled+++[]
209+
endif::add-copy-button-to-config-props[]
210+
211+
[.description]
212+
--
213+
Enable metrics collection for this datasource.
214+
215+
216+
ifdef::add-copy-button-to-env-var[]
217+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_METRICS_ENABLED+++[]
218+
endif::add-copy-button-to-env-var[]
219+
ifndef::add-copy-button-to-env-var[]
220+
Environment variable: `+++QUARKUS_DATASOURCE_JDBC_METRICS_ENABLED+++`
221+
endif::add-copy-button-to-env-var[]
222+
--
223+
|boolean
224+
|`+++false+++`
225+
200226
a| [[quarkus-agroal_quarkus-datasource-jdbc-url]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-url[`quarkus.datasource.jdbc.url`]##
201227
ifdef::add-copy-button-to-config-props[]
202228
config_property_copy_button:+++quarkus.datasource.jdbc.url+++[]
@@ -6435,7 +6461,7 @@ Environment variable: `+++QUARKUS_LOG_CONSOLE_FORMAT+++`
64356461
endif::add-copy-button-to-env-var[]
64366462
--
64376463
|string
6438-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
6464+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
64396465

64406466
a| [[quarkus-core_quarkus-log-console-level]] [.property-path]##link:#quarkus-core_quarkus-log-console-level[`quarkus.log.console.level`]##
64416467
ifdef::add-copy-button-to-config-props[]
@@ -7105,7 +7131,7 @@ Environment variable: `+++QUARKUS_LOG_SYSLOG_FORMAT+++`
71057131
endif::add-copy-button-to-env-var[]
71067132
--
71077133
|string
7108-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
7134+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
71097135

71107136
a| [[quarkus-core_quarkus-log-syslog-level]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-level[`quarkus.log.syslog.level`]##
71117137
ifdef::add-copy-button-to-config-props[]
@@ -7344,7 +7370,7 @@ Environment variable: `+++QUARKUS_LOG_SOCKET_FORMAT+++`
73447370
endif::add-copy-button-to-env-var[]
73457371
--
73467372
|string
7347-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
7373+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
73487374

73497375
a| [[quarkus-core_quarkus-log-socket-level]] [.property-path]##link:#quarkus-core_quarkus-log-socket-level[`quarkus.log.socket.level`]##
73507376
ifdef::add-copy-button-to-config-props[]
@@ -7517,7 +7543,7 @@ Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT+
75177543
endif::add-copy-button-to-env-var[]
75187544
--
75197545
|string
7520-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
7546+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
75217547

75227548
a| [[quarkus-core_quarkus-log-handler-console-console-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-level[`quarkus.log.handler.console."console-handlers".level`]##
75237549
ifdef::add-copy-button-to-config-props[]
@@ -8187,7 +8213,7 @@ Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT+++
81878213
endif::add-copy-button-to-env-var[]
81888214
--
81898215
|string
8190-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
8216+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
81918217

81928218
a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-level[`quarkus.log.handler.syslog."syslog-handlers".level`]##
81938219
ifdef::add-copy-button-to-config-props[]
@@ -8426,7 +8452,7 @@ Environment variable: `+++QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__FORMAT+++
84268452
endif::add-copy-button-to-env-var[]
84278453
--
84288454
|string
8429-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
8455+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
84308456

84318457
a| [[quarkus-core_quarkus-log-handler-socket-socket-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-socket-socket-handlers-level[`quarkus.log.handler.socket."socket-handlers".level`]##
84328458
ifdef::add-copy-button-to-config-props[]
@@ -11354,11 +11380,11 @@ endif::add-copy-button-to-config-props[]
1135411380

1135511381
[.description]
1135611382
--
11357-
Whether or not datasource metrics are published in case a metrics extension is present.
11383+
Whether datasource metrics are published in case a metrics extension is present.
1135811384

1135911385
This is a global setting and is not specific to a datasource.
1136011386

11361-
NOTE: This is different from the "jdbc.enable-metrics" property that needs to be set on the JDBC datasource level to enable collection of metrics for that datasource.
11387+
NOTE: This is different from the `quarkus.datasource."datasource name".jdbc.metrics.enabled` property that needs to be set on the JDBC datasource level to enable collection of metrics for that datasource.
1136211388

1136311389

1136411390
ifdef::add-copy-button-to-env-var[]

‎_generated-doc/main/config/quarkus-core_quarkus.log.adoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ Environment variable: `+++QUARKUS_LOG_CONSOLE_FORMAT+++`
283283
endif::add-copy-button-to-env-var[]
284284
--
285285
|string
286-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
286+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
287287

288288
a| [[quarkus-core_quarkus-log-console-level]] [.property-path]##link:#quarkus-core_quarkus-log-console-level[`quarkus.log.console.level`]##
289289
ifdef::add-copy-button-to-config-props[]
@@ -953,7 +953,7 @@ Environment variable: `+++QUARKUS_LOG_SYSLOG_FORMAT+++`
953953
endif::add-copy-button-to-env-var[]
954954
--
955955
|string
956-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
956+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
957957

958958
a| [[quarkus-core_quarkus-log-syslog-level]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-level[`quarkus.log.syslog.level`]##
959959
ifdef::add-copy-button-to-config-props[]
@@ -1192,7 +1192,7 @@ Environment variable: `+++QUARKUS_LOG_SOCKET_FORMAT+++`
11921192
endif::add-copy-button-to-env-var[]
11931193
--
11941194
|string
1195-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
1195+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
11961196

11971197
a| [[quarkus-core_quarkus-log-socket-level]] [.property-path]##link:#quarkus-core_quarkus-log-socket-level[`quarkus.log.socket.level`]##
11981198
ifdef::add-copy-button-to-config-props[]
@@ -1365,7 +1365,7 @@ Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT+
13651365
endif::add-copy-button-to-env-var[]
13661366
--
13671367
|string
1368-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
1368+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
13691369

13701370
a| [[quarkus-core_quarkus-log-handler-console-console-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-level[`quarkus.log.handler.console."console-handlers".level`]##
13711371
ifdef::add-copy-button-to-config-props[]
@@ -2035,7 +2035,7 @@ Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT+++
20352035
endif::add-copy-button-to-env-var[]
20362036
--
20372037
|string
2038-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
2038+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
20392039

20402040
a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-level[`quarkus.log.handler.syslog."syslog-handlers".level`]##
20412041
ifdef::add-copy-button-to-config-props[]
@@ -2274,7 +2274,7 @@ Environment variable: `+++QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__FORMAT+++
22742274
endif::add-copy-button-to-env-var[]
22752275
--
22762276
|string
2277-
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n+++`
2277+
|`+++%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n+++`
22782278

22792279
a| [[quarkus-core_quarkus-log-handler-socket-socket-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-socket-socket-handlers-level[`quarkus.log.handler.socket."socket-handlers".level`]##
22802280
ifdef::add-copy-button-to-config-props[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ endif::add-copy-button-to-config-props[]
3838

3939
[.description]
4040
--
41-
Whether or not datasource metrics are published in case a metrics extension is present.
41+
Whether datasource metrics are published in case a metrics extension is present.
4242

4343
This is a global setting and is not specific to a datasource.
4444

45-
NOTE: This is different from the "jdbc.enable-metrics" property that needs to be set on the JDBC datasource level to enable collection of metrics for that datasource.
45+
NOTE: This is different from the `quarkus.datasource."datasource name".jdbc.metrics.enabled` property that needs to be set on the JDBC datasource level to enable collection of metrics for that datasource.
4646

4747

4848
ifdef::add-copy-button-to-env-var[]

‎_generated-doc/main/config/quarkus-datasource_quarkus.datasource.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ endif::add-copy-button-to-config-props[]
3838

3939
[.description]
4040
--
41-
Whether or not datasource metrics are published in case a metrics extension is present.
41+
Whether datasource metrics are published in case a metrics extension is present.
4242

4343
This is a global setting and is not specific to a datasource.
4444

45-
NOTE: This is different from the "jdbc.enable-metrics" property that needs to be set on the JDBC datasource level to enable collection of metrics for that datasource.
45+
NOTE: This is different from the `quarkus.datasource."datasource name".jdbc.metrics.enabled` property that needs to be set on the JDBC datasource level to enable collection of metrics for that datasource.
4646

4747

4848
ifdef::add-copy-button-to-env-var[]

‎_versions/main/guides/_attributes.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
:keycloak-docker-image: quay.io/keycloak/keycloak:26.4.0
2222
:jandex-version: 3.5.1
2323
:jandex-gradle-plugin-version: 1.0.0
24-
:kotlin-version: 2.2.20
24+
:kotlin-version: 2.2.21
2525
:grpc-version: 1.75.0
2626
:protoc-version: 4.32.1
2727
:gcf-invoker-version: 1.4.1

‎_versions/main/guides/building-my-first-extension.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ Your extension is a multi-module project. So let's start by checking out the par
171171
<module>runtime</module>
172172
</modules>
173173
<properties>
174-
<compiler-plugin.version>3.14.0</compiler-plugin.version><!--2-->
174+
<compiler-plugin.version>3.14.1</compiler-plugin.version><!--2-->
175175
<failsafe-plugin.version>${surefire-plugin.version}</failsafe-plugin.version>
176176
<maven.compiler.release>17</maven.compiler.release>
177177
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -872,7 +872,7 @@ $ mvn quarkus:dev
872872
[INFO] Building greeting-app 1.0.0-SNAPSHOT
873873
[INFO] --------------------------------[ jar ]---------------------------------
874874
[INFO]
875-
[INFO] --- maven-compiler-plugin:3.14.0:compile (default-compile) @ greeting-app ---
875+
[INFO] --- maven-compiler-plugin:3.14.1:compile (default-compile) @ greeting-app ---
876876
[INFO] Nothing to compile - all classes are up to date
877877
[INFO]
878878
[INFO] --- quarkus-maven-plugin:{quarkus-version}:dev (default-cli) @ greeting-app ---

‎_versions/main/guides/cli-tooling.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,7 @@ Commands:
282282
image Build or push project container image.
283283
build Build a container image.
284284
docker Build a container image using Docker.
285+
podman Build a container image using Podman.
285286
buildpack Build a container image using Buildpack.
286287
jib Build a container image using Jib.
287288
openshift Build a container image using OpenShift.

‎_versions/main/guides/datasource.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -636,10 +636,10 @@ This can be activated by setting the `quarkus.datasource.metrics.enabled` proper
636636
For the exposed metrics to contain any actual values, a metric collection must be enabled internally by the Agroal mechanisms.
637637
By default, this metric collection mechanism is enabled for all datasources when a metrics extension is present, and metrics for the Agroal extension are enabled.
638638

639-
To disable metrics for a particular datasource, set `quarkus.datasource.jdbc.enable-metrics` to `false`, or apply `quarkus.datasource.<datasource name>.jdbc.enable-metrics` for a named datasource.
639+
To disable metrics for a particular datasource, set `quarkus.datasource.jdbc.metrics.enabled` to `false`, or apply `quarkus.datasource.<datasource name>.jdbc.metrics.enabled` for a named datasource.
640640
This disables collecting the metrics and exposing them in the `/q/metrics` endpoint if the mechanism to collect them is disabled.
641641

642-
Conversely, setting `quarkus.datasource.jdbc.enable-metrics` to `true`, or `quarkus.datasource.<datasource name>.jdbc.enable-metrics` for a named datasource explicitly enables metrics collection even if a metrics extension is not in use.
642+
Conversely, setting `quarkus.datasource.jdbc.metrics.enabled` to `true`, or `quarkus.datasource.<datasource name>.jdbc.metrics.enabled` for a named datasource explicitly enables metrics collection even if a metrics extension is not in use.
643643
This can be useful if you need to access the collected metrics programmatically.
644644
They are available after calling `dataSource.getMetrics()` on an injected `AgroalDataSource` instance.
645645

0 commit comments

Comments
 (0)