Spring Cloud（四）：Actuator

雨点打透心脏的1/2处 2021-09-17 08:54 311阅读 0赞

## 概述 ##

*  **Spring-boot-starter-actuator** 是用于监控与管理的，只需引入依赖库就能为应用添加监控端点
 *  其中 **/health** 端点能够全面你检查应用监控状态

## 快速入门 ##

*  引入依赖库

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

*  控制台可看到 Actuator 为我们添加了许多端点

2017-12-22 14:13:14.781  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/env/{name:.*}],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EnvironmentMvcEndpoint.value(java.lang.String)
    2017-12-22 14:13:14.781  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/env || /env.json],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
    2017-12-22 14:13:14.782  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/heapdump || /heapdump.json],methods=[GET],produces=[application/octet-stream]}" onto public void org.springframework.boot.actuate.endpoint.mvc.HeapdumpMvcEndpoint.invoke(boolean,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse) throws java.io.IOException,javax.servlet.ServletException
    2017-12-22 14:13:14.783  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/info || /info.json],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
    2017-12-22 14:13:14.784  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/health || /health.json],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.HealthMvcEndpoint.invoke(javax.servlet.http.HttpServletRequest,java.security.Principal)
    2017-12-22 14:13:14.784  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/trace || /trace.json],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
    2017-12-22 14:13:14.785  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/features || /features.json],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
    2017-12-22 14:13:14.785  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/mappings || /mappings.json],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
    2017-12-22 14:13:14.786  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/auditevents || /auditevents.json],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public org.springframework.http.ResponseEntity<?> org.springframework.boot.actuate.endpoint.mvc.AuditEventsMvcEndpoint.findByPrincipalAndAfterAndType(java.lang.String,java.util.Date,java.lang.String)
    2017-12-22 14:13:14.786  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/configprops || /configprops.json],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
    2017-12-22 14:13:14.787  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/archaius || /archaius.json],methods=[GET],produces=[application/vnd.spring-boot.actuator.v1+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
    2017-12-22 14:13:14.787  INFO 9441 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/env],methods=[POST]}" onto public java.lang.Object org.springframework.cloud.context.environment.EnvironmentManagerMvcEndpoint.value(java.util.Map<java.lang.String, java.lang.String>)

*  比如访问 /health 端点，可以获得如下的应用健康信息

{"description":"Composite Discovery Client","status":"UP"}

## 常用端点 ##

*  某些端点属于敏感信息，需要关闭权限认证才能查看 **management.security.enabled=false**

<table> 
 <thead> 
  <tr> 
   <th style="text-align:center">URL</th> 
   <th style="text-align:center">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="text-align:center">/autoconfig</td> 
   <td style="text-align:center">该端点用于获取应用自动化配置报告，帮助我们方便的找到自动化配置为什么没有生效</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/beans</td> 
   <td style="text-align:center">描述上下文每个 bean 的情况，包括 Java 类型已经注入它的 bean，作用域等信息</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/enc</td> 
   <td style="text-align:center">应用程序可用的所有环境属性列表，无论这些属性是否用到，其中包括环境变量、JVM 属性、命令行参数，以及配置文件</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/configprops</td> 
   <td style="text-align:center">获取属性如何进行设置（注入或其它方式）</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/mappings</td> 
   <td style="text-align:center">罗列出应用程序的全部接口</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/metrics</td> 
   <td style="text-align:center">显示应用程序内存情况、线程池、JVM等信息</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/trace</td> 
   <td style="text-align:center">返回HTTP跟踪信息，保留最近 100 条请求，包括请求的方法、路径等详细信息</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/info</td> 
   <td style="text-align:center">显示应用的信息</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/health</td> 
   <td style="text-align:center">显示应用的监控信息</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/dump</td> 
   <td style="text-align:center">显示程序运行中的线程信息</td> 
  </tr> 
  <tr> 
   <td style="text-align:center">/shutdown</td> 
   <td style="text-align:center">通过该端点关闭应用程序的远程操作，需要在配置文件里开启 endpoints.shutdown.enabled=true</td> 
  </tr> 
 </tbody> 
</table>