Skip to content

Commit 21e2179

Browse files
authored
Merge pull request #44799 from MichalMaler/docstyle-review
Logging and Datasource docstyle review
2 parents d1104d5 + 262a5e1 commit 21e2179

File tree

2 files changed

+18
-15
lines changed

2 files changed

+18
-15
lines changed

docs/src/main/asciidoc/datasource.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -259,12 +259,11 @@ For more information about configuring JDBC, see <<jdbc-url,JDBC URL format refe
259259
[[other-databases]]
260260
===== Custom databases and drivers
261261

262-
If you need to connect to a database for which Quarkus does not provide an extension with the JDBC driver,
263-
you can use a custom driver instead. For example, if you are using the OpenTelemetry JDBC driver in your project.
262+
If Quarkus does not provide a JDBC extension for your database, or you need to use a different JDBC driver, such as one for OpenTelemetry, you can configure the JDBC driver explicitly.
264263

265-
Without an extension, the driver will work correctly in any Quarkus app running in JVM mode.
266-
However, the driver is unlikely to work when compiling your application to a native executable.
267-
If you plan to make a native executable, use the existing JDBC Quarkus extensions, or contribute one for your driver.
264+
Without an extension, JDBC drivers are expected to work correctly in JVM mode.
265+
However, they are unlikely to function when compiling your application into a native executable.
266+
To build a native executable, use an existing Quarkus JDBC extension or contribute a new extension for your driver.
268267

269268
.An example for defining access to a database with no built-in support in JVM mode:
270269

docs/src/main/asciidoc/logging.adoc

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -115,21 +115,25 @@ The fully qualified name of the class that calls the `Log` methods is used as a
115115
In this example, the logger name would be `com.example.MyService`.
116116
<3> Finally, all calls to `Log` methods are rewritten to regular JBoss Logging calls on the logger field during the application build.
117117

118-
WARNING: Only use the `Log` API in application classes, not in external dependencies.
119-
`Log` method calls that are not processed by Quarkus at build time will throw an exception.
120-
121118
[[log-api-extension-warning]]
122-
==== Important Note on Using `io.quarkus.logging.Log` in Extensions
119+
[WARNING]
120+
====
121+
Use the `Log` API only in application classes, not in external dependencies.
122+
`Log` method calls not processed by Quarkus at build time will result in an exception.
123123
124-
While the `Log` API simplifies logging in application classes, it should not be used in extension modules or external dependencies. The following considerations apply:
124+
.Using `io.quarkus.logging.Log` in extensions:
125125
126-
* `io.quarkus.logging.Log` depends on Quarkus bytecode transformations that occur at build time.
127-
* In extension modules, the use of `Log` may work if the module has a Jandex index. However, this behavior is not officially supported and might lead to unreliable logging.
126+
While the `Log` API simplifies logging in application classes, it is not recommended for use in extension modules or external dependencies.
128127
129-
For extension development:
128+
The following considerations apply:
130129
131-
* Use standard loggers like `org.jboss.logging.Logger.getLogger(String)` instead of `io.quarkus.logging.Log`.
132-
* This avoids potential performance issues caused by the stack walk fallback when Quarkus build-time processing is unavailable.
130+
* `io.quarkus.logging.Log` depends on Quarkus bytecode transformations that occur at build time.
131+
132+
* In extension modules, `Log` works only if the module includes a Jandex index.
133+
However, this behavior is unsupported and can lead to unreliable logging.
134+
+
135+
For extension development, use `org.jboss.logging.Logger.getLogger(String)` instead of `io.quarkus.logging.Log`.
136+
====
133137

134138

135139
[[injection-of-a-configured-logger]]

0 commit comments

Comments
 (0)