Skip to content

Commit ce0e554

Browse files
committed
Sync documentation of main branch
1 parent fe795bd commit ce0e554

File tree

8 files changed

+137
-16
lines changed

8 files changed

+137
-16
lines changed

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60859,6 +60859,40 @@ endif::add-copy-button-to-env-var[]
6085960859
|boolean
6086060860
|`true`
6086160861

60862+
a| [[quarkus-opentelemetry_quarkus-otel-instrument-jvm-metrics]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-jvm-metrics[`quarkus.otel.instrument.jvm-metrics`]##
60863+
60864+
[.description]
60865+
--
60866+
Enables instrumentation for JVM Metrics.
60867+
60868+
60869+
ifdef::add-copy-button-to-env-var[]
60870+
Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_JVM_METRICS+++[]
60871+
endif::add-copy-button-to-env-var[]
60872+
ifndef::add-copy-button-to-env-var[]
60873+
Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_JVM_METRICS+++`
60874+
endif::add-copy-button-to-env-var[]
60875+
--
60876+
|boolean
60877+
|`true`
60878+
60879+
a| [[quarkus-opentelemetry_quarkus-otel-instrument-http-server-metrics]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-http-server-metrics[`quarkus.otel.instrument.http-server-metrics`]##
60880+
60881+
[.description]
60882+
--
60883+
Enables instrumentation for HTTP Server Metrics.
60884+
60885+
60886+
ifdef::add-copy-button-to-env-var[]
60887+
Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_HTTP_SERVER_METRICS+++[]
60888+
endif::add-copy-button-to-env-var[]
60889+
ifndef::add-copy-button-to-env-var[]
60890+
Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_HTTP_SERVER_METRICS+++`
60891+
endif::add-copy-button-to-env-var[]
60892+
--
60893+
|boolean
60894+
|`true`
60895+
6086260896
a| [[quarkus-opentelemetry_quarkus-otel-mp-compatibility]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-mp-compatibility[`quarkus.otel.mp.compatibility`]##
6086360897

6086460898
[.description]

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -829,6 +829,40 @@ endif::add-copy-button-to-env-var[]
829829
|boolean
830830
|`true`
831831

832+
a| [[quarkus-opentelemetry_quarkus-otel-instrument-jvm-metrics]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-jvm-metrics[`quarkus.otel.instrument.jvm-metrics`]##
833+
834+
[.description]
835+
--
836+
Enables instrumentation for JVM Metrics.
837+
838+
839+
ifdef::add-copy-button-to-env-var[]
840+
Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_JVM_METRICS+++[]
841+
endif::add-copy-button-to-env-var[]
842+
ifndef::add-copy-button-to-env-var[]
843+
Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_JVM_METRICS+++`
844+
endif::add-copy-button-to-env-var[]
845+
--
846+
|boolean
847+
|`true`
848+
849+
a| [[quarkus-opentelemetry_quarkus-otel-instrument-http-server-metrics]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-http-server-metrics[`quarkus.otel.instrument.http-server-metrics`]##
850+
851+
[.description]
852+
--
853+
Enables instrumentation for HTTP Server Metrics.
854+
855+
856+
ifdef::add-copy-button-to-env-var[]
857+
Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_HTTP_SERVER_METRICS+++[]
858+
endif::add-copy-button-to-env-var[]
859+
ifndef::add-copy-button-to-env-var[]
860+
Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_HTTP_SERVER_METRICS+++`
861+
endif::add-copy-button-to-env-var[]
862+
--
863+
|boolean
864+
|`true`
865+
832866
a| [[quarkus-opentelemetry_quarkus-otel-mp-compatibility]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-mp-compatibility[`quarkus.otel.mp.compatibility`]##
833867

834868
[.description]

_generated-doc/main/config/quarkus-opentelemetry_quarkus.otel.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -829,6 +829,40 @@ endif::add-copy-button-to-env-var[]
829829
|boolean
830830
|`true`
831831

832+
a| [[quarkus-opentelemetry_quarkus-otel-instrument-jvm-metrics]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-jvm-metrics[`quarkus.otel.instrument.jvm-metrics`]##
833+
834+
[.description]
835+
--
836+
Enables instrumentation for JVM Metrics.
837+
838+
839+
ifdef::add-copy-button-to-env-var[]
840+
Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_JVM_METRICS+++[]
841+
endif::add-copy-button-to-env-var[]
842+
ifndef::add-copy-button-to-env-var[]
843+
Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_JVM_METRICS+++`
844+
endif::add-copy-button-to-env-var[]
845+
--
846+
|boolean
847+
|`true`
848+
849+
a| [[quarkus-opentelemetry_quarkus-otel-instrument-http-server-metrics]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-http-server-metrics[`quarkus.otel.instrument.http-server-metrics`]##
850+
851+
[.description]
852+
--
853+
Enables instrumentation for HTTP Server Metrics.
854+
855+
856+
ifdef::add-copy-button-to-env-var[]
857+
Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_HTTP_SERVER_METRICS+++[]
858+
endif::add-copy-button-to-env-var[]
859+
ifndef::add-copy-button-to-env-var[]
860+
Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_HTTP_SERVER_METRICS+++`
861+
endif::add-copy-button-to-env-var[]
862+
--
863+
|boolean
864+
|`true`
865+
832866
a| [[quarkus-opentelemetry_quarkus-otel-mp-compatibility]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-mp-compatibility[`quarkus.otel.mp.compatibility`]##
833867

834868
[.description]

_versions/main/guides/cdi.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -455,10 +455,15 @@ public class LargeTxAccount implements Account { <3>
455455
Account delegate; <4>
456456

457457
@Inject
458-
LogService logService; <5>
458+
@Decorated
459+
Bean<Account> delegateInfo; <5>
460+
461+
462+
@Inject
463+
LogService logService; <6>
459464

460465
void withdraw(BigDecimal amount) {
461-
delegate.withdraw(amount); <6>
466+
delegate.withdraw(amount); <7>
462467
if (amount.compareTo(1000) > 0) {
463468
logService.logWithdrawal(delegate, amount);
464469
}
@@ -470,8 +475,9 @@ public class LargeTxAccount implements Account { <3>
470475
<2> `@Decorator` marks a decorator component.
471476
<3> The set of decorated types includes all bean types which are Java interfaces, except for `java.io.Serializable`.
472477
<4> Each decorator must declare exactly one _delegate injection point_. The decorator applies to beans that are assignable to this delegate injection point.
473-
<5> Decorators can inject other beans.
474-
<6> The decorator may invoke any method of the delegate object. And the container invokes either the next decorator in the chain or the business method of the intercepted instance.
478+
<5> It is possible to obtain information about the decorated bean by using the `@Decorated` qualifier.
479+
<6> Decorators can inject other beans.
480+
<7> The decorator may invoke any method of the delegate object. And the container invokes either the next decorator in the chain or the business method of the intercepted instance.
475481
476482
NOTE: Instances of decorators are dependent objects of the bean instance they intercept, i.e. a new decorator instance is created for each intercepted bean.
477483

_versions/main/guides/datasource.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ endif::note-quarkus-derby[]
169169
+
170170
[NOTE]
171171
====
172-
You can use any JDBC driver in a Quarkus app in JVM mode as described in <<other-databases,Using other databases>>.
172+
You can use any JDBC driver in a Quarkus app in JVM mode as described in <<other-databases,Custom databases and drivers>>.
173173
However, using a non-built-in database kind is unlikely to work when compiling your application to a native executable.
174174
175175
For native executable builds, it is recommended to either use the available JDBC Quarkus extensions or contribute a custom extension for your specific driver.
@@ -217,7 +217,9 @@ Read <<in-memory-databases,Testing with in-memory databases>> for suggestions re
217217
* MySQL - `quarkus-jdbc-mysql`
218218
* Oracle - `quarkus-jdbc-oracle`
219219
* PostgreSQL - `quarkus-jdbc-postgresql`
220+
ifndef::no-quarkiverse[]
220221
* Other JDBC extensions, such as link:https://github.com/quarkiverse/quarkus-jdbc-sqlite[SQLite] and its link:https://docs.quarkiverse.io/quarkus-jdbc-sqlite/dev/index.html[documentation], can be found in the https://github.com/quarkiverse[Quarkiverse].
222+
ifndef::no-quarkiverse[]
221223
+
222224
For example, to add the PostgreSQL driver dependency:
223225
+
@@ -567,7 +569,7 @@ If your transaction involves non-datasource resources, be aware that they might
567569

568570
If XA cannot be enabled for one of your datasources:
569571

570-
* Be aware that enabling XA for all datasources _except one_ (and only one) is still supported through https://www.narayana.io/docs/project/index.html#d5e857[Last Resource Commit Optimization (LRCO)].
572+
* Be aware that enabling XA for all datasources _except one_ (and only one) is still supported through link:https://www.narayana.io/docs/project/index.html#_last_resource_commit_optimization_lrco[Last Resource Commit Optimization (LRCO)].
571573
* If you do not need a rollback for one datasource to trigger a rollback for other datasources, consider splitting your code into multiple transactions.
572574
To do so, use xref:transaction.adoc#programmatic-approach[`QuarkusTransaction.requiringNew()`]/xref:transaction.adoc#declarative-approach[`@Transactional(REQUIRES_NEW)`] (preferably) or xref:transaction.adoc#legacy-api-approach[`UserTransaction`] (for more complex use cases).
573575

_versions/main/guides/kotlin.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -301,9 +301,11 @@ allOpen { // <2>
301301
annotation("io.quarkus.test.junit.QuarkusTest")
302302
}
303303
304-
tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
305-
kotlinOptions.jvmTarget = JavaVersion.VERSION_11.toString()
306-
kotlinOptions.javaParameters = true
304+
kotlin {
305+
compilerOptions {
306+
jvmTarget = org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_21
307+
javaParameters = true
308+
}
307309
}
308310
309311
----

_versions/main/guides/opentelemetry-metrics.adoc

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -529,9 +529,23 @@ We only show 1 of 3 exemplars for brevity.
529529
=== Resource
530530
See the main xref:opentelemetry.adoc#resource[OpenTelemetry Guide resources] section.
531531

532-
== Additional instrumentation
532+
== Automatic instrumentation
533+
534+
We provide automatic instrumentation for JVM metrics and HTTP server requests metrics according to the https://github.com/eclipse/microprofile-telemetry/blob/2.0/spec/src/main/asciidoc/metrics.adoc[Microprofile Metrics 2.0 specification].
535+
536+
These metrics can be disabled by setting the following properties to `false`:
537+
538+
[source,properties]
539+
----
540+
quarkus.otel.instrument.jvm-metrics=false
541+
quarkus.otel.instrument.http-server-metrics=false
542+
----
543+
544+
[NOTE]
545+
====
546+
- It is recommended to disable these instrumentations if you are using the Micrometer extension as well.
547+
====
533548

534-
Automatic metrics are not yet provided by the Quarkus OpenTelemetry extension.
535549
We plan to bridge the existing Quarkus Micrometer extension metrics to OpenTelemetry in the future.
536550

537551
== Exporters

_versions/main/guides/opentelemetry.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,6 @@ quarkus.otel.metrics.enabled=true
5858
----
5959
At build time on your `application.properties` file.
6060

61-
==== Manual instrumentation only
62-
For now only manual instrumentation is supported. You can use the OpenTelemetry API to create and record metrics but Quarkus is not yet providing automatic instrumentation for metrics.
63-
64-
In the future, we plan to bridge current Micrometer metrics to OpenTelemetry and maintain compatibility when possible.
65-
6661
=== xref:opentelemetry-logging.adoc[OpenTelemetry Logging Guide]
6762

6863
==== Enable Logs

0 commit comments

Comments
 (0)