SpringBoot 项目中集成 Prometheus 和 Grafana
创始人
2024-05-29 21:07:03
0

项目上线后,除了能保障正常运行以外,也需要服务运行的各个指标进行监控,例如 服务器CPU、内存使用占比,Full GC 执行时间等,针对一些指标出现异常,可以加入一些报警机制能及时反馈给开发运维。这样,对于一些突发异常,能提前预知、并及时修复,避免服务宕机造成的损失。

针对 SpringBoot 项目,Spring 团队提供了对应 stater , spring-boot-actuator 模块通过 HTTP endpoints 来获取 SpringBoot 项目中的审计、健康状况以及一些配置项、容器注册 bean 以及heapdump 等信息,

actuator 通过开放 http 接口方式来表示各个指标详情,但这种方式并不直观,并且针对一些指标阈值并没有提供一些报警规则,因此需要引入另外一个服务Prometheus ,专用于事件监视以及报警的开源工具。

Prometheus 指标是基于事件戳方式进行记录的,通过 key、value 方式存储,记录指标在时间维度方面颗粒度更小;除了Prometheus 外,针对指标可视化还需要一个工具Grafana,专用于数据查询、以及指标可视化

SpringBoot

创建一个 SpringBoot 项目,加入 spring-boot-starter-actuator 以及 micrometer-registry-prometheus 依赖,对外暴露 /actuator/permetheus 端口服务,让Prometheus 用于数据抓取;

项目 pom 依赖


4.0.0org.springframework.bootspring-boot-starter-parent2.1.8.RELEASE com.exampledemo0.0.1-SNAPSHOTdemoDemo project for Spring Boot1.8org.springframework.bootspring-boot-starter-webcom.alibabadruid-spring-boot-starter1.1.17mysqlmysql-connector-java8.0.15org.springframework.bootspring-boot-starter-data-jpaorg.springframework.bootspring-boot-starter-actuatorio.micrometermicrometer-registry-prometheusorg.projectlomboklomboktrueorg.springframework.bootspring-boot-starter-testtestorg.springframework.bootspring-boot-maven-plugin2.1.8.RELEASEorg.projectlomboklombok

服务 yml 配置项,除了将 actuator 的 metrics、health 等接口暴露给 prometheus 服务外,服务还加入了 druid 数据连接池,监控 MYSQL数据库的运行,密码是经过 Druid 加密后处理的。

server:port: 8082spring:application:name: metricsLocalAppredis:host: localhostport: 6379password: 123456datasource:url: jdbc:mysql://localhost:3306/xxx?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&useSSL=falseusername: rootpassword: YjHh36LKJ62yxE9RhYVQLDDWK2QseZ/S7OgtBC7sv1Yzi6YLUOZMN8BcFrAbzLJmjXtmXW2f9nISSReTob+qZQ==driver-class-name: com.mysql.cj.jdbc.Driver#    开启druid驱动type: com.alibaba.druid.pool.DruidDataSourcedruid:filter:config:enabled: true#      初始化建立物理连接个数initial-size: 3#      最凶奥连接池min-idle: 3#      连接池最大连接数max-active: 20# 获取连接时最大等待时间,单位毫秒max-wait: 60000# 申请连接的时候检测,如果空闲时间大于timeBetweenEvictionRunsMillis,执行validationQuery检测连接是否有效。test-while-idle: true# 既作为检测的间隔时间又作为testWhileIdel执行的依据time-between-connect-error-millis: 60000# 销毁线程时检测当前连接的最后活动时间和当前时间差大于该值时,关闭当前连接min-evictable-idle-time-millis: 30000# 用来检测连接是否有效的sql 必须是一个查询语句# mysql中为 select 'x'# oracle中为 select 1 from dualvalidation-query: select 'x'# 申请连接时会执行validationQuery检测连接是否有效,开启会降低性能,默认为truetest-on-borrow: false# 归还连接时会执行validationQuery检测连接是否有效,开启会降低性能,默认为truetest-on-return: false# 是否缓存preparedStatement,mysql5.5+建议开启pool-prepared-statements: true# 当值大于0时poolPreparedStatements会自动修改为truemax-pool-prepared-statement-per-connection-size: 20# 合并多个DruidDataSource的监控数据use-global-data-source-stat: false# 配置扩展插件filters: stat,wall,slf4j# 通过connectProperties属性来打开mergeSql功能;慢SQL记录connect-properties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=2000# 定时输出统计信息到日志中,并每次输出日志会导致清零(reset)连接池相关的计数器。time-between-log-stats-millis: 300000# 配置DruidStatFilterweb-stat-filter:enabled: trueurl-pattern: '/*'exclusions: '*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*'# 配置DruidStatViewServletstat-view-servlet:# 是否启用StatViewServlet(监控页面)默认值为false(考虑到安全问题默认并未启动,如需启用建议设置密码或白名单以保障安全)url-pattern: '/druid/*'# 禁用HTML页面上的“Reset All”功能reset-enable: false
#        # druid登录名login-username: admin# 登录密码login-password: adminenabled: trueconnection-properties: config.decrypt=true;config.decrypt.key=MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAOuIUu/iVnxlfq9EYCmu9CVVEYrjwMjI8/DZ7zMwVnLov9cNxRnK3TV94SDL6p5C0EjFx1NKW5ntJwVoe8jZxV8CAwEAAQ==management:server:port: 9001
#  开启 actator 服务endpoints:web:exposure:include: '*'
# 暴露 metrics 端口endpoint:metrics:enabled: true
#    配置 prometheus 服务prometheus:enabled: truemetrics:export:prometheus:enabled: truetags:application: ${spring.application.name}

此外,SpringBoot启动入口,将服务名注册到 micrometer 中的 application,用于prometheus 数据抓取

@SpringBootApplication
public class DemoApplication {public static void main(String[] args) {SpringApplication.run(DemoApplication.class, args);}@BeanMeterRegistryCustomizer configurer(@Value("${spring.application.name}") String applicationName){return (registry) -> registry.config().commonTags("application",applicationName);}
}

项目启动,浏览器输入 http://localhost:9001/actuator/prometheus,就可以看到如下基本指标,包含jvm、tomcat 以及 系统cpu、线程及内存信息

image-20230306212012208

Prometheus 配置

以下操作,都以假设你的电脑已经安装好 Docker 工具为前提;

本机环境 OS :Windows10

  • 1,从dockerhub 拉取 prometheus 镜像
docker pull prom/prometheus:v2.37.5
  • 2,在合适文件中创建 prometheus.yml 配置文件
global:
# 数据抓取频率scrape_interval:     60s# 数据评估频率evaluation_interval: 60s# 抓取配置项 
scrape_configs:# 指定 springboot name标签- job_name: "metricsLocalApp"# 设定metrics 的路径metrics_path: "/actuator/prometheus"static_configs:# 配置目标关联 host,如果是本机的话,建议用  内网ip,而不用 localhost;- targets: ['192.168.0.108:9001']

3,打开 terminal,启动刚刚拉取的 permetheus 镜像;注意 D:/programCoding/Docker/permetheus/config/prometheus.yml 为我的电脑中 permetheus 的安装路径,这里目的是要挂载到镜像中的配置文件夹中;

docker run  -d -p 9090:9090 -v D:/programCoding/Docker/permetheus/config/prometheus.yml:/etc/prometheus/prometheus.yml  prom/prometheus:v2.37.5

镜像启动成功后,浏览器输入http://localhost:9090,点击上方菜单栏中的 status 下选框,点击 Targets,就能看到类似于下面的页面效果;第一个对应上文中的 SpringBoot 项目;

image-20230306215345279

Grafana 安装

prometheus 配置完成之后,下面需要配置 Grafana ,这里也是借助 Docker 镜像;

  • docker 拉取 grafana 镜像
docker pull grafana/grafana:9.2.13
  • 运行镜像
docker run -d -p 3000:3000 --name=grafana -v D:/programCoding/Docker/grafana/storage:/var/lib/grafana grafana/grafana:9.2.13

启动成功后,浏览器输入http://localhost:3000;Grafana 初始账号和密码都为 admin

image-20230306220449444

首先,创建数据源

image-20230306220715005

然后,创建dashboard

image-20230306220909194

选取数据源,指定metrics 指标

image-20230306221454379

然后 Grafana 就能根据你的设置,生成N个可视化面板。

image-20230306221832943

相关内容

热门资讯

二年级主持词 二年级主持词  主持词分为会议主持词、晚会主持词、活动主持词、婚庆主持词等。在一步步向前发展的社会中...
年会的主持词 年会的主持词范文(通用5篇)  根据活动对象的不同,需要设置不同的主持词。时代不断在进步,主持词是活...
姨妈的后现代生活经典台词分享 姨妈的后现代生活经典台词分享  吉日良辰当欢笑,为什么鲛珠化泪抛?此时却又明白了,世上何尝尽富豪。也...
学校语文教研活动主持词 学校语文教研活动主持词  借鉴诗词和散文诗是主持词的一种写作手法。在一步步向前发展的社会中,很多晚会...
六一庆祝大会主持词 六一庆祝大会主持词  六一就是我们的节日,六一就是一个欢乐的日子,下面小编整理的六一庆祝大会主持词,...
婚礼感谢词 婚礼感谢词(15篇)婚礼感谢词1各位来宾,各位亲友:  大家晚上好!  今日是我女儿XXX和女婿XX...
文艺汇演主持词开场白 文艺汇演主持词开场白9篇  根据活动对象的不同,需要设置不同的主持词。我们眼下的社会,活动集会越来越...
总结大会主持词   导语:春去秋回又一栽,似水流年旺年来。  2017年公司年会主持词  一.主持人开场白  男:一...
农村结婚典礼主持词 农村结婚典礼主持词  一对新人立堂前,两心相印似蜜甜,三生有幸结良缘,下面是小编分享的 农村结婚典礼...
春节联欢晚会主持词开场白   翻开精美的日历,我细数着春节将要来临。那是我们中华民族的传统节日,更是我期盼的佳节,因为只有这几...
真爱至上中英文经典台词 真爱至上中英文经典台词  1、All I want for Christmas is you.  今...
欢聚一堂舞蹈主持词 欢聚一堂舞蹈主持词  串词是在晚会、联欢会等大型联欢活动中,主持人把前后节目,把整台节目恰到好处的联...
主持词结束语 主持词结束语(通用12篇)  利用在中国拥有几千年文化的诗词能够有效提高主持词的感染力。在人们越来越...
秋季小学开学典礼校长的致辞 秋季小学开学典礼校长的致辞(通用13篇)  在学习、工作、生活中,许多人都有过写致辞的经历,对致辞都...
五月的主持词开场白 五月的主持词开场白  主持人在台上表演的灵魂就表现在主持词中。在当下这个社会中,各种场合中活跃现场气...
重阳节优秀致辞 重阳节优秀致辞范文  无论是身处学校还是步入社会,大家都用到过致辞吧,在各种重大的庆典、外交、纪念活...
QQ群晚会开幕词 QQ群晚会开幕词  QQ群晚会开幕词    尊贵的各位嘉宾,群主,各位管理,群友们大家晚上好:   ...
主持谢幕词 主持谢幕词范本  篇一:主持谢幕词  愿一切荣耀、尊贵、颂赞都归给至高上帝!  都说“台上一分钟,台...
圣诞节联欢晚会主持词 圣诞节联欢晚会主持词  主持词的写作需要将主题贯穿于所有节目之中。在一步步向前发展的社会中,主持词与...
元宵节的主持词 元宵节的主持词  一般在节日的时候,都是会举行一些活动的,尤其是在元宵节这个大型的节日。下面是小编为...