spring boot 项目 prometheus 自定义指标收集区分应用环境集群实例ip，使用 grafana 查询--方法耗时分位数指标

2024-09-02 06:36
文章标签 java ip 集群 使用 位数 自定义 方法 项目 查询 spring 实例 指标 boot 收集 prometheus 耗时 区分 grafana 应用环境

本文主要是介绍spring boot 项目 prometheus 自定义指标收集区分应用环境集群实例ip，使用 grafana 查询--方法耗时分位数指标，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

spring boot 项目 prometheus 自定义指标收集

auth

  1. @author JellyfishMIX - github / blog.jellyfishmix.com
  2. LICENSE LICENSE-2.0

说明

  1. 网上有很多 promehteus 和 grafana 配置，本文不再重复，只介绍自定义部分。
  2. 目前只介绍了分位数指标的收集和查询，常用于方法耗时的指标监控。

自定义指标收集

仅引入以下依赖，只能看到 spring actuator 相关指标，看不到自定义指标。

            <!-- spring-boot-actuator 依赖 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId><version>2.7.18</version></dependency><!-- prometheus 依赖，和 spring boot 版本需要搭配。spring boot 2.7 搭配 1.10.x 如需升级或降级 spring boot，可以对应 +- 0.1.0--><dependency><groupId>io.micrometer</groupId><artifactId>micrometer-registry-prometheus</artifactId><version>1.10.6</version></dependency>

application.properties 配置

根据需要自定义调整

spring.application.name=spring-boot-explore
server.port=8083
server.servlet.context-path=/explore
# ip:port/actuator/prometheus
management.server.port=9051
management.endpoints.web.exposure.include=*
management.metrics.tags.application=${spring.application.name}

自定义指标的收集需要引入额外依赖

            <!--自定义 prometheus 指标依赖--><dependency><groupId>io.prometheus</groupId><artifactId>simpleclient</artifactId><version>0.16.0</version></dependency><dependency><groupId>io.prometheus</groupId><artifactId>simpleclient_hotspot</artifactId><version>0.16.0</version></dependency><dependency><groupId>io.prometheus</groupId><artifactId>simpleclient_servlet</artifactId><version>0.16.0</version></dependency>

指标收集接口

按照 prometheus 的约定，客户端需要暴露一个接口供收集自定义指标。

import io.prometheus.client.exporter.MetricsServlet;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;/*** @author jellyfishmix* @date 2024/9/1 08:03*/
@Controller
@RequestMapping("/prometheus")
public class PrometheusExportController extends MetricsServlet {@RequestMapping("/exportMetric")@ResponseBodypublic void exportMetric(HttpServletRequest request, HttpServletResponse response) throws IOException {this.doGet(request, response);}
}

暴露后的自定义指标收集端口，路径是自己配置的:

image-20240901103532161

自定义指标示例

    private static final Counter DEMO_COUNTER = Counter.build().name("TestController_compute_counter_demo").help("demo of counter").labelNames("labelName1", "labelNameB").namespace("spring_boot_explore").register(DEFAULT_PROMETHEUS_REGISTRY);
namespace 方法

定义指标的前缀，不能包含中划线-，实际指标会带上 namespace 前缀，namespace 与 name 中间自动被下划线_拼接。

spring_boot_explore_TestController_compute_counter_demo
labelNames 方法

使用哦 Summary 举例，说明一下 Counter.build().labelNames() 方法，表示为此指标设置两个 label，分别命名为 labelName1 和 labelNameB。

.labelNames("labelName1", "labelNameB")

如果设置了 Counter.build().labelNames()，不能直接调用 counter.inc()，会抛 NullPointerException

// Convenience methods./*** Increment the counter with no labels by the given amount.** @throws IllegalArgumentException If amt is negative.*/public void inc(double amt) {noLabelsChild.inc(amt);}

需要调用 summary.labels(“abc”, “123”).observe()，labels 方法中的值表示构造 summary 指标时对应的 labelName 的值。

    @RequestMapping("/sayCounter")@ResponseBodypublic String sayCounter() {DEMO_COUNTER.labels("abc", "123").inc(1);return "hello summary";}

自定义指标区分应用、环境、集群、实例

记录指标的接口

通过 .namespace 和 .labelNames 区分 env 环境名, cluster 集群名, instance 实例信息(一般为ip)

import com.google.common.base.Stopwatch;
import com.jellyfishmix.springbootexplore.server.config.PropertiesLoader;
import io.prometheus.client.CollectorRegistry;
import io.prometheus.client.Counter;
import io.prometheus.client.Summary;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.TimeUnit;@RequestMapping("/test")
@Controller
public class TestController {private static final CollectorRegistry DEFAULT_PROMETHEUS_REGISTRY = CollectorRegistry.defaultRegistry;private static final String applicationName = PropertiesLoader.getProperty("spring.application.name");private static final String env = PropertiesLoader.getProperty("custom.application.env");private static final String cluster = PropertiesLoader.getProperty("custom.application.cluster");private static final Counter DEMO_COUNTER = Counter.build().name("TestController_compute_counter_demo").help("demo of counter")// env 环境名, cluster 集群名, instance 实例信息(一般为ip).labelNames("env", "cluster", "instance")// namespace 应用名.namespace(applicationName).register(DEFAULT_PROMETHEUS_REGISTRY);private static String instance = getLocalIpAddress();public static String getLocalIpAddress() {try {InetAddress localHost = InetAddress.getLocalHost();return localHost.getHostAddress();} catch (UnknownHostException e) {e.printStackTrace();return StringUtils.EMPTY;}}@RequestMapping("/sayCounter")@ResponseBodypublic String sayCounter() {// 对应 .labelNames 中的 env 环境名, cluster 集群名, instance 实例信息(一般为ip)DEMO_COUNTER.labels(env, cluster, instance).inc(1);return "hello counter";}
}

application.properties 配置，注意 prometheus 指标 namespace 不能用-，需要用_

spring.application.name=spring_boot_explore
custom.application.env=beta
custom.application.cluster=cluster_master
server.port=8083
server.servlet.context-path=/explore

由于 properties 配置无法通过 @Value 在静态方法/字段获取值，因此需要手动加载配置文件来获取 properties 值。

import org.apache.commons.lang3.StringUtils;
import java.io.FileInputStream;
import java.io.InputStream;
import java.lang.management.ManagementFactory;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Properties;/*** @author jellyfishmix* @date 2024/9/1 18:45*/
public class PropertiesLoader {private static Map<String, String> propertiesMap = new LinkedHashMap<>();/*** jvm 启动参数中指定 active profile*/private static final String ACTIVE_PROFILE_JVM_ARG_KEY_WORD = "spring.profiles.active=";static {load("application.properties");String activeProfile = null;// 先检查 jvm active profilevar jvmArgs = ManagementFactory.getRuntimeMXBean().getInputArguments();for (String arg : jvmArgs) {if (arg.contains(ACTIVE_PROFILE_JVM_ARG_KEY_WORD)) {int index = arg.indexOf("=");if (index!= -1) {activeProfile = arg.substring(index + 1);}break;}}// jvm 参数未指定 active profile，再尝试使用 application.properties 中指定的if (StringUtils.isEmpty(activeProfile)) {activeProfile = propertiesMap.get("spring.profiles.active");}if (StringUtils.isNotBlank(activeProfile)) {load("application-" + activeProfile + ".properties");}}public static void load(String fileName) {final Properties properties = new Properties();FileInputStream fis = null;InputStream is = null;// 两种加载方式，第一种根据文件路径加载try {fis = new FileInputStream(fileName);properties.load(fis);} catch (Throwable ignored) {// 如果失败了，使用类加载器去 classpath 加载try {final ClassLoader classLoader = PropertiesLoader.class.getClassLoader();is = classLoader.getResourceAsStream(fileName);properties.load(is);} catch (Exception ex) {// can record logreturn;}} finally {try {if (fis != null) {fis.close();}if (is != null) {is.close();}} catch (Throwable ignored) {// do nothing}}propertiesMap.putAll(new LinkedHashMap<String, String>((Map) properties));}public static String getProperty(String key) {return propertiesMap.get(key);}
}

区分应用，环境，集群的效果

image-20240901214356871

分位数指标

  1. prometheus 四种 metrics 类型中，如果不是对性能特别敏感的场景，推荐使用 summary。详情阅读:
    1. summary 和 histogram 指标的简单理解 https://blog.csdn.net/wtan825/article/details/94616813
    2. prometheus 四种 metric 类型介绍 https://prometheus.wang/promql/prometheus-metrics-types.html

使用 summary 监控方法耗时

import com.google.common.base.Stopwatch;
import com.jellyfishmix.springbootexplore.server.config.PropertiesLoader;
import io.prometheus.client.CollectorRegistry;
import io.prometheus.client.Counter;
import io.prometheus.client.Summary;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.TimeUnit;/*** @author jellyfishmix* @date 2024/1/3 23:18*/
@RequestMapping("/test")
@Controller
public class TestController {private static final CollectorRegistry DEFAULT_PROMETHEUS_REGISTRY = CollectorRegistry.defaultRegistry;private static final Summary DEMO_SUMMARY = Summary.build().name("TestController_compute_summary_demo").help("demo of summary").labelNames("labelName1", "labelNameB").quantile(0.5, 0.01).quantile(0.90, 0.01).quantile(0.99, 0.01).register(DEFAULT_PROMETHEUS_REGISTRY);@RequestMapping("/saySummary")@ResponseBodypublic String saySummary() {Stopwatch stopwatch = Stopwatch.createStarted();simulateInterfaceCall();var costMillis = stopwatch.elapsed().toMillis();DEMO_SUMMARY.labels("abc", "123").observe(costMillis);return "hello summary";}private static void simulateInterfaceCall() {// 模拟接口调用的随机耗时int randomDelay = ThreadLocalRandom.current().nextInt(100, 1000);try {TimeUnit.MILLISECONDS.sleep(randomDelay);} catch (InterruptedException e) {Thread.currentThread().interrupt();}}
}
quantile 方法
  1. 说明一下 Summary.build().quantile() 方法。
  2. .50 分位，误差 0.01，会把 [.49, .51] 范围内的指标计入 .50 分位，由于 summary 会在客户端把指标数记录下来，因此允许的误差越多，可以节约的内存占用越多。
  3. 其他分位以此类推。
# .50 分位，误差 0.01
.quantile(0.5, 0.01)
# .90 分位，误差 0.01
.quantile(0.90, 0.01)
# .99 分位，误差 0.01
.quantile(0.99, 0.01)

quantile 方法的详细说明可见 io.prometheus.client.Summary 的类注释，这里摘抄一段:

The Summary class provides different utility methods for observing values, like observe(double), startTimer() and Summary. Timer. observeDuration(), time(Callable), etc.
By default, Summary metrics provide the count and the sum. For example, if you measure latencies of a REST service, the count will tell you how often the REST service was called, and the sum will tell you the total aggregated response time. You can calculate the average response time using a Prometheus query dividing sum / count.
In addition to count and sum, you can configure a Summary to provide quantiles:Summary requestLatency = Summary. build().name("requests_latency_seconds").help("Request latency in seconds.").quantile(0.5, 0.01)    // 0.5 quantile (median) with 0.01 allowed error.quantile(0.95, 0.005)  // 0.95 quantile with 0.005 allowed error// ....register();As an example, a 0.95 quantile of 120ms tells you that 95% of the calls were faster than 120ms, and 5% of the calls were slower than 120ms.
Tracking exact quantiles require a large amount of memory, because all observations need to be stored in a sorted list. Therefore, we allow an error to significantly reduce memory usage.
In the example, the allowed error of 0.005 means that you will not get the exact 0.95 quantile, but anything between the 0.945 quantile and the 0.955 quantile.
Experiments show that the Summary typically needs to keep less than 100 samples to provide that precision, even if you have hundreds of millions of observations.

summary 分位数指标效果示例

image-20240901103720431

grafana 视图

grafana query 填写示例如下，注意正确的分位数查询写法是如下图红圈所示，在 metric 位置填写 quantile = 0.5(客户端收集时填写的具体分位数)。

Screenshot 2024-09-01 at 11.41.23

分位数查询错误示例: operations 中填写 quantile 是错误的写法，可以看到图中，通过 operations 计算出的和真实值差距很大。

Screenshot 2024-09-01 at 11.48.24

这篇关于spring boot 项目 prometheus 自定义指标收集区分应用环境集群实例ip，使用 grafana 查询--方法耗时分位数指标的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1129269。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
JS常用组件收集

JS常用组件收集

收集了一些平时遇到的前端比较优秀的组件，方便以后开发的时候查找！！！ 函数工具： Lodash 页面固定： stickUp、jQuery.Pin 轮播： unslider、swiper 开关: switch 复选框： icheck 气泡： grumble 隐藏元素： Headroom
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
服务器集群同步时间手记

服务器集群同步时间手记

1.时间服务器配置（必须root用户） （1）检查ntp是否安装 [root@node1 桌面]# rpm -qa|grep ntpntp-4.2.6p5-10.el6.centos.x86_64fontpackages-filesystem-1.41-1.1.el6.noarchntpdate-4.2.6p5-10.el6.centos.x86_64 （2）修改ntp配置文件 [r
阅读更多...
这15个Vue指令，让你的项目开发爽到爆

这15个Vue指令，让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件，按住 Control 和回车键再显示它吗？小菜一碟： <template
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2