Home  >  Article  >  Java  >  What is the operation of SpringBoot to dynamically modify the log level?

What is the operation of SpringBoot to dynamically modify the log level?

WBOY
WBOYforward
2023-05-14 08:25:131608browse

The traditional approach is generally:

1. Modify the log level in the configuration

2. Restart the application

3. Check the error log to troubleshoot the problem when the problem occurs

This process requires restarting the application, which is more troublesome and less efficient. Moreover, for large-scale online projects, it is impossible to stop and restart at will. So is there a way to dynamically change the log level without restarting the application?

Now, let Lao Wan teach you how to dynamically modify the log level through SpringBoot's actuator component.

1. Add dependencies

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

2. Configure the port exposed by actuator

#启用actuator端口
management.endpoints.enabled-by-default=fasle
#设置actuator的访问根路径,默认是/actuator
management.endpoints.web.base-path=/message
#启用的端点
management.endpoints.web.exposure.include=loggers

Here I modified the default access path of actuator/actuator to /message, for It is saved consistent with the basic access path of the project.

Two configuration methods to enable the port:

Method 1: (Recommended)

management.endpoints.web.exposure.include=loggers

Method 2: (Test in this way Not effective)

management.endpoint.loggers.enabled=true

Additional: How to disable the info port

management.endpoints.enabled-by-default=false
management.endpoint.info.enabled=true

About the actuator component, it is called one of the four major components of spring boot and has powerful functions. Everyone can find some information on the Internet to learn more.

actuator’s endpoint port description:

ID Description Enabled by default
auditevents Display the audit event information of the current application Yes
beans Display a complete list of all Spring Beans in an application Yes
conditions Display configuration and auto-configuration classes configuration classes) and the reasons why they are applied or not applied Yes
configprops Display a collection list of all @ConfigurationProperties Yes
env Display properties of ConfigurableEnvironment from Spring Yes
flyway Display the database migration path, if any Yes
health Display the health information of the application (when A simple "status" is displayed when accessing using an unauthenticated connection, and full information details are displayed when accessing using an authenticated connection) Yes
info Display any application information Yes
liquibase Display any Liquibase database migration path, if any Yes
metrics Display the metrics information of the current application Yes
mappings Display a collection list of all @RequestMapping paths Yes
scheduledtasks Display scheduled tasks in the application Yes
sessions Allows the retrieval and deletion of user sessions from the session store supported by Spring sessions. Not available when using Spring Session's support for reactive web applications. Yes
shutdown Allow apps to shut down gracefully (not enabled by default) No
threaddump Execute a thread dump Yes

If using web application (Spring MVC, Spring WebFlux, or Jersey), you can also use the following endpoints:

##prometheus Display metrics information in a format that can be crawled by the Prometheus serverYes
ID Description Enabled by default
heapdum Return a GZip compressed hprof heap dump file Yes
jolokia Exposing JMX beans over HTTP (WebFlux is not available when Jolokia is on the classpath) Yes
logfile Return Log file content (if the logging.file or logging.path attribute is set), supports using the HTTP Range header to receive partial information about the log file content Yes
To change which endpoints are exposed, use the following technique Specific include and exclude properties:

##Propertymanagement. endpoints.jmx.exposure.exclude##management.endpoints.jmx.exposure.include*management.endpoints.web.exposure.exclude*info, health
Default
*
##management.endpoints.web.exposure.include

include属性列出了公开的端点的ID,

exclude属性列出了不应该公开的端点的ID

exclude属性优先于include属性。包含和排除属性都可以使用端点ID列表进行配置。

*可以用来选择所有端点。

例如,要通过HTTP公开除env和beans端点之外的所有内容,请使用以下属性:

management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env,beans

三、关闭鉴权

一般我们会将actuator和spring security鉴权组件结合使用,防止这些功能端口被随便调用。由于这里是功能演示,先放开actuator相关端口的权限认证。

What is the operation of SpringBoot to dynamically modify the log level?

此外,如果存在Spring Security,则需要添加自定义安全配置,以允许对端点进行未经身份验证的访问,如以下示例所示:放开所有Endpoint端点进行匹配

@Configuration
public class ActuatorSecurity extends WebSecurityConfigurerAdapter {
 
@Override
protected void configure(HttpSecurity http) throws Exception {
    http.requestMatcher(EndpointRequest.toAnyEndpoint()).authorizeRequests()
    .anyRequest().permitAll()
}

}

四 、通过/loggers端口查看日志级别

请求链接:http://localhost:8090/message/loggers

注意上面我说过的,我调整了management.endpoints.web.base-path=/message。如果没有设置此参数,则使用默认的/actuator去访问。

What is the operation of SpringBoot to dynamically modify the log level?

五、发起http请求修改日志级别

这里演示,修改目录com.wxswj.provider.message.controller的日志级别为debug

请求类型为POST,参数格式是JSON

curl -H "Content-Type: application/json" -X POST --data 
"
{
    "configuredLevel": "DEBUG"
}
" 
http://localhost:8090/message/loggers/com.wxswj.provider.message.controller

大家可以在服务器上通过curl发起http请求,或者通过Postman发起请求。

curl -H "Content-Type: application/json" -X POST --data "{"configuredLevel": "DEBUG"}" http://localhost:8090/loggers/com.wxswj.provider.message.controller

六、查询日志级别修改结果

http://localhost:8090/message/loggers/com.wxswj.provider.message.controller

{
"configuredLevel": "DEBUG",
"effectiveLevel": "DEBUG"
}

说明我们的修改日志级别的请求生效。

The above is the detailed content of What is the operation of SpringBoot to dynamically modify the log level?. For more information, please follow other related articles on the PHP Chinese website!

Statement:
This article is reproduced at:yisu.com. If there is any infringement, please contact admin@php.cn delete