SpringBoot Actuator指标监控

量化接口stockapi

已于 2022-06-05 17:44:21 修改

阅读量251

点赞数

分类专栏： springboot 文章标签： spring boot java mongodb

于 2022-06-05 11:42:37 首次发布

本文链接：https://blog.csdn.net/u014496893/article/details/125129879

版权

springboot 专栏收录该内容

51 篇文章 0 订阅

订阅专栏

本文介绍了如何使用SpringBoot的Actuator模块实现微服务的监控、审计和控制。通过添加依赖和配置，我们可以轻松启用健康检查、信息展示和指标监控。此外，还展示了如何自定义健康检查、info信息和metrics信息，以适应额外组件的监控需求。

摘要由CSDN通过智能技术生成

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

引入actuator依赖：

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

添加配置信息

在application.yml中添加配置信息

#健康检查机制
#managemnet是所有actuator的配置
#managemnet.endpoints.断点名.xxx对某个端点的具体配置
management:
  endpoints:
    enabled-by-default: true #暴露所有端点信息
    web:
      exposure:
        include: '*'  #以web方式暴露
#健康检查每个详情
  endpoint:
    health:
      enabled: true
      show-details: always #总是显示详细信息。可显示每个模块的状态信息
    info:
      enabled: true
    beans:
      enabled: true
    metrics:
      enabled: true

启动项目输入地址：http://localhost:8080/actuator/health
返回数据如下：即可看到每个组件之间的健康状态，这些都是默认的组件
在这里插入图片描述
如果我们外加了一些其他组件，就需要自定义组件

定制 Health 信息

//自定义健康检查
@Component
public class MyComHealthIndicator extends AbstractHealthIndicator {
    /**
     * 真实的检查方法
     * @param builder
     * @throws Exception
     */
    @Override
    protected void doHealthCheck(Health.Builder builder) throws Exception {
        //mongodb。  获取连接进行测试
        Map<String,Object> map = new HashMap<>();
        // 检查完成
        if(1 == 2){
//            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);

    }

    @Override
    public Health getHealth(boolean includeDetails) {
        return super.getHealth(includeDetails);
    }
}

输入请求http://localhost:8080/actuator/health返回服务不可用
在这里插入图片描述

定制info信息

编写配置文件

info:
  appName: boot-admin
  version: 2.0.1
  mavenProjectName: @project.artifactId@  #使用@@可以获取maven的pom文件值
  mavenProjectVersion: @project.version@

import java.util.Collections;

import org.springframework.boot.actuate.info.Info;
import org.springframework.boot.actuate.info.InfoContributor;
import org.springframework.stereotype.Component;

@Component
public class ExampleInfoContributor implements InfoContributor {

    @Override
    public void contribute(Info.Builder builder) {
        builder.withDetail("example",
                Collections.singletonMap("key", "value"));
    }

}

输入http://localhost:8080/actuator/info 会输出以上方式返回的所有info信息
会看到所有合并后返回的结果，包括配置文件里面和自定义的信息

在这里插入图片描述

定制Metrics信息

SpringBoot支持自动适配的Metrics

class MyService{
    Counter counter;
    public MyService(MeterRegistry meterRegistry){
         counter = meterRegistry.counter("myservice.method.running.counter");
    }

    public void hello() {
        counter.increment();
    }
}


//也可以使用下面的方式
@Bean
MeterBinder queueSize(Queue queue) {
    return (registry) -> Gauge.builder("queueSize", queue::size).register(registry);
}