关于actuator：搭建步骤，常用地endpoint

详细参考http://www.ityouknow.com/springboot/2018/02/06/spring-boot-actuator.html（非常完整、权威的资料）

说明

研究springboot的actuator

步骤

使用actuator的步骤（基于springboot 2.2.5.RELEASE 版本，如果比较老的版本，可能有些差异，比如在endpoint上我记得是直接访问/beans而不是/actuator/beans）

1. pom.xml中增加

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

2. 在配置文件 application.properties 中增加
   在 Spring Boot 2.x 中为了安全起见，如果不增加如下配置，Actuator 只开放了两个端点 /actuator/health 和 /actuator/info。

# 所有的endpoint打开
management.endpoints.web.exposure.include=*

3. 启动springboot，访问 http://localhost:8080/actuator/beans
   所有的接口都在/actuator/**下。如果我不想用/actuator/**，可以改，在配置文件中增加

# 如果不想用默认的/actuator/** 前缀，可以改，如使用/manage/**
management.endpoints.web.base-path=/manage

endpoint重复问题

/actuator/**，可能和自己定义的接口的endpoint一样，冲突了会怎么样? 能启动springboot，会覆盖，actuator的优先，为什么会覆盖? 是有点奇怪，正常情况下有重复的endpoint启动springboot时会报错

安全问题

怎么保证安全，要不然谁都可以访问/actuator/**? 可以结合spring security

优雅关闭springboot程序

通常我们不熟springboot项目，关闭都是使用kill 甚至是 kill -9，有没有一种优雅的方式呢? 答案就是使用actuator提供的关闭

使用时必须在application.properties中添加配置

# 启用优雅关闭程序，可以访问/actuator/shutdown（POST）
management.endpoint.shutdown.enabled=true

所谓的优不优雅，应该是说这种关闭不是突然就关掉，是会做一些善后，比如未处理完的请求先处理完成

支持的endpoint

Actuator 监控分成两类：原生端点和用户自定义端点；自定义端点主要是指扩展性，用户可以根据自己的实际应用，定义一些比较关心的指标，在运行期进行监控。

原生端点是在应用程序里提供众多 Web 接口，通过它们了解应用程序运行时的内部状况。原生端点又可以分成三类：

应用配置类：可以查看应用在运行期的静态信息：例如自动配置信息、加载的 springbean 信息、yml 文件配置信息、环境信息、请求映射信息；
度量指标类：主要是运行期的动态信息，例如堆栈、请求连、一些健康指标、metrics 信息等；
操作控制类：主要是指 shutdown,用户可以发送一个请求将应用的监控功能关闭。
Actuator 提供了 13 个接口，具体如下表所示。

HTTP 方法	路径	描述
GET	/auditevents	显示应用暴露的审计事件 (比如认证进入、订单失败)
GET	/beans	描述应用程序上下文里全部的 Bean，以及它们的关系
GET	/conditions	就是 1.0 的 /autoconfig ，提供一份自动配置生效的条件情况，记录哪些自动配置条件通过了，哪些没通过
GET	/configprops	描述配置属性(包含默认值)如何注入Bean
GET	/env	获取全部环境属性
GET	/env/{name}	根据名称获取特定的环境属性值
GET	/flyway	提供一份 Flyway 数据库迁移信息
GET	/liquidbase	显示Liquibase 数据库迁移的纤细信息
GET	/health	报告应用程序的健康指标，这些值由 HealthIndicator 的实现类提供
GET	/heapdump	dump 一份应用的 JVM 堆信息
GET	/httptrace	显示HTTP足迹，最近100个HTTP request/repsponse
GET	/info	获取应用程序的定制信息，这些信息由info打头的属性提供
GET	/logfile	返回log file中的内容(如果 logging.file 或者 logging.path 被设置)
GET	/loggers	显示和修改配置的loggers
GET	/metrics	报告各种应用程序度量信息，比如内存用量和HTTP请求计数
GET	/metrics/{name}	报告指定名称的应用程序度量值
GET	/scheduledtasks	展示应用中的定时任务信息
GET	/sessions	如果我们使用了 Spring Session 展示应用中的 HTTP sessions 信息
POST	/shutdown	关闭应用程序，要求endpoints.shutdown.enabled设置为true
GET	/mappings	描述全部的 URI路径，以及它们和控制器(包含Actuator端点)的映射关系
GET	/threaddump	获取线程活动的快照

是否可以定义自己的endpoint

可以的。上述13个叫做原生端点，也可以自定义端点

常用的端点

• /actuator/beans：查看有哪些bean实例化了
• /actuator/mappings：查看所有端点
• /actuator/env：查看正在生效的profile，配置（即例如application.properties里的一些变量）进程ID，运行的jdk/jre版本，操作系统，该springboot的jar包路径
• /actuator/env/{name}：跟/actuator/env的区别是，这个是仅仅查其中某个profile的，用于信息过多，需要过滤一下
• /actuator/heapdump：获得dump文件，我们可以使用 JDK 自带的 Jvm 监控工具 VisualVM 打开此文件查看内存快照
• /actuator/scheduledtasks：查看有没有定时任务