SpringBoot自动装配原理

SpringBoot的自定义Starter

Actuator(监控)

1. Actuator介绍

  通过前面的介绍我们明白了SpringBoot为什么能够很方便快捷的构建Web应用，那么应用部署上线后的健康问题怎么发现呢？在SpringBoot中给我们提供了Actuator来解决这个问题。

官网地址：https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html

Spring Boot includes a number of additional features to help you  monitor and manage your application when you push it to production. You  can choose to manage and monitor your application by using HTTP  endpoints or with JMX. Auditing, health, and metrics gathering can also  be automatically applied to your application.

Spring Boot包括许多附加特性，可以帮助您在将应用程序投入生产时监视和管理应用程序。您可以选择使用HTTP端点或使用JMX来管理和监视应用程序。审计、运行状况和度量收集也可以自动应用于您的应用程序。

  使用Actuator我们需要添加依赖

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

2.端点(Endpoints)

  执行器端点（endpoints）可用于监控应用及与应用进行交互，Spring Boot包含很多内置的端点，你也可以添加自己的。例如，health端点提供了应用的基本健康信息。

   每个端点都可以启用或禁用。这控制着端点是否被创建，并且它的bean是否存在于应用程序上下文中。要远程访问端点，还必须通过JMX或HTTP进行暴露,大部分应用选择HTTP，端点的ID映射到一个带/actuator前缀的URL。例如，health端点默认映射到/actuator/health。

注意：

  Spring Boot 2.0的端点基础路径由“/”调整到”/actuator”下,如：/info调整为/actuator/info 可以通过以下配置改为和旧版本一致:

management.endpoints.web.base-path=/

  默认在只放开了health和info两个 Endpoint。

  如果要放开更多的Endpoint，我们需要配置如下信息

management.endpoints.web.exposure.include=*

  以下是SpringBoot中提供的Endpoint。

  shutdown端点默认是关闭的，我们可以打开它

# 放开 shutdown 端点
management.endpoint.shutdown.enabled=true

  shutdown只支持post方式提交，我们可以使用POSTMAN来提交或者使用IDEA中提供的工具来提交。

  如果使用web应用(Spring MVC, Spring WebFlux, 或者 Jersey)，你还可以使用以下端点：

  现在我们看的health信息比较少，如果我们需要看更详细的信息，可以配置如下

# health 显示详情
management.endpoint.health.show-details=always

  再访问测试

  这样一来health不仅仅可以监控SpringBoot本身的状态，还可以监控其他组件的信息，比如我们开启Redis服务。

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

  添加Redis的配置信息

# Redis的 host 信息
spring.redis.host=192.168.100.120

  重启服务，查看 http://localhost:8080/actuator/health

3.监控类型

  介绍几个监控中比较重要的类型

3.1 health

  显示的系统的健康信息，这个在上面的案例中讲解的比较多，不再赘述。

3.2 metrics

  metrics 端点用来返回当前应用的各类重要度量指标，比如内存信息，线程信息，垃圾回收信息等。如下：

各个指标信息的详细描述：

如果要查看具体的度量信息的话，直接在访问地址后面加上度量信息即可：

http://localhost:8080/actuator/metrics/jvm.buffer.memory.used

添加自定义的统计指标

  除了使用metrics端点默认的这些统计指标外，我们还可以实现自定义统计指标，metrics提供了4中基本的度量类型：

• gauge 计量器，最简单的度量类型，只有一个简单的返回值，他用来记录一些对象或者事物的瞬时值。
• Counter 计数器 简单理解就是一种只增不减的计数器，它通常用于记录服务的请求数量，完成的任务数量，错误的发生数量
• Timer 计时器 可以同时测量一个特定的代码逻辑块的调用（执行）速度和它的时间分布。简单来说，就是在调用结束的时间点记录整个调用块执行的总时间，适用于测量短时间执行的事件的耗时分布，例如消息队列消息的消费速率。
• Summary 摘要）用于跟踪事件的分布。它类似于一个计时器，但更一般的情况是，它的大小并不一定是一段时间的测量值。在 micrometer 中，对应的类是 DistributionSummary，它的用法有点像 Timer，但是记录的值是需要直接指定，而不是通过测量一个任务的执行时间。

测试：

@RestController
public class UserController {
    static final Counter userCounter = Metrics.counter("user.counter.total","services","bobo");
    private Timer timer = Metrics.timer("user.test.timer","timer","timersample");
    private DistributionSummary summary = Metrics.summary("user.test.summary","summary","summarysample");
    @GetMapping("/hello")
    public String hello(){
        // Gauge
        Metrics.gauge("user.test.gauge",8);
        // Counter
        userCounter.increment(1);
        // timer
        timer.record(()->{
            try {
                Thread.sleep(3000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        });
        summary.record(2);
        summary.record(3);
        summary.record(4);
        return "Hello";
    }
}

访问 http://localhost:8080/hello 这个请求后在看 metrics 信息

多出了我们自定义的度量信息。

3.3 loggers

  loggers是用来查看当前项目每个包的日志级别的。

默认的是info级别。

修改日志级别：

发送POST请求到 http://localhost:8080/actuator/loggers/[包路径]

请求参数为

{
    "configuredLevel":"DEBUG"
}

通过POSTMAN来发送消息

然后再查看日志级别发现已经变动了

控制台也可以看到

3.4 info

  显示任意的应用信息。我们可以在 properties 中来定义

访问：http://localhost:8080/actuator/info

4.自定义Endpoint

  如果我们需要扩展Endpoint，这时我们可以自定义实现，我们可以在类的头部定义如下的注解

@Endpoint

@WebEndpoint

@ControllerEndpoint

@RestControllerEndpoint

@ServletEndpoint

  再给方法添加@ReadOperation，@ WritOperation或@DeleteOperation注释后，该方法将通过JMX自动公开，并且在Web应用程序中也通过HTTP公开。

于方法的注解有以下三种，分别对应get post delete 请求

案例：

/**
 * 自定义Endpoint
 */
@Component
@Endpoint(id = "sessions")
public class MyHealthEndPoint  {
    /**
    * @Selector 获取传递的参数
    */
    @ReadOperation
    public Info get(@Selector String name){
        return new Info(name,"18");
    }
}

5.Actuator的两种监控形态

• http
• jmx [Java Management Extensions] Java管理扩展

放开jmx

# 放开 jmx 的 endpoint
management.endpoints.jmx.exposure.include=*
spring.jmx.enabled=true

通过jdk中提供的jconsole来查看

6.监控系统

  SpringBoot可以收集监控数据，但是查看不是很方便，这时我们可以选择开源的监控系统来解决，比如Prometheus

• 数据采集
• 数据存储
• 可视化

  Prometheus在可视化方面效果不是很好，可以使用grafana来实现

6.1 Prometheus

  先来安装Prometheus：官网：https://prometheus.io/download/ 然后通过wget命令来直接下载

wget https://github.com/prometheus/prometheus/releases/download/v2.28.1/prometheus-2.28.1.linux-amd64.tar.gz

然后配置Prometheus。

  - job_name: 'Prometheus'
    static_configs:
    metrics_path: '/actuator/prometheus'
    scrape_interval: 5s
    - targets: ['192.168.127.1:8080']
      labels:
        instance: Prometheus

• job_name：任务名称
• metrics_path： 指标路径
• targets：实例地址/项目地址，可配置多个
• scrape_interval： 多久采集一次
• scrape_timeout： 采集超时时间

执行脚本启动应用

./prometheus --config.file=prometheus.yml

访问应用： http://ip:9090

然后在我们的SpringBoot服务中添加 Prometheus的端点,先添加必要的依赖

<dependency>
            <groupId>io.micrometer</groupId>
            <artifactId>micrometer-registry-prometheus</artifactId>
        </dependency>

然后就会有该端点信息

Prometheus服务器可以周期性的爬取这个endpoint来获取metrics数据,然后可以看到

6.2 Grafana

  可视化工具：https://grafana.com/grafana/download

通过wget命令下载

wget https://dl.grafana.com/oss/release/grafana-8.0.6-1.x86_64.rpm
sudo yum install grafana-8.0.6-1.x86_64.rpm

启动命令

sudo service grafana-server start
sudo service grafana-server status

访问的地址是 http://ip:3000 默认的帐号密码 admin/admin

登录进来后的页面

添加数据源：

添加Dashboards https://grafana.com/grafana/dashboards 搜索SpringBoot的 Dashboards

找到Dashboards的ID

然后导入即可

点击Load出现如下界面

然后就可以看到对应的监控数据了

到此Actuator的相关内容就介绍完了!!!