Spring Boot包含许多其他功能,可帮助您在将应用程序推送到生产环境时监视和管理应用程序。您可以选择使用HTTP端点或JMX来管理和监视应用程序。审核,运行状况和指标收集也可以自动应用于您的应用程序。
Spring Boot Actuator就是一款可以帮助你监控系统数据的框架,其可以监控很多很多的系统数据,如:
显示应用的健康信息
显示Info应用信息
显示HTTP跟踪信息
显示当前应用程序的“Metrics”信息
显示所有的@RequestMapping的路径信息
等等等等.....总之很成熟,很强大.
使用介绍:
1. 现在pom.xml中添加依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
对于Gradle,请使用以下声明:
dependencies {
compile("org.springframework.boot:spring-boot-starter-actuator")
}
2. 所有的监控端点endpoints介绍:
如果您的应用程序是Web应用程序(Spring MVC,Spring WebFlux或Jersey),则可以使用以下附加端点:
注意事项:
1. 在spring boot 2.0以后,actuator默认只开启了info和health端点,要想使用其他的端点,需要在application.yml中打开;
2. 而且所有的端点都以默认的路径http://localhost:8080/actuator 开始;
如我们查看info端点的信息就是访问:http://localhost:8080/actuator/info
3. Timestamps时间戳: 端点消耗的所有时间戳(作为查询参数或在请求正文中)必须格式化为ISO 8601中指定的偏移日期和时间 。 默认的时间戳是跟我们中国的时区不符合的.
4. actuator的大部分监控请求都是以get请求的.只有少数是post请求.
5. 如果想更改默认的actuator启动路径,可以在application.yml中这样:
#调整端点的前缀路径为/
management:
endpoints:
web:
base-path: /
另外要想开启所有的端点信息也是在application.yml中
management:
endpoints:
web:
exposure:
include:"*"
注意,在这里include: "*" ,这个""双引号是必须要,在application.properties是不需要""双引号的,application.properties中是这样的:management.endpoints.web.exposure.include=*
并且health端点的信息默认也是显示的不具体的,请看默认的health是显示的什么:
"UP"就是安全健康的,"DOWN"就是有问题了.
在application.yml中开启所有的Heanth监控数据:
management:
endpoint:
health:
show-details:always #显示健康具体信息 默认不会显示详细信息
我的application.yml是这样的:
现在你可以开启服务,试试这些端点的监控数据,因为我已经把监控的路径改成了http://localhost:8088了.所以可以直接在后面跟端点的名称,如果你没有更改路径,默认的启动路径是http://localhost:8088/actuator/,然后后面才跟你要监控的端点名称:
http://localhost:8088/mappings
端点Metrics监控的数据结果如下:
这些数据都是可以监控到的,"磁盘使用率",这个是我自定义的metrics端点信息,在下面的文章中我会教大家怎么自定义你想要的端点,如果你想看更具体的请在路径后面加上你要看的数据,如
http://localhost:8088/metrics/jvm.memory.used
自定义info信息:
在pom.xml中添加依赖,可以访问到pom.xml的信息,如果不加这个,你在application.yml中定义的info信息是不会获取到的:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>2.6</version>
<configuration>
<delimiters>
<delimiter>@</delimiter>
</delimiters>
<useDefaultDelimiters>false</useDefaultDelimiters>
</configuration>
</plugin>
在application.yml中这样配置:
访问http://localhost:8088/info,运行结果为:
但是如果你只想打开某个端点,我们是这样的配置的,同样式在application.yml中:
management:
endpoint:
端点名称:
enabled: true
使用Spring Security来保证Actuator Endpoints安全:
在pom.xml中添加依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
在application.yml中这样配置:
然后启动你的服务,你会发现有个登录页面,需要你输入我们配置的账号密码:
需要注意,spring boot2.0以后和之前的Security配置有所不同,我有一篇文章提到了!!!
自定义端点:
首先自定义健康监测的端点Health:
自定义健康监测的端点有两种方式:
1. 继承AbstractHealthIndicator类 2. 实现HealthIndicator接口。
自定义端点的文章 请看第二章节 谢谢支持