Skip to content

Commit 89ee460

Browse files
committed
Sync documentation of main branch
1 parent 91246b9 commit 89ee460

File tree

8 files changed

+149
-6
lines changed

8 files changed

+149
-6
lines changed

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62705,6 +62705,27 @@ endif::add-copy-button-to-env-var[]
6270562705
|string
6270662706
|
6270762707

62708+
a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-driver-delegate]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-driver-delegate[`quarkus.quartz.driver-delegate`]##
62709+
62710+
[.description]
62711+
--
62712+
Allows users to specify fully qualified class name for a custom JDBC driver delegate.
62713+
62714+
This property is optional and leaving it empty will result in Quarkus automatically choosing appropriate default driver delegate implementation.
62715+
62716+
Note that any custom implementation has to be a subclass of existing Quarkus implementation such as `io.quarkus.quartz.runtime.jdbc.QuarkusPostgreSQLDelegate` or `io.quarkus.quartz.runtime.jdbc.QuarkusMSSQLDelegate`
62717+
62718+
62719+
ifdef::add-copy-button-to-env-var[]
62720+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_DRIVER_DELEGATE+++[]
62721+
endif::add-copy-button-to-env-var[]
62722+
ifndef::add-copy-button-to-env-var[]
62723+
Environment variable: `+++QUARKUS_QUARTZ_DRIVER_DELEGATE+++`
62724+
endif::add-copy-button-to-env-var[]
62725+
--
62726+
|string
62727+
|
62728+
6270862729
a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-serialize-job-data]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-serialize-job-data[`quarkus.quartz.serialize-job-data`]##
6270962730

6271062731
[.description]
@@ -62898,6 +62919,27 @@ endif::add-copy-button-to-env-var[]
6289862919
a|`smart-policy`, `ignore-misfire-policy`, `fire-now`, `simple-trigger-reschedule-now-with-existing-repeat-count`, `simple-trigger-reschedule-now-with-remaining-repeat-count`, `simple-trigger-reschedule-next-with-remaining-count`, `simple-trigger-reschedule-next-with-existing-count`, `cron-trigger-do-nothing`
6289962920
|`smart-policy`
6290062921

62922+
a| [[quarkus-quartz_quarkus-quartz-unsupported-properties-full-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-unsupported-properties-full-property-key[`quarkus.quartz.unsupported-properties."full-property-key"`]##
62923+
62924+
[.description]
62925+
--
62926+
Properties that should be passed on directly to Quartz. Use the full configuration property key here, for instance ``quarkus.quartz.unsupported-properties."org.quartz.scheduler.jmx.export" = true`)`.
62927+
62928+
Properties set here are completely unsupported: as Quarkus doesn't generally know about these properties and their purpose, there is absolutely no guarantee that they will work correctly, and even if they do, that may change when upgrading to a newer version of Quarkus (even just a micro/patch version).
62929+
62930+
Consider using a supported configuration property before falling back to unsupported ones. If none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus, and more importantly so that the configuration property is tested regularly.
62931+
62932+
62933+
ifdef::add-copy-button-to-env-var[]
62934+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_+++[]
62935+
endif::add-copy-button-to-env-var[]
62936+
ifndef::add-copy-button-to-env-var[]
62937+
Environment variable: `+++QUARKUS_QUARTZ_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_+++`
62938+
endif::add-copy-button-to-env-var[]
62939+
--
62940+
|Map<String,String>
62941+
|
62942+
6290162943
a| [[quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread[`quarkus.quartz.run-blocking-scheduled-method-on-quartz-thread`]##
6290262944

6290362945
[.description]

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,27 @@ endif::add-copy-button-to-env-var[]
129129
|string
130130
|
131131

132+
a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-driver-delegate]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-driver-delegate[`quarkus.quartz.driver-delegate`]##
133+
134+
[.description]
135+
--
136+
Allows users to specify fully qualified class name for a custom JDBC driver delegate.
137+
138+
This property is optional and leaving it empty will result in Quarkus automatically choosing appropriate default driver delegate implementation.
139+
140+
Note that any custom implementation has to be a subclass of existing Quarkus implementation such as `io.quarkus.quartz.runtime.jdbc.QuarkusPostgreSQLDelegate` or `io.quarkus.quartz.runtime.jdbc.QuarkusMSSQLDelegate`
141+
142+
143+
ifdef::add-copy-button-to-env-var[]
144+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_DRIVER_DELEGATE+++[]
145+
endif::add-copy-button-to-env-var[]
146+
ifndef::add-copy-button-to-env-var[]
147+
Environment variable: `+++QUARKUS_QUARTZ_DRIVER_DELEGATE+++`
148+
endif::add-copy-button-to-env-var[]
149+
--
150+
|string
151+
|
152+
132153
a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-serialize-job-data]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-serialize-job-data[`quarkus.quartz.serialize-job-data`]##
133154

134155
[.description]
@@ -322,6 +343,27 @@ endif::add-copy-button-to-env-var[]
322343
a|`smart-policy`, `ignore-misfire-policy`, `fire-now`, `simple-trigger-reschedule-now-with-existing-repeat-count`, `simple-trigger-reschedule-now-with-remaining-repeat-count`, `simple-trigger-reschedule-next-with-remaining-count`, `simple-trigger-reschedule-next-with-existing-count`, `cron-trigger-do-nothing`
323344
|`smart-policy`
324345

346+
a| [[quarkus-quartz_quarkus-quartz-unsupported-properties-full-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-unsupported-properties-full-property-key[`quarkus.quartz.unsupported-properties."full-property-key"`]##
347+
348+
[.description]
349+
--
350+
Properties that should be passed on directly to Quartz. Use the full configuration property key here, for instance ``quarkus.quartz.unsupported-properties."org.quartz.scheduler.jmx.export" = true`)`.
351+
352+
Properties set here are completely unsupported: as Quarkus doesn't generally know about these properties and their purpose, there is absolutely no guarantee that they will work correctly, and even if they do, that may change when upgrading to a newer version of Quarkus (even just a micro/patch version).
353+
354+
Consider using a supported configuration property before falling back to unsupported ones. If none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus, and more importantly so that the configuration property is tested regularly.
355+
356+
357+
ifdef::add-copy-button-to-env-var[]
358+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_+++[]
359+
endif::add-copy-button-to-env-var[]
360+
ifndef::add-copy-button-to-env-var[]
361+
Environment variable: `+++QUARKUS_QUARTZ_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_+++`
362+
endif::add-copy-button-to-env-var[]
363+
--
364+
|Map<String,String>
365+
|
366+
325367
a| [[quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread[`quarkus.quartz.run-blocking-scheduled-method-on-quartz-thread`]##
326368

327369
[.description]

_generated-doc/main/config/quarkus-quartz_quarkus.quartz.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,27 @@ endif::add-copy-button-to-env-var[]
129129
|string
130130
|
131131

132+
a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-driver-delegate]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-driver-delegate[`quarkus.quartz.driver-delegate`]##
133+
134+
[.description]
135+
--
136+
Allows users to specify fully qualified class name for a custom JDBC driver delegate.
137+
138+
This property is optional and leaving it empty will result in Quarkus automatically choosing appropriate default driver delegate implementation.
139+
140+
Note that any custom implementation has to be a subclass of existing Quarkus implementation such as `io.quarkus.quartz.runtime.jdbc.QuarkusPostgreSQLDelegate` or `io.quarkus.quartz.runtime.jdbc.QuarkusMSSQLDelegate`
141+
142+
143+
ifdef::add-copy-button-to-env-var[]
144+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_DRIVER_DELEGATE+++[]
145+
endif::add-copy-button-to-env-var[]
146+
ifndef::add-copy-button-to-env-var[]
147+
Environment variable: `+++QUARKUS_QUARTZ_DRIVER_DELEGATE+++`
148+
endif::add-copy-button-to-env-var[]
149+
--
150+
|string
151+
|
152+
132153
a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-serialize-job-data]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-serialize-job-data[`quarkus.quartz.serialize-job-data`]##
133154

134155
[.description]
@@ -322,6 +343,27 @@ endif::add-copy-button-to-env-var[]
322343
a|`smart-policy`, `ignore-misfire-policy`, `fire-now`, `simple-trigger-reschedule-now-with-existing-repeat-count`, `simple-trigger-reschedule-now-with-remaining-repeat-count`, `simple-trigger-reschedule-next-with-remaining-count`, `simple-trigger-reschedule-next-with-existing-count`, `cron-trigger-do-nothing`
323344
|`smart-policy`
324345

346+
a| [[quarkus-quartz_quarkus-quartz-unsupported-properties-full-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-unsupported-properties-full-property-key[`quarkus.quartz.unsupported-properties."full-property-key"`]##
347+
348+
[.description]
349+
--
350+
Properties that should be passed on directly to Quartz. Use the full configuration property key here, for instance ``quarkus.quartz.unsupported-properties."org.quartz.scheduler.jmx.export" = true`)`.
351+
352+
Properties set here are completely unsupported: as Quarkus doesn't generally know about these properties and their purpose, there is absolutely no guarantee that they will work correctly, and even if they do, that may change when upgrading to a newer version of Quarkus (even just a micro/patch version).
353+
354+
Consider using a supported configuration property before falling back to unsupported ones. If none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus, and more importantly so that the configuration property is tested regularly.
355+
356+
357+
ifdef::add-copy-button-to-env-var[]
358+
Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_+++[]
359+
endif::add-copy-button-to-env-var[]
360+
ifndef::add-copy-button-to-env-var[]
361+
Environment variable: `+++QUARKUS_QUARTZ_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_+++`
362+
endif::add-copy-button-to-env-var[]
363+
--
364+
|Map<String,String>
365+
|
366+
325367
a| [[quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread[`quarkus.quartz.run-blocking-scheduled-method-on-quartz-thread`]##
326368

327369
[.description]

_versions/main/guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
:logstash-image: docker.io/elastic/logstash:8.15.0
2020
:kibana-image: docker.io/elastic/kibana:8.15.0
2121
:keycloak-docker-image: quay.io/keycloak/keycloak:25.0.6
22-
:jandex-version: 3.2.2
22+
:jandex-version: 3.2.3
2323
:jandex-gradle-plugin-version: 1.0.0
2424
:kotlin-version: 2.0.21
2525
:grpc-version: 1.65.1

_versions/main/guides/aws-lambda-http.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,18 @@ NOTE: If you are building on a non-Linux system, you will need to also pass in a
8888
Lambda requires Linux binaries. You can do this by passing `-Dquarkus.native.container-build=true` to your build command.
8989
This requires you to have Docker installed locally, however.
9090

91+
[NOTE]
92+
====
93+
According to the https://docs.aws.amazon.com/linux/al2023/ug/system-requirements.html#system-requirements-cpu-x86-64[AWS documentation], AL2023
94+
x86-64 binaries are built for the x86-64-**v2** revision of the x86-64 architecture.
95+
In Quarkus, the default value of xref:building-native-image.adoc#quarkus-core_quarkus-native-march[quarkus.native.march] is x86-64-**v3**.
96+
This could cause
97+
https://repost.aws/questions/QUBVnl6hn-Toe1LPr1qjOXzg/lambda-failed-with-java-compiled-into-machine-code[issues] if AWS Lambda provisions older
98+
hardware.
99+
To maximize Lambda compatibility, you can set `quarkus.native.march` to `x86-64-v2`.
100+
See the xref:native-reference.adoc#work-around-missing-cpu-features[Native Reference] guide for more information.
101+
====
102+
91103
include::{includes}/devtools/build-native-container.adoc[]
92104

93105
== Extra Build Generated Files

_versions/main/guides/opentelemetry-logging.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
55
////
66
= Using OpenTelemetry Logging
77
include::_attributes.adoc[]
8+
:extension-status: preview
89
:categories: observability
910
:summary: This guide explains how your Quarkus application can utilize OpenTelemetry Logging to provide distributed logging for interactive web applications.
1011
:topics: observability,opentelemetry,logging
@@ -13,9 +14,11 @@ include::_attributes.adoc[]
1314
This guide explains how your Quarkus application can utilize https://opentelemetry.io/[OpenTelemetry] (OTel) to provide
1415
distributed logging for interactive web applications.
1516

17+
include::{includes}/extension-status.adoc[]
18+
1619
[NOTE]
1720
====
18-
- OpenTelemetry Logging is disabled by default.
21+
- OpenTelemetry Logging is considered _tech preview_ and is disabled by default.
1922
- The xref:opentelemetry.adoc[OpenTelemetry Guide] is available with signal independent information about the OpenTelemetry extension.
2023
====
2124

_versions/main/guides/opentelemetry-metrics.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
55
////
66
= Using OpenTelemetry Metrics
77
include::_attributes.adoc[]
8+
:extension-status: preview
89
:categories: observability
910
:summary: This guide explains how your Quarkus application can utilize OpenTelemetry to provide metrics for interactive web applications.
1011
:topics: observability,opentelemetry,metrics
@@ -13,9 +14,11 @@ include::_attributes.adoc[]
1314
This guide explains how your Quarkus application can utilize https://opentelemetry.io/[OpenTelemetry] (OTel) to provide
1415
metrics for interactive web applications.
1516

17+
include::{includes}/extension-status.adoc[]
18+
1619
[NOTE]
1720
====
18-
- OpenTelemetry Metrics is disabled by default and Quarkus does not produce automatic metrics for it.
21+
- OpenTelemetry Metrics is considered _tech preview_ and is disabled by default.
1922
- The xref:opentelemetry.adoc[OpenTelemetry Guide] is available with signal independent information about the OpenTelemetry extension.
2023
- If you search more information about OpenTelemetry Tracing, please refer to the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide].
2124
====

_versions/main/guides/opentelemetry.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,14 @@ On these page we show the signal independent features of the extension.
1818

1919
[NOTE]
2020
====
21-
- The old OpenTelemetry guide has been split into this generic guide, the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide] and the new xref:opentelemetry-metrics.adoc[OpenTelemetry Metrics Guide] has been created.
22-
- OpenTelemetry Logging is not yet supported.
21+
- The old OpenTelemetry guide has been split into this generic guide, the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide], the new xref:opentelemetry-metrics.adoc[OpenTelemetry Metrics Guide] and the xref:opentelemetry-logging.adoc[OpenTelemetry Logging Guide].
2322
- The use of *the https://opentelemetry.io/docs/instrumentation/java/automatic/[OpenTelemetry Agent] is not needed nor recommended*. Quarkus Extensions and the libraries they provide, are directly instrumented. That agent doesn't work with native mode.
2423
====
2524

2625
== Introduction
2726
https://opentelemetry.io/docs/what-is-opentelemetry/[OpenTelemetry] is an Observability framework and toolkit designed to create and manage telemetry data such as traces, metrics, and logs. Crucially, OpenTelemetry is vendor- and tool-agnostic.
2827

29-
Quarkus provides manual and automatic instrumentation for tracing and manual instrumentation capabilities for metrics.
28+
Quarkus provides manual and automatic instrumentation for tracing and manual instrumentation capabilities for metrics.
3029

3130
This will allow Quarkus based applications to be observable by tools and services supporting OpenTelemetry.
3231

0 commit comments

Comments
 (0)