使用 Prometheus 和 Grafana 监控 Spring Boot 应用

2024-09-05 09:48
文章标签 java 使用 应用 spring boot 监控 prometheus grafana

本文主要是介绍使用 Prometheus 和 Grafana 监控 Spring Boot 应用，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

使用 Prometheus 和 Grafana 监控 Spring Boot 应用

监控 Spring Boot 应用的状态，以及一些自定义的业务数据

监控 Spring Boot 应用

  • 添加依赖 build.gradle
    compile('org.springframework.boot:spring-boot-starter-actuator')compile('io.micrometer:micrometer-core:1.5.1')compile('io.micrometer:micrometer-registry-prometheus:1.5.1')
  • 修改配置 application.properties

需要注意的是，management.metrics.tags.application这个参数一定要有，否则很多报表会因为没有这个tag不能正常显示

# Actuator
management.endpoints.web.exposure.include=*
# Prometheus
management.metrics.tags.application=${spring.application.name}
  • 添加 Prometheus 监控
- job_name: 'spring-prometheus'metrics_path: '/actuator/prometheus'scrape_interval: 5sstatic_configs:- targets:- host.docker.internal:8081
  • 配置 Grafana

从 Grafana Dashboard 市场查找 Spring Boot 的看板，复制 ID 导入到 Grafana 中，如 6756

导入之后发现有些数据不能正确显示，这是因为设置了变量，需要修改变量的值：

Dashboard Setting -> Variables，选择相应的变量进行修改，这里修改两个：applicaiton 和 instance

application

label_values(application)

instance

label_values(jvm_memory_used_bytes{application="$application"},instance)

springboot-grafana-dashboard-variable.png

这样，就可以实现 application 和 instance的联动，选择application后，instance中显示相应的应用的实例

springboot-grafana-dashboard.png

监控方法执行时间和数量

Prometheus 提供了时间和数量的监控指标，通过在定时任务上添加 @Counted和@Timed来监控数据；相关文档可以参考 The @Timed annotation

  • 注入切面的Bean
@EnableAspectJAutoProxy
@Configuration
public class PrometheusAspectConfig {@Beanpublic TimedAspect timedAspect(MeterRegistry registry) {return new TimedAspect(registry);}@Beanpublic CountedAspect countedAspect(MeterRegistry registry) {return new CountedAspect(registry);}
}
监控定时任务
  • 监控定时任务
@Slf4j
@Component
public class CustomScheduleTask {private static final Random random = new Random();@Scheduled(fixedDelay = 5000)@Timed(value = "custom_task_time", extraTags = {"name", "自定义定时任务"}, description = "自定义定时任务监控")public void customSchedule() throws InterruptedException {Thread.sleep(random.nextInt(5000));log.info("定时任务执行完成");}
}
  • 查看监控数据
curl localhost:8081/actuator/prometheus | grep custom_task
监控接口
  • controller
    @Timed@Counted@GetMapping("/timed")public Object timed() throws InterruptedException {return customService.timed(UUID.randomUUID().toString());}
  • 监控数据
curl localhost:8081/actuator/prometheus | grep method_time

自定义监控指标

通过自定义监控指标监控业务相关数据

监控类型

相关监控类型的文档可以参考 Metrics types
相关使用文档可以参考 Prometheus JVM Client

  • Counter

一个单调递增的累计计量，在重新启动时值会被置为0，可以用于统计请求数量，错误数量，任务完成的数量等；不能用Counter统计可以减少的值

  • Gauge

Gauge 表示可以任意增减的值，通常用于计量类似温度，CPU使用率这样的值，或者正在处理的请求数量这样可增可减的值

  • Histogram

统计直方图，通常用于统计请求的时间，响应body的大小等，并将其计数在可配置的存储桶中，它还提供所有观察值的总和

  • Summary

和 Histogram 类似，它在滑动时间窗口内计算可配置的分位数，详细区别可以参考 Histograms and summaries

自定义监控请求统计

添加统计数据

定义统计请求数据，分别统计请求的次数，错误的次数，相应的时间；可以使用 Filter来实现

@Component
@Slf4j
public class AccessMetricsFilter implements Filter {@Autowiredprivate CollectorRegistry collectorRegistry;@Value("${spring.application.name}")private String applicationName;private Counter totalCounter;private Counter errorCounter;private Histogram responseTime;@PostConstructprivate void init() {log.info("初始化counter");totalCounter = Counter.build("custom_request_total", "自定义请求次数统计").labelNames("application", "path").create();errorCounter = Counter.build("custom_request_error", "自定义请求错误次数统计").labelNames("application", "path").create();responseTime = Histogram.build("custom_response_time", "自定义请求响应时间").labelNames("application", "path").create();collectorRegistry.register(totalCounter);collectorRegistry.register(errorCounter);collectorRegistry.register(responseTime);}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();String path = request.getRequestURI();Histogram.Timer timer = responseTime.labels(applicationName, path).startTimer();try {filterChain.doFilter(servletRequest, servletResponse);} catch (Exception e) {errorCounter.labels(applicationName, path).inc();throw e;} finally {totalCounter.labels(applicationName, path).inc();timer.observeDuration();}}
}
  • 启动应用，访问接口后查看统计数据
curl localhost:8081/actuator/prometheus | grep custom_request# HELP custom_request_total 自定义请求次数统计
# TYPE custom_request_total counter
custom_request_total{path="/order",} 3.0
custom_request_total{path="/db",} 1004.0
custom_request_total{path="/actuator/prometheus",} 150.0
# HELP custom_request_error 自定义请求错误次数统计
# TYPE custom_request_error counter
添加监控看板
  • 现在要统计所有的错误请求次数，可以在 Prometheus的查询面板中查询：

springboot-custom-metrics-prometheus.png

这样，就可以得到相应的错误数据，接下来只需要在Grafana中展示就可以

  • 添加看板

添加一个 Dashboard，并添加一个 Panel，在 Panel 的 Metrics 中添加刚才的查询语句

springboot-custom-metrics-grafana-query.png

执行查询后，会看到有图表生成，变量的名称通过 Legend 字段指定，如这里是 custom_request_total{application="prometheus", instance="host.docker.internal:8081", job="spring-prometheus", path="/db"}，需要显示路径名称，即 path 的值，可以设置 Legend 为 {{path}}，这样会显示正确的名称

其他的显示单位，显示效果等以及面板的名称可以通过旁边的设置选项进行配置

prometheus-grafana-custom-dashboard-setting-panel-detail.png

  • 添加应用和实例变量

Dashboard Settings -> Variables

label_values(application)label_values(jvm_memory_used_bytes{application="$application"},instance)
  • 添加统计数据查询
# 请求总次数
sum(custom_request_total{application="$application",instance="$instance"})# 错误请求总次数
sum(custom_request_total{application="$application", instance="$instance"})# 每分钟请求次数
rate(custom_request_total{application="$application", instance="$instance"}[1m])# 每分钟错误请求次数
rate(custom_request_error{application="$application", instance="$instance"}[$__interval])

prometheus-grafana-custom-dashboard-result.png

  • 相关项目可以参考 Prometheus

这篇关于使用 Prometheus 和 Grafana 监控 Spring Boot 应用的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


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

相关文章

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
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
流媒体平台/视频监控/安防视频汇聚EasyCVR播放暂停后视频画面黑屏是什么原因？

流媒体平台/视频监控/安防视频汇聚EasyCVR播放暂停后视频画面黑屏是什么原因？

视频智能分析/视频监控/安防监控综合管理系统EasyCVR视频汇聚融合平台，是TSINGSEE青犀视频垂直深耕音视频流媒体技术、AI智能技术领域的杰出成果。该平台以其强大的视频处理、汇聚与融合能力，在构建全栈视频监控系统中展现出了独特的优势。视频监控管理系统EasyCVR平台内置了强大的视频解码、转码、压缩等技术，能够处理多种视频流格式，并以多种格式（RTMP、RTSP、HTTP-FLV、WebS
阅读更多...
中文分词jieba库的使用与实景应用（一）

中文分词jieba库的使用与实景应用（一）

知识星球：https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义： 精确模式（默认模式）： 全模式： 搜索引擎模式： paddle 模式（基于深度学习的分词模式）： 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取
阅读更多...
水位雨量在线监测系统概述及应用介绍

水位雨量在线监测系统概述及应用介绍

在当今社会，随着科技的飞速发展，各种智能监测系统已成为保障公共安全、促进资源管理和环境保护的重要工具。其中，水位雨量在线监测系统作为自然灾害预警、水资源管理及水利工程运行的关键技术，其重要性不言而喻。 一、水位雨量在线监测系统的基本原理 水位雨量在线监测系统主要由数据采集单元、数据传输网络、数据处理中心及用户终端四大部分构成，形成了一个完整的闭环系统。 数据采集单元：这是系统的“眼睛”，
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2