Skip to content

Commit 5668fe9

Browse files
committed
Sync documentation of main branch
1 parent bd2658a commit 5668fe9

14 files changed

+264
-49
lines changed

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

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12010,7 +12010,7 @@ endif::add-copy-button-to-config-props[]
1201012010
--
1201112011
A map of roles for OIDC identity provider users.
1201212012

12013-
If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`.
12013+
If empty, default roles are assigned: user `alice` receives `admin` and `user` roles and user `bob` receives role `user`.
1201412014

1201512015

1201612016
ifdef::add-copy-button-to-env-var[]
@@ -63447,6 +63447,30 @@ endif::add-copy-button-to-env-var[]
6344763447
|boolean
6344863448
|`true`
6344963449

63450+
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-server-suppress4xx-errors]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-server-suppress4xx-errors[`quarkus.micrometer.binder.http-server.suppress4xx-errors`]##
63451+
ifdef::add-copy-button-to-config-props[]
63452+
config_property_copy_button:+++quarkus.micrometer.binder.http-server.suppress4xx-errors+++[]
63453+
endif::add-copy-button-to-config-props[]
63454+
63455+
63456+
[.description]
63457+
--
63458+
Suppress 4xx errors from metrics collection for unmatched templates.
63459+
This configuration exists to limit cardinality explosion from caller side error. Does not apply to 404 errors.
63460+
63461+
Suppressing 4xx errors is disabled by default.
63462+
63463+
63464+
ifdef::add-copy-button-to-env-var[]
63465+
Environment variable: env_var_with_copy_button:+++QUARKUS_MICROMETER_BINDER_HTTP_SERVER_SUPPRESS4XX_ERRORS+++[]
63466+
endif::add-copy-button-to-env-var[]
63467+
ifndef::add-copy-button-to-env-var[]
63468+
Environment variable: `+++QUARKUS_MICROMETER_BINDER_HTTP_SERVER_SUPPRESS4XX_ERRORS+++`
63469+
endif::add-copy-button-to-env-var[]
63470+
--
63471+
|boolean
63472+
|`false`
63473+
6345063474
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-server-max-uri-tags]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-server-max-uri-tags[`quarkus.micrometer.binder.http-server.max-uri-tags`]##
6345163475
ifdef::add-copy-button-to-config-props[]
6345263476
config_property_copy_button:+++quarkus.micrometer.binder.http-server.max-uri-tags+++[]
@@ -63548,6 +63572,30 @@ endif::add-copy-button-to-env-var[]
6354863572
|list of string
6354963573
|
6355063574

63575+
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-client-suppress4xx-errors]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-client-suppress4xx-errors[`quarkus.micrometer.binder.http-client.suppress4xx-errors`]##
63576+
ifdef::add-copy-button-to-config-props[]
63577+
config_property_copy_button:+++quarkus.micrometer.binder.http-client.suppress4xx-errors+++[]
63578+
endif::add-copy-button-to-config-props[]
63579+
63580+
63581+
[.description]
63582+
--
63583+
Suppress 4xx errors from metrics collection for unmatched templates.
63584+
This configuration exists to limit cardinality explosion from caller side errors. Does not apply to 404 errors.
63585+
63586+
Suppressing 4xx errors is disabled by default.
63587+
63588+
63589+
ifdef::add-copy-button-to-env-var[]
63590+
Environment variable: env_var_with_copy_button:+++QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_SUPPRESS4XX_ERRORS+++[]
63591+
endif::add-copy-button-to-env-var[]
63592+
ifndef::add-copy-button-to-env-var[]
63593+
Environment variable: `+++QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_SUPPRESS4XX_ERRORS+++`
63594+
endif::add-copy-button-to-env-var[]
63595+
--
63596+
|boolean
63597+
|`false`
63598+
6355163599
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-client-max-uri-tags]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-client-max-uri-tags[`quarkus.micrometer.binder.http-client.max-uri-tags`]##
6355263600
ifdef::add-copy-button-to-config-props[]
6355363601
config_property_copy_button:+++quarkus.micrometer.binder.http-client.max-uri-tags+++[]
@@ -65948,7 +65996,7 @@ Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_IMAGE_NAME+++`
6594865996
endif::add-copy-button-to-env-var[]
6594965997
--
6595065998
|string
65951-
|`docker.io/grafana/otel-lgtm:0.7.5`
65999+
|`docker.io/grafana/otel-lgtm:0.8.2`
6595266000

6595366001
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases[`quarkus.observability.lgtm.network-aliases`]##
6595466002
ifdef::add-copy-button-to-config-props[]

_generated-doc/main/config/quarkus-devservices-oidc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ endif::add-copy-button-to-config-props[]
3838
--
3939
A map of roles for OIDC identity provider users.
4040

41-
If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`.
41+
If empty, default roles are assigned: user `alice` receives `admin` and `user` roles and user `bob` receives role `user`.
4242

4343

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

_generated-doc/main/config/quarkus-devservices-oidc_quarkus.oidc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ endif::add-copy-button-to-config-props[]
3838
--
3939
A map of roles for OIDC identity provider users.
4040

41-
If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`.
41+
If empty, default roles are assigned: user `alice` receives `admin` and `user` roles and user `bob` receives role `user`.
4242

4343

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

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -674,6 +674,30 @@ endif::add-copy-button-to-env-var[]
674674
|boolean
675675
|`true`
676676

677+
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-server-suppress4xx-errors]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-server-suppress4xx-errors[`quarkus.micrometer.binder.http-server.suppress4xx-errors`]##
678+
ifdef::add-copy-button-to-config-props[]
679+
config_property_copy_button:+++quarkus.micrometer.binder.http-server.suppress4xx-errors+++[]
680+
endif::add-copy-button-to-config-props[]
681+
682+
683+
[.description]
684+
--
685+
Suppress 4xx errors from metrics collection for unmatched templates.
686+
This configuration exists to limit cardinality explosion from caller side error. Does not apply to 404 errors.
687+
688+
Suppressing 4xx errors is disabled by default.
689+
690+
691+
ifdef::add-copy-button-to-env-var[]
692+
Environment variable: env_var_with_copy_button:+++QUARKUS_MICROMETER_BINDER_HTTP_SERVER_SUPPRESS4XX_ERRORS+++[]
693+
endif::add-copy-button-to-env-var[]
694+
ifndef::add-copy-button-to-env-var[]
695+
Environment variable: `+++QUARKUS_MICROMETER_BINDER_HTTP_SERVER_SUPPRESS4XX_ERRORS+++`
696+
endif::add-copy-button-to-env-var[]
697+
--
698+
|boolean
699+
|`false`
700+
677701
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-server-max-uri-tags]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-server-max-uri-tags[`quarkus.micrometer.binder.http-server.max-uri-tags`]##
678702
ifdef::add-copy-button-to-config-props[]
679703
config_property_copy_button:+++quarkus.micrometer.binder.http-server.max-uri-tags+++[]
@@ -775,6 +799,30 @@ endif::add-copy-button-to-env-var[]
775799
|list of string
776800
|
777801

802+
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-client-suppress4xx-errors]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-client-suppress4xx-errors[`quarkus.micrometer.binder.http-client.suppress4xx-errors`]##
803+
ifdef::add-copy-button-to-config-props[]
804+
config_property_copy_button:+++quarkus.micrometer.binder.http-client.suppress4xx-errors+++[]
805+
endif::add-copy-button-to-config-props[]
806+
807+
808+
[.description]
809+
--
810+
Suppress 4xx errors from metrics collection for unmatched templates.
811+
This configuration exists to limit cardinality explosion from caller side errors. Does not apply to 404 errors.
812+
813+
Suppressing 4xx errors is disabled by default.
814+
815+
816+
ifdef::add-copy-button-to-env-var[]
817+
Environment variable: env_var_with_copy_button:+++QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_SUPPRESS4XX_ERRORS+++[]
818+
endif::add-copy-button-to-env-var[]
819+
ifndef::add-copy-button-to-env-var[]
820+
Environment variable: `+++QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_SUPPRESS4XX_ERRORS+++`
821+
endif::add-copy-button-to-env-var[]
822+
--
823+
|boolean
824+
|`false`
825+
778826
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-client-max-uri-tags]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-client-max-uri-tags[`quarkus.micrometer.binder.http-client.max-uri-tags`]##
779827
ifdef::add-copy-button-to-config-props[]
780828
config_property_copy_button:+++quarkus.micrometer.binder.http-client.max-uri-tags+++[]

_generated-doc/main/config/quarkus-micrometer_quarkus.micrometer.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -674,6 +674,30 @@ endif::add-copy-button-to-env-var[]
674674
|boolean
675675
|`true`
676676

677+
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-server-suppress4xx-errors]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-server-suppress4xx-errors[`quarkus.micrometer.binder.http-server.suppress4xx-errors`]##
678+
ifdef::add-copy-button-to-config-props[]
679+
config_property_copy_button:+++quarkus.micrometer.binder.http-server.suppress4xx-errors+++[]
680+
endif::add-copy-button-to-config-props[]
681+
682+
683+
[.description]
684+
--
685+
Suppress 4xx errors from metrics collection for unmatched templates.
686+
This configuration exists to limit cardinality explosion from caller side error. Does not apply to 404 errors.
687+
688+
Suppressing 4xx errors is disabled by default.
689+
690+
691+
ifdef::add-copy-button-to-env-var[]
692+
Environment variable: env_var_with_copy_button:+++QUARKUS_MICROMETER_BINDER_HTTP_SERVER_SUPPRESS4XX_ERRORS+++[]
693+
endif::add-copy-button-to-env-var[]
694+
ifndef::add-copy-button-to-env-var[]
695+
Environment variable: `+++QUARKUS_MICROMETER_BINDER_HTTP_SERVER_SUPPRESS4XX_ERRORS+++`
696+
endif::add-copy-button-to-env-var[]
697+
--
698+
|boolean
699+
|`false`
700+
677701
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-server-max-uri-tags]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-server-max-uri-tags[`quarkus.micrometer.binder.http-server.max-uri-tags`]##
678702
ifdef::add-copy-button-to-config-props[]
679703
config_property_copy_button:+++quarkus.micrometer.binder.http-server.max-uri-tags+++[]
@@ -775,6 +799,30 @@ endif::add-copy-button-to-env-var[]
775799
|list of string
776800
|
777801

802+
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-client-suppress4xx-errors]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-client-suppress4xx-errors[`quarkus.micrometer.binder.http-client.suppress4xx-errors`]##
803+
ifdef::add-copy-button-to-config-props[]
804+
config_property_copy_button:+++quarkus.micrometer.binder.http-client.suppress4xx-errors+++[]
805+
endif::add-copy-button-to-config-props[]
806+
807+
808+
[.description]
809+
--
810+
Suppress 4xx errors from metrics collection for unmatched templates.
811+
This configuration exists to limit cardinality explosion from caller side errors. Does not apply to 404 errors.
812+
813+
Suppressing 4xx errors is disabled by default.
814+
815+
816+
ifdef::add-copy-button-to-env-var[]
817+
Environment variable: env_var_with_copy_button:+++QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_SUPPRESS4XX_ERRORS+++[]
818+
endif::add-copy-button-to-env-var[]
819+
ifndef::add-copy-button-to-env-var[]
820+
Environment variable: `+++QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_SUPPRESS4XX_ERRORS+++`
821+
endif::add-copy-button-to-env-var[]
822+
--
823+
|boolean
824+
|`false`
825+
778826
a| [[quarkus-micrometer_quarkus-micrometer-binder-http-client-max-uri-tags]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-binder-http-client-max-uri-tags[`quarkus.micrometer.binder.http-client.max-uri-tags`]##
779827
ifdef::add-copy-button-to-config-props[]
780828
config_property_copy_button:+++quarkus.micrometer.binder.http-client.max-uri-tags+++[]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_IMAGE_NAME+++`
185185
endif::add-copy-button-to-env-var[]
186186
--
187187
|string
188-
|`docker.io/grafana/otel-lgtm:0.7.5`
188+
|`docker.io/grafana/otel-lgtm:0.8.2`
189189

190190
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases[`quarkus.observability.lgtm.network-aliases`]##
191191
ifdef::add-copy-button-to-config-props[]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_IMAGE_NAME+++`
185185
endif::add-copy-button-to-env-var[]
186186
--
187187
|string
188-
|`docker.io/grafana/otel-lgtm:0.7.5`
188+
|`docker.io/grafana/otel-lgtm:0.8.2`
189189

190190
a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases[`quarkus.observability.lgtm.network-aliases`]##
191191
ifdef::add-copy-button-to-config-props[]

_generated-doc/main/infra/quarkus-all-build-items.adoc

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2235,17 +2235,6 @@ _No Javadoc found_
22352235

22362236

22372237

2238-
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/RuntimeReinitializedClassBuildItem.java[`io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem`, window="_blank"]
2239-
[.description]
2240-
--
2241-
A class that will be reinitialized at runtime in native mode. This will result in the static initializer running twice.
2242-
-- a|`java.lang.String className`
2243-
2244-
_No Javadoc found_
2245-
2246-
2247-
2248-
22492238
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/sbom/SbomBuildItem.java[`io.quarkus.deployment.sbom.SbomBuildItem`, window="_blank"]
22502239
[.description]
22512240
--

_versions/main/guides/config-mappings.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,11 +233,11 @@ server.theHost=localhost
233233
server.thePort=8080
234234
----
235235

236-
The `@ConfigMapping` annotation support the following naming strategies:
236+
The `@ConfigMapping` annotation support the following naming strategies with the following enum values:
237237

238-
- `KEBAB_CASE` (default) - The method name is derived by replacing case changes with a dash to map the configuration property.
239-
- `VERBATIM` - The method name is used as is to map the configuration property.
240-
- `SNAKE_CASE` - The method name is derived by replacing case changes with an underscore to map the configuration property.
238+
- `KEBAB_CASE` (default) - The method name is derived by replacing case changes with a dash to map the configuration property, i.e. `theHost` maps to `the-host`.
239+
- `VERBATIM` - The method name is used as is to map the configuration property, i.e. `theHost` maps to `theHost`.
240+
- `SNAKE_CASE` - The method name is derived by replacing case changes with an underscore to map the configuration property, i.e. `theHost` maps to `the_host`.
241241

242242
=== Conversions
243243

_versions/main/guides/opentelemetry-tracing.adoc

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -526,6 +526,60 @@ public void tracedWork() {
526526
}
527527
----
528528

529+
=== Mutiny
530+
Methods returning reactive types can also be annotated with `@WithSpan` and `@AddingSpanAttributes` to create a new span or add attributes to the current span.
531+
532+
If you need to create spans manually within a mutiny pipeline, use `wrapWithSpan` method from `io.quarkus.opentelemetry.runtime.tracing.mutiny.MutinyTracingHelper`.
533+
534+
Example. Assuming you have the following pipeline:
535+
[source,java]
536+
----
537+
Uni<String> uni = Uni.createFrom().item("hello")
538+
//start trace here
539+
.onItem().transform(item -> item + " world")
540+
.onItem().transform(item -> item + "!")
541+
//end trace here
542+
.subscribe().with(
543+
item -> System.out.println("Received: " + item),
544+
failure -> System.out.println("Failed with " + failure)
545+
);
546+
----
547+
wrap it like this:
548+
[source,java]
549+
----
550+
import static io.quarkus.opentelemetry.runtime.tracing.mutiny.MutinyTracingHelper.wrapWithSpan;
551+
...
552+
@Inject
553+
Tracer tracer;
554+
...
555+
Context context = Context.current();
556+
Uni<String> uni = Uni.createFrom().item("hello")
557+
.transformToUni(m -> wrapWithSpan(tracer, Optional.of(context), "my-span-name",
558+
Uni.createFrom().item(m)
559+
.onItem().transform(item -> item + " world")
560+
.onItem().transform(item -> item + "!")
561+
))
562+
.subscribe().with(
563+
item -> System.out.println("Received: " + item),
564+
failure -> System.out.println("Failed with " + failure)
565+
);
566+
567+
----
568+
for multi-pipelines it works similarly:
569+
[source,java]
570+
----
571+
Multi.createFrom().items("Alice", "Bob", "Charlie")
572+
.transformToMultiAndConcatenate(m -> TracingHelper.withTrace("my-span-name",
573+
Multi.createFrom().item(m)
574+
.onItem().transform(name -> "Hello " + name)
575+
))
576+
.subscribe().with(
577+
item -> System.out.println("Received: " + item),
578+
failure -> System.out.println("Failed with " + failure)
579+
);
580+
----
581+
Instead of `transformToMultiAndConcatenate` you can use `transformToMultiAndMerge` if you don't care about the order of the items.
582+
529583
=== Quarkus Messaging - Kafka
530584

531585
When using the Quarkus Messaging extension for Kafka,

0 commit comments

Comments
 (0)