SpringBoot集成Prometheus

最近公司在推Prometheus,记录下如何与SpringBoot项目做整合。

Prometheus

上图均取自于Prometheus官网,关于Prometheus是什么怎么用,官网都有很清晰的说明。在其特征描述中可以看到:以调用HTTP接口的形式,拉取已经被收集好的时序数据。

简单来讲,业务集成Prometheus这个事情分为两步

  • 第一步业务方Prometheus tragets收集好指标metrics后,以接口的形式暴露出来。

  • 第二步Prometheus Server会对业务方暴露的接口发起HTTP调用pull metrics

最后Prometheus拿到业务方收集好的指标后,以图形化界面展示出来Prometheus web UI、Grafana

作为业务方,需要清楚如何收集自己服务的指标并以接口的形式暴露。初期接入Prometheus,考虑只收集一些系统级指标(业务级指标可根据官网文档自己实现)。而系统指标的收集(比如虚拟机线程、堆的使用情况),SpringBoot已经为我们提供了这个能力Spring Boot Actuator。

Spring Boot Actuator

在Spring官网有对Spring Boot Actuator的说明,最新的2.3.0.RELEASE文档。使用也很简单,引入依赖即可

org.springframework.boot spring-boot-starter-actuator

Spring Boot Actuator中存在Endpoints的概念

上图为官网给出的endpoints。比如常用的健康检查接口,以/actuator/health暴露,对应的endpoints为/health。在2.3.0.RELEASE版本中暴露的接口路径统一前缀为/actuator。由于这些endpoints都是服务内部敏感的接口,在2.3.0.RELEASE中默认只暴露/helath和/info接口,如果想暴露其他接口,需要在配置文件中开启。

开启暴露endpoints配置,例如/beans和/metrics

management: endpoints: web: exposure: include: - beans - metrics

其中的endpoints metrics暴露当前服务的指标,看起来很适合提供给Prometheus以获取指标。但是Prometheus对获取的指标数据格式是要求的,而metrics暴露的指标数据格式是JSON,与要求的指标格式不匹配。

不过Spring Boot Actuator在2.3.0.RELEASE版本中已经为我们考虑到了这一点(至于是从哪个版本开始支持的 =。=)

只需要引入micrometer-registry-prometheus的依赖即可,记得在配置文件中开启/prometheus接口的暴露

io.micrometer micrometer-registry-prometheus 1.5.1

简单demo

启动服务后,访问/actuator/prometheus接口,可以看到Micrometer替我们收集到的指标

2.3.0.RELEASE版本很顺利,但是问题来了,生产用的SpringBoot是1.5.4.RELEASE版本,而1.5.4.RELEASE版本文档没有提供对endpoints /prometheus的支持。最后在Micrometer官网找到了解决的办法。

Micrometer

Micrometer整合SpringBoot1.5.X版本的文档

文档中有详细描述SpringBoot1.5.X项目如何暴露Prometheus接口,只需要再引入Micrometer为低版本SpringBoot项目提供的适配依赖,注意版本一致

io.micrometer micrometer-registry-prometheus 1.0.5 io.micrometer micrometer-spring-legacy 1.0.5

简单demo

启动服务后,访问/prometheus接口,可以看到Micrometer收集到的指标

现在2.3.0.RELEASE和1.5.4.RELEASE版本的服务,都可以成功暴露出一个给Prometheus拉取指标的接口,只需要在Prometheus上进行配置即可在Prometheus WEB UI上看到效果。但生产环境的真实情况,不可能只收集一个服务的指标,是否再需要一个代理服务,该服务用来收集所有微服务的指标后,再统一暴露接口给Prometheus,需要再根据生产环境使用情况考虑。

相关推荐
美团技术团队19 小时前
美团 BI 在指标平台和分析引擎上的探索和实践
后端
JimmtButler19 小时前
我用 Claude Code 给 Claude Code 做了一个 DevTools
后端·claude
Java水解19 小时前
Java 中实现多租户架构:数据隔离策略与实践指南
java·后端
Master_Azur19 小时前
Java面向对象之多态与重写
后端
ywf121520 小时前
Spring Integration + MQTT
java·后端·spring
李白的粉20 小时前
基于springboot的知识管理系统
java·spring boot·毕业设计·课程设计·知识管理系统·源代码
武超杰20 小时前
SpringMVC核心功能详解:从RESTful到JSON数据处理
后端·json·restful
代龙涛21 小时前
WordPress 主题开发指南:模板文件、函数与页面选型规则
开发语言·后端·php·wordpress
三水不滴21 小时前
Elasticsearch 实战系列(二):SpringBoot 集成 Elasticsearch,从 0 到 1 实现商品搜索系统
经验分享·spring boot·笔记·后端·elasticsearch·搜索引擎
**蓝桉**21 小时前
prometheus监控docker容器(Rocky9)
docker·容器·prometheus