本文共 6921 字，大约阅读时间需要 23 分钟。

目录

第十一章 指标监控

11.1 SpringBootActuator

11.1.1 简介

   未来每一个微服务在云上部署以后，我们都需要对其进行监控、追踪、审计、控制等。SpringBoot就抽取了Actuator场景，使得我们每个微服务快速引用即可获得生产级别的应用监控、审计等功能。

<dependency>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-actuator</artifactId>

</dependency>

11.1.2 1.x与2.x的不同

11.1.3 如何使用

• 引入场景
• 访问**
• 暴露所有监控信息为HTTP

# management 是所有actuator的配置# management.endpoint.端点名.xxxx  对某个端点的具体配置management:  endpoints: #对所有端点    enabled-by-default: true  #默认开启所有监控端点true    web:      exposure:        include: '*' # 以web方式暴露所有端点

• 测试，如：
  • http://localhost:8080/actuator/beans
  • http://localhost:8080/actuator/configprops
  • http://localhost:8080/actuator/metrics
  • http://localhost:8080/actuator/metrics/jvm.gc.pause
  • http://localhost:8080/actuator/endpointName/detailPath

11.1.4 可视化SpringBoot Admin Server

11.2 Actuator Endpoint

11.2.1 最常使用的端点

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

   最常用的EndPoint：

• Health：监控状况
• Metrics：运行时指标
• Loggers：日志记录

11.2.2 Health Endpoint

   健康检查端点，我们一般用于在云平台，平台会定时的检查应用的健康状况，我们就需要Health Endpoint可以为平台返回当前应用的一系列组件健康状况的集合。重要的几点：

• health endpoint返回的结果，应该是一系列健康检查后的一个汇总报告，所有的组件都健康才健康
• 很多的健康检查默认已经自动配置好了，比如：数据库、redis等
• 可以很容易的添加自定义的健康检查机制

11.2.3 Metrics Endpoint

   提供详细的、层级的、空间指标信息，这些信息可以被pull(主动推送)或者push(被动获取)方式得到。

• 通过Metrics对接多种监控系统
• 简化核心Metrics开发
• 添加自定义Metrics或者扩展已有Metrics

11.2.4 管理Endpoints

11.2.4.1 开启与禁用Endpoints

• 默认所有的Endpoint除了shutdown都是开启的

• 需要开启或者禁用某个Endpoint，配置模式为
  • management.endpoint.<endpointName>.enabled = true

management:  endpoint:   #对某个端点的具体配置    health:      show-details: always      enabled: true

• 或者禁用所有的Endpoint，然后手动开启指定的Endpoint

management:  endpoints:    enabled-by-default: false  #关闭所有监控端点    web:      exposure:        include: '*'  endpoint:   #对某个端点的具体配置    health:      show-details: always      enabled: true    info:      enabled: true    beans:      enabled: true    metrics:      enabled: true

11.2.4.2 暴露Endpoints

   支持两种暴露方式：

• HTTP：默认只暴露health和info Endpoint
• JMX：默认暴露所有Endpoint，可以通过在cmd中使用jconsole来使用

   除了health和info，剩下的Endpoint都应该进行保护访问。如果引入SpringSecurity，则会默认配置安全访问规则

11.3 定制Endpoint

11.3.1 定制Health信息

   实现HealthIndicator接口。自定义类的后缀必须是HealthIndicator。

package com.atguigu.admin.acutuator.health;import org.springframework.boot.actuate.health.AbstractHealthIndicator;import org.springframework.boot.actuate.health.Health;import org.springframework.boot.actuate.health.Status;import org.springframework.stereotype.Component;import java.util.HashMap;import java.util.Map;@Componentpublic class MyComHealthIndicator extends AbstractHealthIndicator {//自定义类的后缀必须是HealthIndicator    /**     * 真实的检查方法     * @param builder     * @throws Exception     */    @Override    protected void doHealthCheck(Health.Builder builder) throws Exception {        //假设连接mongodb。  获取连接进行测试        Map
   
     map = new HashMap<>();        // 检查完成        if(1 == 1){//            builder.up(); //健康            builder.status(Status.UP);            map.put("count",1);            map.put("ms",100);        }else {//            builder.down();            builder.status(Status.OUT_OF_SERVICE);            map.put("err","连接超时");            map.put("ms",3000);        }        builder.withDetail("code",100)                .withDetails(map);    }}
   

11.3.2 定制info信息

   常用两种方式：

• 编写配置文件
• 编写InfoContributor

11.3.2.1 编写配置文件

info:  appName: boot-admin  appVersion: 1.0.0  mavenProjectName: @project.artifactId@ #获取pom文件里的内容  mavenProjectVersion: @project.version@

11.3.2.2 编写InfoContributor

@Componentpublic class AppInfoInfoContributor implements InfoContributor {    @Override    public void contribute(Info.Builder builder) {        builder.withDetail("msg","你好")                .withDetail("hello","xxx")                .withDetails(Collections.singletonMap("world","666600"));    }}

11.3.3 定制Metrics信息

11.3.3.1 SpringBoot支持自动适配的Metrics

• JVM metrics, report utilization of:

• • Various memory and buffer pools
  • Statistics related to garbage collection

• • Threads utilization
  • Number of classes loaded/unloaded

• CPU metrics
• File descriptor metrics

• Kafka consumer and producer metrics
• Log4j2 metrics: record the number of events logged to Log4j2 at each level

• Logback metrics: record the number of events logged to Logback at each level
• Uptime metrics: report a gauge for uptime and a fixed gauge representing the application’s absolute start time

• Tomcat metrics (server.tomcat.mbeanregistry.enabled must be set to true for all Tomcat metrics to be registered)
• metrics

11.3.3.2 增加定制Metrics

@Servicepublic class CityServiceImpl implements CityService {    @Autowired    CityMapper cityMapper;    Counter counter;    public CityServiceImpl(MeterRegistry meterRegistry){//自定义指标        counter = meterRegistry.counter("cityService.saveCity.count");    }    public City getById(Long id){        return cityMapper.getById(id);    }    public void saveCity(City city) {        counter.increment();//每一次调用这个方法，就把count加1        cityMapper.insert(city);    }}

   还有另一种方式，直接在容器中加入一个MeterBinder。

@BeanMeterBinder queueSize(Queue queue) {    return (registry) -> Gauge.builder("queueSize", queue::size).register(registry);}

11.4 定制Endpoints

@Component@Endpoint(id = "myservice")public class MyServiceEndPoint {    @ReadOperation //读方法    public Map getDockerInfo(){        //端点的读操作  http://localhost:8080/actuator/myservice        return Collections.singletonMap("dockerInfo","docker started.....");    }    @WriteOperation //操作方法    public void stopDocker(){        System.out.println("docker stopped.....");    }}

PS：根据尚硅谷课程整理，如有侵权，联系删除

转载地址：https://blog.csdn.net/xxyneymar/article/details/122808782 如侵犯您的版权，请留言回复原文章的地址，我们会给您删除此文章，给您带来不便请您谅解！