spring boot actuator监控

spring boot actuator介绍

• Spring Boot包含许多其他功能，可帮助您在将应用程序推送到生产环境时监视和管理应用程序。

• 您可以选择使用HTTP端点或JMX来管理和监视应用程序。

• 审核，运行状况和指标收集也可以自动应用于您的应用程序。

总之Spring Boot Actuator就是一款可以帮助你监控系统数据的框架,其可以监控很多很多的系统数据,它有对应用系统的自省和监控的集成功能，可以查看应用配置的详细信息,如:

• 显示应用程序员的Health健康信息

• 显示Info应用信息

• 显示HTTP Request跟踪信息

• 显示当前应用程序的“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介绍:

ID	描述
auditevents	公开当前应用程序的审核事件信息。
beans	显示应用程序中所有Spring bean的完整列表。
caches	暴露可用的缓存。
conditions	显示在配置和自动配置类上评估的条件以及它们匹配或不匹配的原因。
configprops	显示所有的整理列表@ConfigurationProperties,查看配置属性，包括默认配置
env	露出Spring的属性的各种环境变量,后面可跟/{name}查看具体的值
flyway	显示已应用的任何Flyway数据库迁移。
health	显示应用健康信息,在spring boot2.0以后需要在配置里show-details打开所有健康信息
httptrace	显示HTTP跟踪信息（默认情况下，最后100个HTTP请求 - 响应交换）,2.0以后需要手动打开
info	显示任意应用信息,是在配置文件里自己定义的
integrationgraph	显示Spring Integration图。
loggers	显示和修改应用程序中记录器的配置。
liquibase	显示已应用的任何Liquibase数据库迁移。
metrics	显示当前应用程序的“指标”信息,比如内存用量和HTTP请求计数,后可跟/{name}查看具体值
mappings	显示所有@RequestMapping路径的整理列表。
scheduledtasks	显示应用程序中的计划任务。
sessions	允许从Spring Session支持的会话存储中检索和删除用户会话。使用Spring Session对响应式Web应用程序的支持时不可用
shutdown	允许应用程序正常关闭。
threaddump	执行线程转储。

如果您的应用程序是Web应用程序（Spring MVC，Spring WebFlux或Jersey），则可以使用以下附加端点：

ID	描述
heapdump	返回hprof堆转储文件。
jolokia	通过HTTP公开JMX bean（当Jolokia在类路径上时，不适用于WebFlux）。
logfile	返回日志文件的内容（如果已设置logging.file或logging.path属性）。支持使用HTTP Range标头检索部分日志文件的内容。
prometheus	以可以由Prometheus服务器抓取的格式公开指标。

注意事项:

1. 在spring boot 2.0以后,actuator默认只开启了info和health两个端点,要想使用其他的端点,需要在application.yml中打开:

management:
   endpoints:
     web:
        exposure:
           include:"*"

注意:

在这里include: “*” ,这个"“双引号是必须要,在application.properties是不需要”"双引号的,application.properties中是这样的:management.endpoints.web.exposure.include=*

3. 而且所有的端点都以默认的路径http://localhost:8080/actuator 开始;

   如我们查看info端点的信息就是访问:http://localhost:8080/actuator/info

4. Timestamps时间戳: 端点消耗的所有时间戳（作为查询参数或在请求正文中）必须格式化为ISO 8601中指定的偏移日期和时间 。 默认的时间戳是跟我们中国的时区不符合的.

5. actuator的大部分监控请求都是以get请求的.只有少数是post请求.

6. 如果想更改默认的actuator启动路径,可以在application.yml中更改,如我们改成 http://localhost:8080/

#调整端点的前缀路径为/

management:

  endpoints:

     web:

        base-path: /

并且health端点的信息默认也是显示的不具体的,请看默认的health是显示的什么:

"UP"就是安全健康的,"DOWN"就是有问题了.

7. 在application.yml中开启所有的Heanth监控数据:

management:
endpoint:

     health:

        show-details:always  #显示健康具体信息  默认不会显示详细信息

我的application.yml是这样的:

现在你可以开启服务,试试这些端点的监控数据,因为我已经把监控的路径改成了 http://localhost:8088 了.所以可以直接在后面跟端点的名称,如果你没有更改路径,默认的启动路径是 http://localhost:8088/actuator/ ,然后后面才跟你要监控的端点名称:

http://localhost:8088/metrics

http://localhost:8088/mappings

端点Metrics监控的数据结果如下

这些数据都是可以监控到的,“磁盘使用率”,这个是我自定义的metrics端点信息,在下面的文章中我会教大家怎么自定义你想要的端点,如果你想看更具体的请在路径后面加上你要看的数据,/{name},如:
http://localhost:8088/metrics/jvm.memory.used

自定义info信息:

在pom.xml中添加依赖,可以访问到pom.xml的信息,如果不加这个,你在application.yml中定义的info信息是不会获取到的:

<plugin>
&lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;

&lt;artifactId&gt;maven-resources-plugin&lt;/artifactId&gt;

&lt;version&gt;2.6&lt;/version&gt;

&lt;configuration&gt;

    &lt;delimiters&gt;

        &lt;delimiter&gt;@&lt;/delimiter&gt;

    &lt;/delimiters&gt;

    &lt;useDefaultDelimiters&gt;false&lt;/useDefaultDelimiters&gt;

&lt;/configuration&gt;

</plugin>

在application.yml中这样配置:

#自定义info端点查看应用相关的信息
  info:
    encoding:
      @project.build.sourceEncoding@
    traget:
      @java.version@
    name:
      @project.name@
    description:
     @project.description@

 
 

 
 

访问 http://localhost:8088/info ,运行结果为:

但是如果你只想打开某个端点,我们是这样的配置的,同样式在application.yml中:

management:
endpoint:

      端点名称:

          enabled: true

使用Spring Security来保证Actuator Endpoints安全:

在pom.xml中添加依赖:

<dependency>
&lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;

&lt;artifactId&gt;spring-boot-starter-security&lt;/artifactId&gt;

</dependency>

• >

在application.yml中这样配置:这里是在spring boot2.0以后的版本中,在2.0之前不是这样的,稍微有差别:

 # http安全机制
    security:
      user:
        name: li
        password: 123
        roles: ADMIN

 
 

然后启动你的服务,你会发现有个登录页面,需要你输入我们配置的账号密码:

需要注意,spring boot2.0以后和之前的Security配置有所不同,我有一篇文章提到了!!!

自定义端点:

首先自定义健康监测的端点Health:

自定义健康监测的端点有两种方式:

1. 继承AbstractHealthIndicator类 2. 实现HealthIndicator接口。

自定义端点的文章 请看第二章节 谢谢支持