Skip to content

Commit 0ec0f12

Browse files
committed
Sync documentation of main branch
1 parent 81223d4 commit 0ec0f12

File tree

8 files changed

+45
-27
lines changed

8 files changed

+45
-27
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12120,7 +12120,7 @@ endif::add-copy-button-to-config-props[]
1212012120

1212112121
[.description]
1212212122
--
12123-
More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com (This can also be a regex) By default localhost and 127.0.0.1 will always be allowed
12123+
More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com (This can also be a regex, e.g.: ^(++[++A-Za-z0-9-++]++{plus}).apps.myhost.com) By default localhost and 127.0.0.1 will always be allowed Note: Wildcards are not supported (e.g.: ++*++.apps.myhost.com)
1212412124

1212512125

1212612126
ifdef::add-copy-button-to-env-var[]
@@ -61373,7 +61373,7 @@ ifndef::add-copy-button-to-env-var[]
6137361373
Environment variable: `+++QUARKUS_LOG_CONSOLE_JSON_LOG_FORMAT+++`
6137461374
endif::add-copy-button-to-env-var[]
6137561375
--
61376-
a|`default`, `ecs`
61376+
a|`default`, `ecs`, `gcp`
6137761377
|`+++default+++`
6137861378

6137961379

@@ -61632,7 +61632,7 @@ ifndef::add-copy-button-to-env-var[]
6163261632
Environment variable: `+++QUARKUS_LOG_FILE_JSON_LOG_FORMAT+++`
6163361633
endif::add-copy-button-to-env-var[]
6163461634
--
61635-
a|`default`, `ecs`
61635+
a|`default`, `ecs`, `gcp`
6163661636
|`+++default+++`
6163761637

6163861638

@@ -61891,7 +61891,7 @@ ifndef::add-copy-button-to-env-var[]
6189161891
Environment variable: `+++QUARKUS_LOG_SYSLOG_JSON_LOG_FORMAT+++`
6189261892
endif::add-copy-button-to-env-var[]
6189361893
--
61894-
a|`default`, `ecs`
61894+
a|`default`, `ecs`, `gcp`
6189561895
|`+++default+++`
6189661896

6189761897

@@ -62150,7 +62150,7 @@ ifndef::add-copy-button-to-env-var[]
6215062150
Environment variable: `+++QUARKUS_LOG_SOCKET_JSON_LOG_FORMAT+++`
6215162151
endif::add-copy-button-to-env-var[]
6215262152
--
62153-
a|`default`, `ecs`
62153+
a|`default`, `ecs`, `gcp`
6215462154
|`+++default+++`
6215562155

6215662156

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ endif::add-copy-button-to-config-props[]
7878

7979
[.description]
8080
--
81-
More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com (This can also be a regex) By default localhost and 127.0.0.1 will always be allowed
81+
More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com (This can also be a regex, e.g.: ^(++[++A-Za-z0-9-++]++{plus}).apps.myhost.com) By default localhost and 127.0.0.1 will always be allowed Note: Wildcards are not supported (e.g.: ++*++.apps.myhost.com)
8282

8383

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

_generated-doc/main/config/quarkus-devui_quarkus.dev-ui.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ endif::add-copy-button-to-config-props[]
7878

7979
[.description]
8080
--
81-
More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com (This can also be a regex) By default localhost and 127.0.0.1 will always be allowed
81+
More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com (This can also be a regex, e.g.: ^(++[++A-Za-z0-9-++]++{plus}).apps.myhost.com) By default localhost and 127.0.0.1 will always be allowed Note: Wildcards are not supported (e.g.: ++*++.apps.myhost.com)
8282

8383

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

_generated-doc/main/config/quarkus-logging-json.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ ifndef::add-copy-button-to-env-var[]
262262
Environment variable: `+++QUARKUS_LOG_CONSOLE_JSON_LOG_FORMAT+++`
263263
endif::add-copy-button-to-env-var[]
264264
--
265-
a|`default`, `ecs`
265+
a|`default`, `ecs`, `gcp`
266266
|`+++default+++`
267267

268268

@@ -521,7 +521,7 @@ ifndef::add-copy-button-to-env-var[]
521521
Environment variable: `+++QUARKUS_LOG_FILE_JSON_LOG_FORMAT+++`
522522
endif::add-copy-button-to-env-var[]
523523
--
524-
a|`default`, `ecs`
524+
a|`default`, `ecs`, `gcp`
525525
|`+++default+++`
526526

527527

@@ -780,7 +780,7 @@ ifndef::add-copy-button-to-env-var[]
780780
Environment variable: `+++QUARKUS_LOG_SYSLOG_JSON_LOG_FORMAT+++`
781781
endif::add-copy-button-to-env-var[]
782782
--
783-
a|`default`, `ecs`
783+
a|`default`, `ecs`, `gcp`
784784
|`+++default+++`
785785

786786

@@ -1039,7 +1039,7 @@ ifndef::add-copy-button-to-env-var[]
10391039
Environment variable: `+++QUARKUS_LOG_SOCKET_JSON_LOG_FORMAT+++`
10401040
endif::add-copy-button-to-env-var[]
10411041
--
1042-
a|`default`, `ecs`
1042+
a|`default`, `ecs`, `gcp`
10431043
|`+++default+++`
10441044

10451045

_generated-doc/main/config/quarkus-logging-json_quarkus.log.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ ifndef::add-copy-button-to-env-var[]
262262
Environment variable: `+++QUARKUS_LOG_CONSOLE_JSON_LOG_FORMAT+++`
263263
endif::add-copy-button-to-env-var[]
264264
--
265-
a|`default`, `ecs`
265+
a|`default`, `ecs`, `gcp`
266266
|`+++default+++`
267267

268268

@@ -521,7 +521,7 @@ ifndef::add-copy-button-to-env-var[]
521521
Environment variable: `+++QUARKUS_LOG_FILE_JSON_LOG_FORMAT+++`
522522
endif::add-copy-button-to-env-var[]
523523
--
524-
a|`default`, `ecs`
524+
a|`default`, `ecs`, `gcp`
525525
|`+++default+++`
526526

527527

@@ -780,7 +780,7 @@ ifndef::add-copy-button-to-env-var[]
780780
Environment variable: `+++QUARKUS_LOG_SYSLOG_JSON_LOG_FORMAT+++`
781781
endif::add-copy-button-to-env-var[]
782782
--
783-
a|`default`, `ecs`
783+
a|`default`, `ecs`, `gcp`
784784
|`+++default+++`
785785

786786

@@ -1039,7 +1039,7 @@ ifndef::add-copy-button-to-env-var[]
10391039
Environment variable: `+++QUARKUS_LOG_SOCKET_JSON_LOG_FORMAT+++`
10401040
endif::add-copy-button-to-env-var[]
10411041
--
1042-
a|`default`, `ecs`
1042+
a|`default`, `ecs`, `gcp`
10431043
|`+++default+++`
10441044

10451045

_versions/main/guides/logging.adoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,8 @@ Although the root logger's handlers are usually configured directly via `quarkus
363363

364364
== Logging format
365365

366+
=== Human-readable text
367+
366368
{project-name} uses a pattern-based logging formatter that generates human-readable text logs by default, but you can also configure the format for each log handler by using a dedicated property.
367369

368370
For the console handler, the property is `quarkus.log.console.format`.
@@ -399,14 +401,8 @@ The logging format string supports the following symbols:
399401
|%x|Nested Diagnostics context values|Renders all the values from Nested Diagnostics Context in format `{value1.value2}`.
400402
|===
401403

402-
403-
[id="alt-console-format"]
404-
=== Alternative console logging formats
405-
406-
Changing the console log format is useful, for example, when the console output of the Quarkus application is captured by a service that processes and stores the log information for later analysis.
407-
408404
[id="json-logging"]
409-
==== JSON logging format
405+
=== JSON logging format
410406

411407
The `quarkus-logging-json` extension might be employed to add support for the JSON logging format and its related configuration.
412408

@@ -441,7 +437,21 @@ This can be achieved using different profiles, as shown in the following configu
441437
%test.quarkus.log.console.json.enabled=false
442438
----
443439

444-
===== Configuration
440+
+
441+
. Choose the JSON logging format by setting the config property:
442+
[source, properties]
443+
----
444+
quarkus.log.console.json.log-format
445+
----
446+
This case will set the format for the console. The config values are:
447+
448+
* *default*: Will generate structured logging based on the `key,values` present in the log record. MDC and NDC data will be also included nested in `mdc` and `ndc` fields.
449+
* *ecs*: https://www.elastic.co/docs/reference/ecs/ecs-field-reference[Elastic Common Fields]. Some default fields names are modified and some otheres are added to better comply with ECS. Namely: `@timestamp`,`log.logger`, `log.level`, `process.pid`, `process.name`, `process.thread.name`, `process.thread.id`, `host.hostname`, `event.sequence`, `error.message`, `error.stack_trace`, `ecs.version`, `data_stream.type`, `service.name`, `service.version` and `service.environment`.
450+
* *gcp*: https://cloud.google.com/logging/docs/structured-logging#structured_logging_special_fields[Google Cloud]. Follows the `Default` format and when the xref:opentelemetry-tracing.adoc[OpenTelemetry] is used, tracing data present in the `mdc` field is flattened and copied to `spanId`, `traceSampled` and `trace`, but this last one with a prefix. GCP requires the `trace` to follow this semantic: `"projects/<my-trace-project>/traces/12345"`. Where `<my-trace-project>` has the same value as the `quarkus.application.name` config property.
451+
+
452+
453+
454+
==== Configuration
445455

446456
Configure the JSON logging extension using supported properties to customize its behavior.
447457

_versions/main/guides/podman.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ On systems which involve a Podman Machine managed VM (Mac & Windows), container
4646

4747
[source,bash]
4848
----
49-
podman machine set --rootful=true # or false
5049
podman machine stop
50+
podman machine set --rootful=true # or false
5151
podman machine start
5252
----
5353

_versions/main/guides/websockets-next-reference.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1291,21 +1291,25 @@ public class MyBean {
12911291
WebSocketClientConnection connection = connector
12921292
.baseUri(uri) <2>
12931293
.pathParam("name", "Roxanne") <3>
1294+
.customizeOptions((connectOptions, clientOptions) -> { <4>
1295+
// ...
1296+
})
12941297
.connectAndAwait();
1295-
connection.sendTextAndAwait("Hi!"); <4>
1298+
connection.sendTextAndAwait("Hi!"); <5>
12961299
}
12971300
}
12981301
----
12991302
<1> Inject the connector for `ClientEndpoint`.
13001303
<2> If the base `URI` is not supplied we attempt to obtain the value from the config. The key consists of the client id and the `.base-uri` suffix.
13011304
<3> Set the path param value. Throws `IllegalArgumentException` if the client endpoint path does not contain a parameter with the given name.
1302-
<4> Use the connection to send messages, if needed.
1305+
<4> Optionally, customize client and connection options not configurable with the connector API or Quarkus configuration.
1306+
<5> Use the connection to send messages, if needed.
13031307

13041308
NOTE: If an application attempts to inject a connector for a missing endpoint, an error is thrown.
13051309

13061310
Connectors are not thread-safe and should not be used concurrently.
13071311
Connectors should also not be reused.
1308-
If you need to create multiple connections in a row you'll need to obtain a new connetor instance programmatically using `Instance#get()`:
1312+
If you need to create multiple connections in a row you'll need to obtain a new connector instance programmatically using `Instance#get()`:
13091313

13101314
[source, java]
13111315
----
@@ -1350,6 +1354,9 @@ public class MyBean {
13501354
.onTextMessage((c, m) -> { <5>
13511355
// ...
13521356
})
1357+
.customizeOptions((connectOptions, clientOptions) -> { <6>
1358+
// ...
1359+
})
13531360
.connectAndAwait();
13541361
}
13551362
}
@@ -1359,6 +1366,7 @@ public class MyBean {
13591366
<3> The additional path that should be appended to the base URI.
13601367
<4> Set the execution model for callback handlers. By default, the callback may block the current thread. However in this case, the callback is executed on the event loop and may not block the current thread.
13611368
<5> The lambda will be called for every text message sent from the server.
1369+
<6> Optionally, customize client and connection options not configurable with the connector API or Quarkus configuration.
13621370

13631371
The basic connector is closer to a low-level API and is reserved for advanced users.
13641372
However, unlike others low-level WebSocket clients, it is still a CDI bean and can be injected in other beans.

0 commit comments

Comments
 (0)