As an application developer, you can use logging to view and record messages about events that occur while your application is running. Log messages provide information that you can use to debug your application during development and testing, and to monitor your application in a production environment.
-
Have OpenJDK 11 or 17 installed and the
JAVA_HOME
environment variable set to specify the location of the Java SDK.-
In Quarkus 2.7, building native executables by using Java 17 is provided as a Technology Preview feature. To build native executables for production deployments, use Java 11.
-
Log in to the Red Hat Customer Portal to download Red Hat build of OpenJDK from the Software Downloads page.
-
-
Have Apache Maven 3.8.4 or higher installed.
-
Download Maven from the Apache Maven Project website.
-
-
Have a Quarkus Maven project.
-
For information on how to create Quarkus applications with Maven, see Developing and compiling your Quarkus applications with Apache Maven.
-
Making open source more inclusive
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
1. JBoss LogManager and supported logging frameworks
Quarkus uses the JBoss LogManager logging backend to collect and manage log data. You can use JBoss Logging to collect data about Quarkus internal events and also about the events within your application. You can configure logging behavior in your application.properties
file.
JBoss LogManager supports several third-party logging APIs in addition to the JBoss Logging. JBoss LogManager merges the logs from all the supported logging APIs.
Quarkus handles all of its logging functionalities using JBoss Logging. When you use a library that relies on a different logging API, you need to exclude this library from the dependencies and configure JBoss Logging to use a logging adapter for the third-party API.
1.1. Adding Apache Log4j logging framework
Apache Log4j is a logging framework that includes a logging backend and a logging API. Since Quarkus uses the JBoss LogManager backend, you can add the log4j2-jboss-logmanager
library to your project and use Log4j as a logging API. Adding the Log4j library routes the Log4j logs to the JBoss Log Manager. You do not need to include any Log4j dependencies.
-
Add the
log4j2-jboss-logmanager
library as a dependency to your project’spom.xml
file:pom.xml<dependency> <groupId>org.jboss.logmanager</groupId> <artifactId>log4j2-jboss-logmanager</artifactId> </dependency>
The
log4j2-jboss-logmanager
is the library for the Log4J version 2 API. If you want to use the legacy Log4J version 1 API, you must add thelog4j-jboss-logmanager
instead.
1.2. Using logging adapters
Quarkus relies on the JBoss Logging library for all the logging requirements.
When using libraries that have dependencies on other logging libraries, such as Apache Commons Logging, Log4j, or SLF4j, you must exclude those logging libraries from the dependencies and use one of the adapters provided by JBoss Logging. You do not need to add an adapter for libraries that are dependencies of Quarkus extensions.
The third-party logging implementation is not included in the native executable and your application might fail to compile with an error message similar to the following:
Caused by java.lang.ClassNotFoundException: org.apache.commons.logging.impl.LogFactoryImpl
You can prevent this error by configuring a JBoss Logging adapter for the third-party logging implementation that you use.
-
Depending on the logging library that you are using, add one of the adapters to your
pom.xml
file:-
Apache Commons Logging:
pom.xml<dependency> <groupId>org.jboss.logging</groupId> <artifactId>commons-logging-jboss-logging</artifactId> </dependency>
-
Log4j:
pom.xml<dependency> <groupId>org.jboss.logmanager</groupId> <artifactId>log4j-jboss-logmanager</artifactId> </dependency>
-
Log4j2:
pom.xml<dependency> <groupId>org.jboss.logmanager</groupId> <artifactId>log4j2-jboss-logmanager</artifactId> </dependency>
-
SLF4j:
pom.xml<dependency> <groupId>org.jboss.slf4j</groupId> <artifactId>slf4j-jboss-logmanager</artifactId> </dependency>
-
2. Enabling JBoss Logging for your application
When you want to use JBoss Logging to collect application logs, you must add a logger to each class that you want to produce a log.
The following procedure demonstrates how to add logging to your application programmatically using the following:
-
API approach
-
Declaratively using annotations
-
Depending on your application code, use one of the following approaches:
-
Create an instance of
org.jboss.logging.Logger
and initialize it by calling the static methodLogger.getLogger(Class)
for each class:src/main/java/org/acme/ExampleResource.javaimport org.jboss.logging.Logger; 1 import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; @Path("/hello") public class ExampleResource { private static final Logger LOG = Logger.getLogger(ExampleResource.class); 2 @GET @Produces(MediaType.TEXT_PLAIN) public String hello() { LOG.info("Hello"); 3 return "hello"; } }
-
Add the
org.jboss.logging.Logger
import statement for each class namespace that you want to use. -
Add reference to the logger singleton for each class.
-
Set a logging level for the log message.
-
-
Inject a configured
org.jboss.logging.Logger
instance in your beans and resource classes:src/main/java/org/acme/ExampleResource.javaimport javax.inject.Inject; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import org.jboss.logging.Logger; 1 import io.quarkus.arc.log.LoggerName; @Path("/hello") public class ExampleResource { @Inject Logger log; 2 @LoggerName("foo") Logger fooLog; 3 @GET @Produces(MediaType.TEXT_PLAIN) public String hello() { log.info("Simple!"); fooLog.info("Goes to foo logger!"); return "hello"; } }
-
Add the
org.jboss.logging.Logger
import statement for each class namespace that you want to use. -
The fully qualified class name of the declaring class is used as the logger name, which is equivalent to the initialization statement
org.jboss.logging.Logger.getLogger(ExampleResource.class)
. -
Set a name for the logger. In this example, the logger name is foo, which is equivalent to the initialization statement
org.jboss.logging.Logger.getLogger("foo")
.
The logger instances are cached internally. A logger that you inject into a bean is shared for all bean instances to avoid the possible performance penalty associated with logger instantiation. -
-
-
(Optional) Configure the logging output in your
application.properties
file:For example, you can create a log file and print the output to a console and the file:
src/main/resources/application.propertiesquarkus.log.file.enable=true quarkus.log.file.path=/tmp/trace.log
-
Run your application in development mode:
./mvnw quarkus:dev
-
Navigate to
http://localhost:8080/hello
. -
Depending on your configuration, review the log messages on your terminal or in your log file.
Example output for the
ExampleResource.class
with logging level set toINFO
:2021-05-21 15:38:39,751 INFO [io.quarkus] (Quarkus Main Thread) my-project my-version on JVM (powered by Quarkus 1.13.3.Final) started in 1.189s. Listening on: http://localhost:8080 2021-05-21 15:38:39,765 INFO [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated. 2021-05-21 15:38:39,766 INFO [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, resteasy] 2021-05-21 15:38:58,790 INFO [ExampleResource] (executor-thread-1) Hello
3. Setting runtime configuration
You can configure logging levels and categories in the application.properties
file.
Logging categories are hierarchical. When you set a logging level for a category, the configuration applies to all subcategories of that category.
There are two logging level settings: logging level and minimum logging level. The default logging level is INFO
, the default minimum logging level is DEBUG
. You can adjust both either globally, using the quarkus.log.level
and quarkus.log.min-level
property, or by category.
When you set the logging level below the minimum logging level, you must adjust the minimum logging level as well. Otherwise, the value of the minimum logging level overrides the logging level.
Excessive logging has performance implications. You can adjust the minimum logging level to collect only relevant data about your application. Reducing log volume potentially optimizes memory usage and improves the performance of your application. For example, in native execution, the minimum level enables lower level checks (isTraceEnabled
) to be folded to false
, which results in dead code elimination.
-
Configure the logging in your
application.properties
file:The following example shows how to set the default logging level to
INFO
logging and include HibernateDEBUG
logs:src/main/resources/application.propertiesquarkus.log.level=INFO quarkus.log.category."org.hibernate".level=DEBUG
When you set configuration properties using command line, escape by using
"
.Example-
-Dquarkus.log.category.\"org.hibernate\".level=TRACE
-
3.1. Configuring logging format
Quarkus uses a pattern-based logging formatter that generates human-readable text logs. The log entry displays the timestamp, the logging level, the class name, the thread ID and the message. You can customize the format for each log handler using a dedicated configuration property.
-
Have a Quarkus Maven project.
-
Set a value for the
quarkus.log.console.format
to configure the console handler as follows:src/main/resources/application.propertiesquarkus.log.console.format=%d{HH:mm:ss} %-5p [%c{2.}] (%t) %s%e%n
This configuration results in the following log message formatting:
14:11:07 INFO [ExampleResource] (executor-thread-199) Hello
3.1.1. Logging format strings
The following table shows the logging format string symbols that you can use to configure the format of log messages.
Symbol | Summary | Description |
---|---|---|
|
|
A simple |
|
Category |
The category name |
|
Source class |
The source class name [1] |
|
Date |
Date with the given date format string, which follows the |
|
Exception |
The exception stack trace |
|
Source file |
The source file name [1] |
|
Host name |
The system simple hostname |
|
Qualified host name |
The fully qualified hostname of the system. Depending on the OS configuration, it might be the same as the simple hostname. |
|
Process ID |
The current process PID |
|
Source location |
The source location (source file name, line number, class name, and method name) [1] |
|
Source line |
The source line number [1] |
|
Full Message |
The log message including exception trace |
|
Source method |
The source method name [1] |
|
Newline |
The platform-specific line separator string |
|
Process name |
The name of the current process |
|
Level |
The logging level of the message |
|
Relative time |
The relative time in milliseconds since the start of the application log |
|
Simple message |
The log message without exception trace |
|
Thread name |
The thread name |
|
Thread ID |
The thread ID |
|
Time zone |
The time zone of the output in the |
|
Mapped Diagnostics Context Value |
The value from Mapped Diagnostics Context |
|
Mapped Diagnostics Context Values |
All the values from Mapped Diagnostics Context in format {property.key=property.value} |
|
Nested Diagnostics context values |
All the values from Nested Diagnostics Context in the {value1.value2} format |
3.2. Logging categories setting
You can use logging categories to organize log messages based on their severity or the component they belong to. Each category can be configured independently.
For every category, the same settings apply to console, file, and syslog. You can override the settings by attaching one or more named handlers to a category.
Property Name | Default | Description |
---|---|---|
|
|
The level to configure the |
|
|
The minimum logging level to configure the |
|
|
Enable the logger to send its output to the parent logger. |
|
|
The names of the handlers that you want to attach to a specific category. |
"
) when using them in the names of properties to escape the periods (
.
) that are typically part of the category names.
3.3. Logging levels
You can use logging levels to categorize logs by severity or their impact on the health and stability of your Quarkus application. Logging levels let you filter critical events from events that are purely informative.
Logging level | Description |
---|---|
OFF |
Special level to turn off logging. |
FATAL |
A critical service failure or an inability to complete a service request. |
ERROR |
A significant disruption in a request or the inability to service a request. |
WARN |
A non-critical service error or a problem that might not require immediate correction. |
INFO |
Service lifecycle events or important related very-low-frequency information. |
DEBUG |
Messages that provide extra debugging information regarding lifecycle or non-request-bound events. |
TRACE |
Messages delivered with high frequency that provide extra per-request debugging information. |
ALL |
Special level for all messages including custom levels. |
java.util.logging
package.
3.4. Root logger configuration
The root logger category is at the top of the logger hierarchy and is configured at the top level of the logging configuration. The root logger captures all log messages of the specified logging level or higher that are sent to the server and are not captured by a logging category.
Property Name | Default | Description |
---|---|---|
|
|
The default logging level for every logging category. |
|
|
The default minimum logging level for every logging category. |
3.5. Quarkus log handlers
A log handler is a logging component that sends log events to a recipient. Quarkus includes the following log handlers:
- Console log handler
-
The console log handler is enabled by default. It outputs all log events to the console of your application (typically to the system’s
stdout
). - File log handler
- The file log handler is disabled by default. It outputs all log events to a file on the application’s host. The file log handler supports log file rotation.
- Syslog log handler
-
Syslog is a protocol for sending log messages on Unix-like systems. The specifications of the syslog protocol are defined in
RFC 5424.
The syslog handler sends all log events to a syslog server (by default, the syslog server runs on the same host as the application). The syslog handler is disabled by default.
3.6. Example logging configuration
This section shows examples of how you can configure logging for your Quarkus project.
# Format log messages to have shorter time and shorter category prefixes.
quarkus.log.console.format=%d{HH:mm:ss} %-5p [%c{2.}] (%t) %s%e%n
# Remove color from log messages.
quarkus.log.console.color=false
# Enable console DEBUG logging with the exception of Quarkus logs that have a logging level set to INFO.
quarkus.log.console.level=DEBUG
quarkus.log.category."io.quarkus".level=INFO
# Enable file logging and set a path to the log file.
quarkus.log.file.enable=true
quarkus.log.file.path=/tmp/trace.log
# Enable TRACE log messages in a log file.
quarkus.log.file.level=TRACE
# Set a format for the log file output.
quarkus.log.file.format=%d{HH:mm:ss} %-5p [%c{2.}] (%t) %s%e%n
# Set logging level to TRACE for specific categories.
quarkus.log.category."io.quarkus.smallrye.jwt".level=TRACE
quarkus.log.category."io.undertow.request.security".level=TRACE
INFO
. Change the root logger configuration when you want to collect logs for lower levels, such as
DEBUG
or
TRACE
.
# Set path to the log file.
quarkus.log.file.path=/tmp/trace.log
# Configure console format.
quarkus.log.console.format=%d{HH:mm:ss} %-5p [%c{2.}] (%t) %s%e%n
# Configure a console log handler.
quarkus.log.handler.console."STRUCTURED_LOGGING".format=%e%n
# Configure a file log handler.
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".enable=true
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".format=%e%n
# Configure the category and associate it with the two named handlers.
quarkus.log.category."io.quarkus.category".level=INFO
quarkus.log.category."io.quarkus.category".handlers=STRUCTURED_LOGGING,STRUCTURED_LOGGING_FILE
4. Configuring JSON logging format
You can change the output format of the console log to JSON to make it easier to process and store the log information for later analysis.
To configure the JSON logging format, you need to add the quarkus-logging-json
extension to your Quarkus project. The quarkus-logging-json
extension replaces the output format configuration from the console configuration.
-
The console configuration items, such as the format string and the color settings, will be ignored.
-
Other console configuration items, including those controlling asynchronous logging and the logging level, continue to be applied.
-
Add the
quarkus-logging-json
extension to thepom.xml
file of your application:pom.xml<dependencies> <!-- ... your other dependencies are here ... --> <dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-logging-json</artifactId> </dependency> </dependencies>
-
(Optional) Set a profile-specific configuration for JSON logging in your
application.properties
file:The following example shows how you can disable JSON logging for the development and test profiles:
src/main/resources/application.properties%dev.quarkus.log.console.json=false %test.quarkus.log.console.json=false
4.1. JSON logging configuration properties
You can configure the JSON logging extension with the following configuration properties:
Configuration property | Description | Type | Default |
---|---|---|---|
|
Enable the JSON console formatting extension. |
boolean |
|
|
Enable pretty-printing of the JSON record. [4] |
boolean |
|
|
The format for dates. The |
string |
|
|
Special end-of-record delimiter. By default, newline is used as delimiter. |
string |
|
|
The ID for zone. The |
string |
|
|
The output type for an exception. |
|
|
|
Enable detailed printing of the logs. The details include the source class name, source file name, source method name, and source line number. [5] |
boolean |
|
5. Configuring logging for @QuarkusTest
If you want to configure logging for your @QuarkusTest
, you need to set up the maven-surefire-plugin
accordingly. You must specify the LogManager
using the java.util.logging.manager
system property.
-
Set the
LogManager
using thejava.util.logging.manager
system property:pom.xml<build> <plugins> <plugin> <artifactId>maven-surefire-plugin</artifactId> <version>${surefire-plugin.version}</version> <configuration> <systemPropertyVariables> <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager> 1 <quarkus.log.level>DEBUG</quarkus.log.level> 2 <maven.home>${maven.home}</maven.home> </systemPropertyVariables> </configuration> </plugin> </plugins> </build>
-
Add the
org.jboss.logmanager.LogManager
. -
Enable debug logging for all logging categories.
-
6. Additional resources
-
Logging Configuration Reference - Quarkus Community Documentation
-
Centralized Log Management - Quarkus Community Documentation
Revised on 2023-03-09 05:34:54 UTC
Footnotes
- Format sequences that examine caller information might affect performance. ↩
- Some extensions define customized default logging levels for certain categories to reduce log noise. Setting the logging level in configuration overrides any extension-defined logging levels. ↩
- By default, the configured category inherits all the attached handlers from the root logger category. ↩
- Some processors and JSON parsers might fail to read the pretty-printed output. ↩
- Printing the details can be expensive as the values are retrieved from the caller. ↩