springboot actuator自定义prometheus监控指标

已于 2023-04-08 20:03:51 修改
阅读量1.7k 收藏 9
点赞数
分类专栏： 工作工具 文章标签： spring boot promtheus
于 2021-08-25 14:42:25 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/noob9527/article/details/119911036
版权

pom.xml

		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>io.micrometer</groupId>
            <artifactId>micrometer-registry-prometheus</artifactId>
            <version>1.3.2</version>
        </dependency>

工具类HandleUtils

import io.micrometer.core.instrument.ImmutableTag;
import io.micrometer.core.instrument.Tag;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.CollectionUtils;

import java.util.List;

/**
 * 操作工具类
 */
public class HandleUtils {
    private static final Logger logger = LoggerFactory.getLogger(HandleUtils.class);

    /**
     * 组装tags
     *
     * @param tags 扩展tags
     * @return tags数组
     */
    public static String[] handelTag(List<Tag> tags) {
        if(CollectionUtils.isEmpty(tags)){
            return new String[0];
        }
        int size = tags.size() * 2 + 2 ;
        String[] tagArray = new String[size];
        int i = 0;
        for (Tag tag : tags) {
            tagArray[++i] = tag.getKey();
            tagArray[++i] = tag.getValue();
        }
        return tagArray;
    }

}

counter计数器

import com.iflytek.lingxi.actuator.client.micrometer.constant.MetricsConstants;
import com.iflytek.lingxi.actuator.client.micrometer.utils.HandleUtils;
import com.iflytek.lingxi.actuator.client.micrometer.utils.RegexUtils;
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.Tag;

import java.util.List;

/**
 * 介绍：
 * Counter(计数器) 一个增量为正数的单值计数器
 * <p>
 * 使用场景:
 * Counter的作用是记录XXX的总量或者计数值，适用于一些增长类型的统计，
 * 例如下单、支付次数、 Http请求总量记录等等，通过Tag可以区分不同的场景，
 * 对于下单，可以使用不同的Tag标记不同的业务来源或者是按日期划分，
 * 对于Http请求总量记录，可以使用Tag区分不同的URL
 *
 */
public class MetricsCounterService {

    /**
     * 计数器
     *
     * @param name 指标名称 （数字字母下划线组合）
     */
    public static Counter counter(String name) {
        return MetricsCounterService.counter(name, null);
    }

    /**
     * 计数器（可扩展tag）
     *
     * @param name 指标名称 （数字字母下划线组合）
     * @param tags 自定义tag
     */
    public static Counter counter(String name, List<Tag> tags) {
        // 参数校验
        RegexUtils.checkNameAndTag(name);
        // 组装tags
        String[] tagArray = HandleUtils.handelTag(tags);
        return Metrics.counter(MetricsConstants.NAME_PREFIX + name, tagArray);
    }
}

gauge仪表盘

import com.iflytek.lingxi.actuator.client.micrometer.constant.MetricsConstants;
import com.iflytek.lingxi.actuator.client.micrometer.utils.RegexUtils;
import io.micrometer.core.instrument.*;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.util.Base64Utils;
import org.springframework.util.CollectionUtils;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;

/**
 * @author lyz
 * @Title: CustomMetricsGaugeService
 * @date 2021/8/23 9:53
 */
@Slf4j
public class CustomMetricsGaugeService{

    private static ConcurrentHashMap<String, Number> cacheMap = new ConcurrentHashMap<String, Number>();

    /**
     * 仪表
     *
     * @param name 指标名称 （数字字母下划线组合）
     */
    public static <T extends Number> T gauge(String name, T number) {
        // 参数校验
        return gauge(name, new ArrayList<Tag>(), number);
    }

    /**
     * 非master移除所有监控指标
     */
    public static void removeAllMetrics(){
        cacheMap.clear();
        Metrics.globalRegistry.forEachMeter(item -> {
            Metrics.globalRegistry.remove(item);
        });
    }

    /**
     * gauge监控指标移除
     * @param appid
     * @param api
     */
    public static void removeGauge(String appid, String api){
        Metrics.globalRegistry.forEachMeter(item -> {
            String apiTag = item.getId().getTag("api");
            String appidTag = item.getId().getTag("appid");
            if (StringUtils.isNotBlank(apiTag) && StringUtils.isNotBlank(appidTag) && apiTag.equals(api) && appidTag.equals(appid)){
                log.info("删除监控指标,api:{},appid:{}", api, appid);
                Metrics.globalRegistry.remove(item);
	            String key = item.getId().getName();
	            for (Tag tag : item.getId().getTags()) {
	                key += tag.getKey() + tag.getValue();
	            }
	            String baseKey = Base64Utils.encodeToString(key.getBytes());
	            cacheMap.remove(baseKey);
            }
        });
    }

    /**
     * 仪表（可扩展tag）
     *
     * @param name 指标名称 （数字字母下划线组合）
     * @param tags 自定义tag
     */
    public static <T extends Number> T gauge(String name, List<Tag> tags, T number) {
        // 参数校验
        RegexUtils.checkNameAndTag(name);
        String key = MetricsConstants.NAME_PREFIX + name;
        if (!CollectionUtils.isEmpty(tags)) {
            for (Tag tag : tags) {
                key += tag.getKey() + tag.getValue();
            }
        }
        String baseKey = Base64Utils.encodeToString(key.getBytes());
        Number t = cacheMap.get(baseKey);
        if (t == null) {
            t = (T) Metrics.gauge(MetricsConstants.NAME_PREFIX + name, tags, number);
            cacheMap.put(baseKey, t);
        } else {
            t = ifNaNReSet(name, tags, number, baseKey, t);
        }
        return (T) t;
    }

    private static <T extends Number> Number ifNaNReSet(String name, List<Tag> tags, T number, String baseKey, Number t) {
        try{
            Gauge gauge = Metrics.globalRegistry.get(MetricsConstants.NAME_PREFIX + name).tags(tags).gauge();
            boolean isNaN = Double.isNaN(gauge.value());
            if (isNaN){
                Metrics.globalRegistry.remove(gauge);
                t = (T) Metrics.gauge(MetricsConstants.NAME_PREFIX + name, tags, number);
                cacheMap.put(baseKey, t);
            }
        } catch (Exception e){
            t = (T) Metrics.gauge(MetricsConstants.NAME_PREFIX + name, tags, number);
        }
        return t;
    }
}

Summary摘要

import com.iflytek.lingxi.actuator.client.micrometer.constant.MetricsConstants;
import com.iflytek.lingxi.actuator.client.micrometer.utils.HandleUtils;
import com.iflytek.lingxi.actuator.client.micrometer.utils.RegexUtils;
import io.micrometer.core.instrument.DistributionSummary;
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.Tag;

import java.util.List;

/**
 * 介绍：
 * Summary(摘要)用于跟踪事件的分布。
 * 它类似于一个计时器，但更一般的情况是，它的大小并不一定是一段时间的测量值。
 * 在micrometer中，对应的类是DistributionSummary，它的用法有点像Timer，
 * 但是记录的值是需要直接指定，而不是通过测量一个任务的执行时间。
 * <p>
 * 使用场景：
 * 1、记录指定方法的执行时间用于展示。
 * 2、记录一些任务的执行时间，从而确定某些数据来源的速率，例如消息队列消息的消费速率等。
 *
 */
public class MetricsSummaryService {
    /**
     * 计时器
     *
     * @param name 指标名称 （数字字母下划线组合）
     * @return Summary对象
     */
    public static DistributionSummary summary(String name) {
        return MetricsSummaryService.summary(name, null);
    }

    /**
     * 计时器 （可扩展tag）
     *
     * @param name 指标名称 （数字字母下划线组合）
     * @param tags 自定义tag
     * @return Summary对象
     */
    public static DistributionSummary summary(String name, List<Tag> tags) {
        // 参数校验
        RegexUtils.checkNameAndTag(name);
        // 组装tags
        String[] tagArray = HandleUtils.handelTag(tags);
        return Metrics.summary(MetricsConstants.NAME_PREFIX + name, tagArray);
    }
}

Timer计时器

import com.iflytek.lingxi.actuator.client.micrometer.constant.MetricsConstants;
import com.iflytek.lingxi.actuator.client.micrometer.utils.HandleUtils;
import com.iflytek.lingxi.actuator.client.micrometer.utils.RegexUtils;
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.Timer;

import java.util.List;

/**
 * 介绍：
 * Timer(计时器)同时测量一个特定的代码逻辑块的调用(执行)速度和它的时间分布。
 * 简单来说，就是在调用结束的时间点记录整个调用块执行的总时间，适用于测量短时间执行的事件的耗时分布，例如消息队列消息的消费速率。
 * <p>
 * 使用场景：
 * 1、记录指定方法的执行时间用于展示。
 * 2、记录一些任务的执行时间，从而确定某些数据来源的速率，例如消息队列消息的消费速率等。
 *
 */
public class MetricsTimerService {
    /**
     * 计时器
     *
     * @param name 指标名称 （数字字母下划线组合）
     * @return Timer对象
     */
    public static Timer timer(String name) {
        return MetricsTimerService.timer(name, null);
    }

    /**
     * 计时器 （可扩展tag）
     *
     * @param name 指标名称 （数字字母下划线组合）
     * @param tags 自定义tag
     * @return Timer对象
     */
    public static Timer timer(String name, List<Tag> tags) {
        // 参数校验
        RegexUtils.checkNameAndTag(name);
        // 组装tags
        String[] tagArray = HandleUtils.handelTag(tags);
        return Metrics.timer(MetricsConstants.NAME_PREFIX + name, tagArray);
    }
}

自定义操作

自动注入类PrometheusMetricsExportAutoConfiguration

根据该类源码可以看到，项目启动时已注入CollectorRegistry

@Autowired
    private CollectorRegistry collectorRegistry;

    public void test(){
        Enumeration<Collector.MetricFamilySamples> metricFamilySamplesEnumeration = this.collectorRegistry.metricFamilySamples();
        while (metricFamilySamplesEnumeration.hasMoreElements()){
            Collector.MetricFamilySamples metricFamilySamples = metricFamilySamplesEnumeration.nextElement();
            List<Collector.MetricFamilySamples.Sample> sampleList = metricFamilySamples.samples;
            for (Collector.MetricFamilySamples.Sample sample : sampleList) {
                if ("xxx".equals(sample.name)){
                    System.out.println(sample);

                }
            }
        }
    }

获取registry

Set<MeterRegistry> registrySet = Metrics.globalRegistry.getRegistries();
        for (MeterRegistry meterRegistry : registrySet) {
            if (meterRegistry instanceof PrometheusMeterRegistry){
                ((PrometheusMeterRegistry) meterRegistry).getPrometheusRegistry().unregister(meterRegistry.);
            }
        }

暴漏监控端点类

PrometheusScrapeEndpoint
周虽旧邦其命维新
关注
专栏目录
【微服务】springboot对接Prometheus指标监控使用详解
congge
07-07 9120
springboot对接Prometheus指标监控使用详解
实战|如何优雅地自定义Prometheus监控指标
无敌码农
03-26 3995
大家好！我是"无敌码农"，今天要和大家分享的是在实际工作中“如何优雅地自定义Prometheus监控指标”！目前大部分使用Spring Boot构建微服务体系的公司，大都在...
Prometheus实现自定义指标监控
YIYIYI
06-30 4619
Prometheus实现自定义指标监控
Java web应用性能分析之【自定义prometheus监控指标】
最新发布
为无为，事无事，味无味。
06-27 884
如果想开发一些通用型的监控指标，比如监控某一类方法或某一类接口的调用总次数，则通常的做法就是采用“过滤器”、“拦截器”或者“AOP”这样具备拦截功能的方法去实现。但我的建议是，如果不是万不得已，我不太推荐使用“过滤器”去做这样的事情，因为我认为它太过底层或者说太重了，而且在过滤器中，我们也不太方便去利用上层框架中已经封装好的一些内置对象；所以如果你想开发Http接口的监控指标，则建议你使用拦截器去做；如果你想开发方法的监控指标，那么则建议你使用AOP去做【只是个人理解，方法不唯一】
SpringBoot - 构建监控体系02_定义度量指标和 Actuator 端点
小工匠
05-30 1万+
文章目录PreActuator 中的度量指标Micrometer 度量库 Pre SpringBoot - 构建监控体系01_使用 Actuator 组件实现及扩展系统监控 我们引入了 Spring Boot Actuator 组件来满足 Spring Boot 应用程序的系统监控功能，并重点介绍了如何扩展常见的 Info 和 Health 监控端点的实现方法。 这一讲我们继续讨论如何扩展 Actuator 端点，但更多关注与度量指标相关的内容。同时，我们还将给出如何创建自定义 Actuator 的实现
指标定制：如何实现自定义度量指标和 Actuator 端点？
我乐了的博客
02-04 788
在日常开发过程中，扩展现有端点有时并不一定能满足业务需求，而自定义 Spring Boot Actuator 监控端点算是一种更灵活的方法。在这段代码中我们可以看到，MySystemEndpoint 主要通过系统环境变量获取所需监控信息。//端点 id//是否默认启动标志位这段代码中的 @Endpoint 注解主要用于设置端点 id 及是否默认启动的标志位。且在案例中，我们指定了 id 为“mysystem”，enableByDefault 标志为 true。
SpringBoot 教程核心功能-Actuator 指标监控
tian830937的专栏
04-27 475
未来每一个微服务在云上部署以后，我们都需要对其进行监控、追踪、审计、控制等。SpringBoot就抽取了Actuator场景，使得我们每个微服务快速引用即可获得生产级别的应用监控、审计等功能。
Prometheus 入门教程（七）：SpringBoot 实现自定义指标监控
陈树义
10-21 5813
点击蓝色“陈树义”关注我哟上篇文章我们已经可以在 Grafana 上看到对应的 SpringBoot 应用信息了，通过这些信息我们可以对 SpringBoot 应用有更全面的监控。但是如...
SpringBoot自定义prometheus监控
无人问津的博客
10-16 1万+
放干货之前容许我说一些废话（其实觉得也是干货） 从数据层面，可以把prometheus理解成一个简单的数据库，每个metrices可以配置不同的标签，对应着一系列数值，但是如果给这些数值赋予各种业务的，资源的，服务性能的意义，并结合AlertManager，prometheus简直是个神器啊 网上文章很多，入门比较容易，但是我本人学习的时候有个地方理解了比较久，在promethues的graph页...
Springboot应用整合Prometheus+Grafana进行自定义指标监控
m0_69860228的博客
05-09 3306
Springboot应用整合Prometheus+Grafana进行自定义指标监控 最近需要监控接口的请求数据P90,P99,平均耗时，接口参数包含userId的接口请求数据等等 第一步 创建一个springboot项目 pom文件 <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> ..
springboot Actuator整合prometheus并使用grafana可视化（prometheus，grafana使用docker搭建）
千里之行，始于足下
09-25 1133
springboot Actuator整合prometheus并使用grafana可视化 本地测试，基于docker搭建
Spring Boot 2.x监控数据可视化采用micrometer-registry-prometheus
思考、总结、专注
06-15 9184
参考文章： Spring Boot 2.x监控数据可视化(Actuator + Prometheus + Grafana手把手) https://blog.csdn.net/xudc0521/article/details/89916714 实战：micrometer+prometheus+grafana搭建Java程序的监控系统 https://blog.csdn.net...
spring boot actuator 1.X 接入prometheus
weixin_43511928的博客
02-21 623
设置management.context-path(与spring boot 2.X 默认值相同) 指定management.port，独立于业务端口 security.user.name、security.user.password配置账号密码(密码要使用强密码) 3 验证 http://localhost:8087/actuator/prometheus 访问接口，第一次需要输入账号、密码。prometheus.yml 新增 5 grafana 5.1 配置prometheus数据
SpringBoot+Actuator+Prometheus+Grafana进行可视化应用监控
qq_43657722的博客
12-20 2219
SpringBoot+Actuator+Prometheus+Grafana进行可视化应用监控
Spring Boot Actuator、Prometheus和Grafana监控实战
爱琴孩的博客
06-11 2802
在图表编辑器的Visualization选项卡下，你可以自定义图表的显示方式和样式。Grafana提供了多种图表类型，如折线图、饼图、柱状图等。选择适合你需求的图表类型，并根据需要调整颜色、轴标签等显示设置。除了Spring Boot Actuator提供的默认Metrics之外，还可以根据实际需求，自定义收集应用程序的其他性能指标。例如，可以监控业务指标（如订单数、用户注册数等）或者应用程序的自定义组件。通过自定义Metrics，可以更全面地了解应用程序的运行状况和性能表现。
Spring Boot 使用 Micrometer 集成 Prometheus 监控 Java 应用性能
热门推荐
哎_小羊的博客
09-15 6万+
Micrometer 为 Java 平台上的性能数据收集提供了一个通用的 API，它提供了多种度量指标类型（Timers、Guauges、Counters等），同时支持接入不同的监控系统，例如 Influxdb、Graphite、Prometheus 等。我们可以通过 Micrometer 收集 Java 性能数据，配合 Prometheus 监控系统实时获取数据，并最终在 Grafana 上展示出来，从而很容易实现应用的监控。
Spring Boot 应用可视化监控
风水道人
02-25 270
1、Spring Boot 应用暴露监控指标【版本 1.5.7.RELEASE】 首先，添加依赖如下依赖： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> 采集应用的指标信...
Spring Boot Actuator、Prometheus、Grafana
qq_37705525的博客
05-21 6864
Spring Boot Actuator、Prometheus、Grafana
SpringBoot集成Prometheus 自定义Prometheus的指标
04-20
要在Spring Boot中集成Prometheus并自定义Prometheus的指标，可以按照以下步骤进行操作： 1. 添加依赖：在Spring Boot项目的pom.xml文件中添加Prometheus相关的依赖。例如： ```xml <groupId>io.micrometer ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值