Skip to content

Commit

Permalink
Set the default min-level for logs to DEBUG
Browse files Browse the repository at this point in the history
Per discussion with Max.

Note that the related ITs might need some tweaks as the default value
has changed but they will need to be changed later.
  • Loading branch information
gsmet committed Feb 8, 2021
1 parent 26898b8 commit 5bab172
Show file tree
Hide file tree
Showing 31 changed files with 9 additions and 62 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@
public class CategoryBuildTimeConfig {
/**
* The minimum log level for this category.
* By default all categories are configured with <code>INFO</code> minimum level.
* By default all categories are configured with <code>DEBUG</code> minimum level.
*
* To get runtime logging below <code>INFO</code>, e.g. <code>DEBUG</code> or <code>TRACE</code>,
* To get runtime logging below <code>DEBUG</code>, e.g. <code>TRACE</code>,
* the minimum level has to be adjusted at build time, the right log level needs to be provided at runtime.
*
* As an example, to get <code>TRACE</code> logging,
* minimum level needs to be at <code>TRACE</code> and the runtime log level needs to match that.
* To get <code>DEBUG</code> logging,
* minimum level needs to be set at <code>DEBUG</code> or <code>TRACE</code> (as well as runtime log level).
*/
@ConfigItem(defaultValue = "inherit")
public InheritableLevel minLevel;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public class LogBuildTimeConfig {
/**
* The default minimum log level.
*/
@ConfigItem(defaultValue = "INFO")
@ConfigItem(defaultValue = "DEBUG")
public Level minLevel;

/**
Expand Down
1 change: 0 additions & 1 deletion docs/src/main/asciidoc/cdi-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,6 @@ When using the dev mode (running `./mvnw clean compile quarkus:dev`), you can se
by enabling additional logging via the following line in your `application.properties`.

----
quarkus.log.category."io.quarkus.arc.processor".min-level=DEBUG
quarkus.log.category."io.quarkus.arc.processor".level=DEBUG
----

Expand Down
9 changes: 4 additions & 5 deletions docs/src/main/asciidoc/logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,10 @@ for example, to set the default log level to `INFO` logging and include Hibernat
[source, properties]
----
quarkus.log.level=INFO
quarkus.log.category."org.hibernate".min-level=DEBUG
quarkus.log.category."org.hibernate".level=DEBUG
----

Setting a log level below `INFO` requires the minimum log level to be adjusted,
Setting a log level below `DEBUG` requires the minimum log level to be adjusted,
either globally via the `quarkus.log.min-level` property or per-category as shown in the example above,
as well as adjusting the log level itself.

Expand All @@ -144,7 +143,7 @@ resulting in dead code elimination for code that will never to be executed.
All possible properties are listed in <<loggingConfigurationReference, the logging configuration reference>>.

NOTE: If you are adding these properties via command line make sure `"` is escaped.
For example `-Dquarkus.log.category.\"org.hibernate\".level=DEBUG`.
For example `-Dquarkus.log.category.\"org.hibernate\".level=TRACE`.

=== Logging categories

Expand All @@ -158,7 +157,7 @@ These can also be overridden by attaching a one or more named handlers to a cate
|===
|Property Name|Default|Description
|quarkus.log.category."<category-name>".level|INFO footnote:[Some extensions may define customized default log levels for certain categories, in order to reduce log noise by default. Setting the log level in configuration will override any extension-defined log levels.]|The level to use to configure the category named `<category-name>`. The quotes are necessary.
|quarkus.log.category."<category-name>".min-level|INFO |The minimum logging level to use to configure the category named `<category-name>`. The quotes are necessary.
|quarkus.log.category."<category-name>".min-level|DEBUG |The minimum logging level to use to configure the category named `<category-name>`. The quotes are necessary.
|quarkus.log.category."<category-name>".use-parent-handlers|true|Specify whether or not this logger should send its output to its parent logger.
|quarkus.log.category."<category-name>".handlers=[<handler>]|empty footnote:[By default the configured category gets the same handlers attached as the one on the root logger.]|The names of the handlers that you want to attach to a specific category.
|===
Expand All @@ -174,7 +173,7 @@ The root logger category is handled separately, and is configured via the follow
|===
|Property Name|Default|Description
|quarkus.log.level|INFO|The default log level for every log category.
|quarkus.log.min-level|INFO|The default minimum log level for every log category.
|quarkus.log.min-level|DEBUG|The default minimum log level for every log category.
|===

If no level configuration exists for a given logger category, the enclosing (parent) category is examined. If no categories are configured which enclose the category in question, then the root logger configuration is used.
Expand Down
1 change: 0 additions & 1 deletion docs/src/main/asciidoc/mongodb-panache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,6 @@ This can be achieved by setting to DEBUG the following log category inside your

[source,properties]
----
quarkus.log.category."io.quarkus.mongodb.panache.runtime".min-level=DEBUG
quarkus.log.category."io.quarkus.mongodb.panache.runtime".level=DEBUG
----

Expand Down
1 change: 0 additions & 1 deletion docs/src/main/asciidoc/optaplanner.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -829,7 +829,6 @@ change the logging in the `application.properties` file or with a `-D` system pr

[source,properties]
----
quarkus.log.category."org.optaplanner".min-level=debug
quarkus.log.category."org.optaplanner".level=debug
----

Expand Down
1 change: 0 additions & 1 deletion docs/src/main/asciidoc/vault-auth.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,6 @@ quarkus.datasource.jdbc.url = jdbc:postgresql://<host>:5432/mydatabase
quarkus.vault.authentication.kubernetes.role=vault-quickstart-role
quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,4 @@ quarkus.security.users.embedded.roles.noadmin=user
quarkus.security.users.embedded.auth-mechanism=CUSTOM
quarkus.security.users.embedded.plain-text=false

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,3 @@ quarkus.security.users.embedded.roles.jdoe=NoRolesUser
quarkus.security.users.embedded.roles.noadmin=user
quarkus.security.users.embedded.auth-mechanism=CUSTOM
quarkus.security.users.embedded.plain-text=true

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,3 @@ quarkus.security.users.file.enabled=true
quarkus.security.users.file.users=test-users.properties
quarkus.security.users.file.roles=test-roles.properties
quarkus.security.users.file.plain-text=true

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
#quarkus.log.category."org.flywaydb.core".min-level=DEBUG
#quarkus.log.category."org.flywaydb.core".level=DEBUG
#quarkus.log.category."io.quarkus.flyway".min-level=DEBUG
#quarkus.log.category."io.quarkus.flyway".level=DEBUG
quarkus.datasource.users.db-kind=h2
quarkus.datasource.users.username=sa
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
#quarkus.log.category."io.quarkus.micrometer".min-level=DEBUG
#quarkus.log.category."io.quarkus.micrometer".level=DEBUG
quarkus.log.category."io.quarkus.bootstrap".level=INFO
#quarkus.log.category."io.quarkus.arc".min-level=DEBUG
#quarkus.log.category."io.quarkus.arc".level=DEBUG
quarkus.log.category."io.netty".level=INFO
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,3 @@ mp.messaging.outgoing.my-ws-sink.url=ws://localhost:${quarkus.http.test-port:808
mp.messaging.outgoing.ws-sink-with-serializer.connector=quarkus-websocket
mp.messaging.outgoing.ws-sink-with-serializer.url=ws://localhost:${quarkus.http.test-port:8081}/ws-target-url
mp.messaging.outgoing.ws-sink-with-serializer.serializer=io.quarkus.reactivemessaging.utils.ToUpperCaseSerializer

quarkus.log.category."io.quarkus.reactivemessaging".min-level=DEBUG
quarkus.log.category."io.quarkus.reactivemessaging".level=DEBUG
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
quarkus.log.console.level=DEBUG
quarkus.log.category."org.flywaydb.core".min-level=DEBUG
quarkus.log.category."org.flywaydb.core".level=DEBUG
quarkus.log.category."io.quarkus.flyway".min-level=DEBUG
quarkus.log.category."io.quarkus.flyway".level=DEBUG
# Agroal config
quarkus.datasource.db-kind=h2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ quarkus.datasource.jdbc.max-size=8
quarkus.hibernate-orm.dialect=org.hibernate.dialect.H2Dialect
quarkus.hibernate-orm.database.generation=drop-and-create

quarkus.log.category."org.hibernate.SQL".min-level=DEBUG
quarkus.log.category."org.hibernate.SQL".level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ quarkus.datasource.reactive.url=${postgres.reactive.url}

quarkus.hibernate-orm.database.generation=drop-and-create

quarkus.log.category."org.hibernate.SQL".min-level=DEBUG
quarkus.log.category."org.hibernate.SQL".level=DEBUG
# this is required otherwise SQL logs are formatted on multiple lines and we can't match them
quarkus.hibernate-orm.log.sql=false
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,5 @@ quarkus.liquibase.database-change-log-table-name=TEST_LOG

# Debug logging
#quarkus.log.console.level=DEBUG
#quarkus.log.category."liquibase".min-level=DEBUG
#quarkus.log.category."liquibase".level=DEBUG
#quarkus.log.category."io.quarkus.liquibase".min-level=DEBUG
#quarkus.log.category."io.quarkus.liquibase".level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
/**
* This test verifies that log levels are promoted to min-level when set below the default min-level.
*
* So given the default min-level is INFO,
* So given the default min-level is DEBUG,
* so if log level is set to TRACE,
* it will be automatically promoted to INFO.
* it will be automatically promoted to DEBUG.
*/
@QuarkusTest
@QuarkusTestResource(SetRuntimeLogLevels.class)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
#quarkus.log.category."io.quarkus.micrometer".min-level=DEBUG
#quarkus.log.category."io.quarkus.micrometer".level=DEBUG
quarkus.log.category."io.quarkus.micrometer.runtime.binder.vertx".level=INFO

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ quarkus.mongodb.database=books
quarkus.mongodb.cl2.connection-string=mongodb://localhost:27018
quarkus.mongodb.cl2.write-concern.journal=false

#quarkus.log.category."io.quarkus.mongodb.panache.runtime".min-level=DEBUG
#quarkus.log.category."io.quarkus.mongodb.panache.runtime".level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@ quarkus.mongodb.database=books
quarkus.mongodb.cl2.connection-string=mongodb://localhost:27018
quarkus.mongodb.cl2.write-concern.journal=false

#quarkus.log.category."io.quarkus.mongodb.panache.runtime".min-level=DEBUG
#quarkus.log.category."io.quarkus.mongodb.panache.runtime".level=DEBUG
quarkus.mongodb.metrics.enabled=true
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ quarkus.datasource.username=hibernate_orm_test
quarkus.datasource.password=hibernate_orm_test
quarkus.datasource.reactive.url=${reactive-postgres.url}
quarkus.datasource.reactive.thread-local=true
quarkus.log.category."io.quarkus.reactive.datasource".min-level=DEBUG
quarkus.log.category."io.quarkus.reactive.datasource".level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,8 @@ quarkus.datasource.dynamicDS.credentials-provider=dynamic-ds
quarkus.datasource.dynamicDS.credentials-provider-name=vault-credentials-provider
quarkus.datasource.dynamicDS.jdbc.url=jdbc:postgresql://localhost:6543/mydb

quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG
quarkus.log.category."io.quarkus.vault.runtime.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault.runtime.vault".level=DEBUG

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ quarkus.vault.secret-config-kv-path=config
quarkus.vault.health.enabled=true
quarkus.vault.health.stand-by-ok=true

quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG

quarkus.datasource.db-kind=postgresql
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ quarkus.vault.tls.ca-cert=src/test/resources/vault-tls.crt
quarkus.vault.log-confidentiality-level=low
quarkus.vault.renew-grace-period=10

quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG

# CI can sometimes be slow, there is no need to fail a test if Vault doesn't respond in 1 second which is the default
quarkus.vault.read-timeout=5S

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ quarkus.vault.tls.ca-cert=src/test/resources/vault-tls.crt
quarkus.vault.log-confidentiality-level=low
quarkus.vault.renew-grace-period=10

quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG

# CI can sometimes be slow, there is no need to fail a test if Vault doesn't respond in 1 second which is the default
quarkus.vault.read-timeout=5S

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,11 @@ quarkus.vault.tls.ca-cert=src/test/resources/vault-tls.crt
quarkus.vault.log-confidentiality-level=low
quarkus.vault.renew-grace-period=10

quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG

# CI can sometimes be slow, there is no need to fail a test if Vault doesn't respond in 1 second which is the default
quarkus.vault.read-timeout=5S

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ quarkus.vault.tls.ca-cert=src/test/resources/vault-tls.crt
quarkus.vault.log-confidentiality-level=low
quarkus.vault.renew-grace-period=10

quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG

# CI can sometimes be slow, there is no need to fail a test if Vault doesn't respond in 1 second which is the default
quarkus.vault.read-timeout=5S

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,10 @@ quarkus.vault.tls.ca-cert=src/test/resources/vault-tls.crt
quarkus.vault.log-confidentiality-level=low
quarkus.vault.renew-grace-period=10

quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG

# CI can sometimes be slow, there is no need to fail a test if Vault doesn't respond in 1 second which is the default
quarkus.vault.read-timeout=5S

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ quarkus.vault.tls.ca-cert=src/test/resources/vault-tls.crt
quarkus.vault.log-confidentiality-level=low
quarkus.vault.renew-grace-period=10

quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG

# CI can sometimes be slow, there is no need to fail a test if Vault doesn't respond in 1 second which is the default
quarkus.vault.read-timeout=5S

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,10 @@ quarkus.vault.tls.ca-cert=src/test/resources/vault-tls.crt
quarkus.vault.log-confidentiality-level=low
quarkus.vault.renew-grace-period=10

quarkus.log.category."io.quarkus.vault".min-level=DEBUG
quarkus.log.category."io.quarkus.vault".level=DEBUG

# CI can sometimes be slow, there is no need to fail a test if Vault doesn't respond in 1 second which is the default
quarkus.vault.read-timeout=5S

#quarkus.log.min-level=DEBUG
#quarkus.log.level=DEBUG
#quarkus.log.console.level=DEBUG

0 comments on commit 5bab172

Please sign in to comment.