Complete guide to disabling DEBUG log output in JBoss/Log4j2 environment

This article details how to disable the DEBUG level log output of Log4j2 in the JBoss application server through the CLI, management console or directly modifying the `standalone.xml` configuration file. For the scenario where JBoss integrates Log4j2, the tutorial provides a variety of configuration methods, and specifically points out the difference between Hibernate's `show_sql` configuration and log level control. It aims to help developers effectively manage and control the application's log information and avoid excessive redundant content output by the console.

When developing and deploying JBoss-based applications, a large amount of DEBUG level log output may appear in the console or log file, such as 00:00:39.293 [main] DEBUG org.jboss.logging - Logging Provider: org.jboss.logging.Log4j2LoggerProvider. Although these logs are useful when debugging, they often cause interference and reduce log readability in daily development or production environments. This article will dive into how to properly configure log levels in a JBoss environment to disable unnecessary DEBUG output.

Understand the log management mechanism of JBoss

When you run an application in a JBoss application server, JBoss typically takes over its internal components as well as the log management of the deployed application. Even though your application may be configured with Spring Boot or Logback/Log4j2, JBoss may use its built-in logging subsystem to handle log output. In this case, setting logging.level.root=info directly in application.properties or via the JVM parameter -Dlogging.level.org.springframework=INFO may not fully control the logging output of JBoss itself, especially JBoss core components or its integrated Log4j2 provider.

JBoss application servers (such as WildFly or JBoss EAP) usually manage logs through their logging subsystem (based on Log4j2, Logback or JUL, etc.). Therefore, to modify the log level of JBoss, you need to operate through the management interface or configuration file provided by JBoss.

How to configure JBoss log level

There are several ways to modify the JBoss application server's log level, including the command line interface (CLI), the management console, and directly modifying the configuration file.

1. Using JBoss CLI (Command Line Interface)

JBoss CLI provides a powerful and flexible way to manage servers. To modify the log level, follow these steps:

1. Connect to the CLI: Open a terminal or command prompt, navigate to the bin subdirectory of the JBoss installation directory, and run the CLI script:

    ./jboss-cli.sh --connect
   # Or on Windows:
   # jboss-cli.bat --connect

   If JBoss is running on a non-default port or requires authentication, you may need to provide more parameters.

2. View current log configuration (optional): You can view the current root logger configuration:

    /subsystem=logging/root-logger=ROOT:read-resource

3. Modify the root logger level: To set the root logger level to INFO, execute the following command:

    /subsystem=logging/root-logger=ROOT:write-attribute(name=level,value=INFO)

   This will set the default level to INFO for all loggers not explicitly configured.

4. Add or modify specific logger levels (if needed): If you need to set a different log level for a specific package or class, such as org.springframework, you can do this:

    /subsystem=logging/logger=org.springframework:add(level=INFO)
   # If it already exists, you can use write-attribute to modify it:
   # /subsystem=logging/logger=org.springframework:write-attribute(name=level,value=INFO)

   This will ensure that the log output level under the org.springframework package is INFO.

5. Reload configuration: Some changes may require reloading the log configuration to take effect:

    /host=master/server=server-one:reload
   # Or restart the server directly

2. Using the JBoss Management Console

JBoss/WildFly usually provides a web-based management console that allows you to configure the server through a graphical interface.

1. Access the management console: Access the JBoss management console in a browser (usually http://localhost:9990/console).

2. Navigate to logging configuration: Once logged in, navigate to "Configuration" -> "Subsystems" -> "Logging".

3. Modify log level: In the log configuration page, you can find the "Root Logger" or "Loggers" list.

   • Find "Root Logger" and edit its level to "INFO".
   • If you need to configure the level for a specific package (such as org.springframework), you can add or modify the corresponding logger in the "Loggers" section and set its level to "INFO".

4. Save and activate changes: Save your changes. Normally, JBoss will automatically apply these changes without requiring a restart.

3. Modify the standalone.xml or domain.xml file

For standalone mode, JBoss configuration is mainly stored in the standalone/configuration/standalone.xml file. For domain mode, it is in domain/configuration/domain.xml.

1. Locate the configuration file: Find the standalone/configuration/standalone.xml file in the JBoss installation directory.

2. Edit the logging subsystem configuration: Open the standalone.xml file and look for the section (where XY is the version number of the logging subsystem, such as 5.0 or 8.0).

3. Modify the root logger level: In the subsystem configuration, find the element and modify its level attribute to INFO:

    <subsystem xmlns="urn:jboss:domain:logging:8.0">
       <!-- ...Other log configurations... -->
       <root-logger>
           <level name="INFO"></level> <!-- Change DEBUG to INFO -->
           <handlers>
               <handler name="CONSOLE"></handler>
               <handler name="FILE"></handler>
           </handlers>
       </root-logger>
       <!-- ...Other logger configurations... -->
   </subsystem>

4. Add or modify a specific logger level: If you need to set the log level for a specific package (such as org.springframework), you can add or modify the corresponding logger within the tag after :

    <subsystem xmlns="urn:jboss:domain:logging:8.0">
       <!-- ... -->
       <loggers>
           <logger category="org.springframework">
               <level name="INFO"></level>
           </logger>
           <!-- ...other loggers... -->
       </loggers>
       <!-- ... -->
   </subsystem>

5. Restart JBoss: After directly modifying the standalone.xml file, you need to restart the JBoss server for the changes to take effect.

Special notes: Hibernate's show_sql

In the hibernate.cfg.xml configuration you provided, there are the following two lines:

 <property name="show_sql">true</property>
<property name="format_sql">true</property>

show_sql=true is a configuration item of Hibernate, which will directly output the executed SQL statement to the standard output (or be bound to the INFO level of the logging framework). This configuration is relatively independent of JBoss's log level control. Even if you set JBoss's root log level to INFO, Hibernate will still output SQL statements if show_sql is still true.

If you don't want to see these SQL outputs, you should set show_sql to false:

 <property name="show_sql">false</property>

Alternatively, if you wish to control the output of SQL through the logging framework, you can set it to false and then control the level of SQL logging by configuring Hibernate's loggers (such as org.hibernate.SQL and org.hibernate.type).

Summarize

In a JBoss application server environment, controlling the log output level needs to be configured through JBoss's own logging subsystem, rather than just relying on the application's application.properties or JVM parameters. Via the JBoss CLI, the management console or directly editing the standalone.xml file are the primary ways to achieve this goal. At the same time, please be sure to pay attention to Hibernate's show_sql configuration, which directly controls the output of SQL statements and is two different control points from the level setting of the log framework. Understanding these mechanisms will help you manage and debug the log output of your JBoss applications more effectively.

The above is the detailed content of Complete guide to disabling DEBUG log output in JBoss/Log4j2 environment. For more information, please follow other related articles on the PHP Chinese website!