使用 Prometheus & Grafana 监控你的 Spring Boot 应用

准备工作

  • Prometheus v2.14.0
  • Grafana v6.5.0

使用 Docker 部署上面的基础环境,配置文件可见 docker-compose.yml,输入以下命令进行一键部署:

# 检查配置
docker-compose config
# 启动服务(-d 后台启动)
docker-compose up -d
# 停止并清除服务
docker-compose down

添加依赖项

pom.xml

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
  </dependency>

  <!-- 借助 Micrometer 对接 Prometheus 监控系统 -->
  <dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
  </dependency>
</dependencies>

application.yml

spring:
  application:
    name: monitoring-prometheus-grafana

management:
  endpoints:
    web:
      exposure:
        # 将 Actuator 的 /actuator/prometheus 端点暴露出来
        include: 'prometheus'
  metrics:
    tags: 
      application: ${spring.application.name}

logging:
  level:
    io.github.y0ngb1n.*: debug

使用方式

Step 1: 启动服务

$ mvn spring-boot:run
...
2019-12-08 22:28:11.916  INFO 36157 --- [           main] o.s.b.a.e.web.EndpointLinksResolver      : Exposing 1 endpoint(s) beneath base path '/actuator'
2019-12-08 22:28:12.045  INFO 36157 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2019-12-08 22:28:12.050  INFO 36157 --- [           main] i.g.y.m.p.PrometheusGrafanaApplication   : Started PrometheusGrafanaApplication in 20.638 seconds (JVM running for 27.154)

Step 2: 访问 /actuator/prometheus 端口

$ curl -sS http://127.0.0.1:8080/actuator/prometheus
# HELP jvm_gc_memory_promoted_bytes_total Count of positive increases in the size of the old generation memory pool before GC to after GC
# TYPE jvm_gc_memory_promoted_bytes_total counter
jvm_gc_memory_promoted_bytes_total{application="monitoring-prometheus-grafana",} 9986992.0
# HELP jvm_threads_daemon_threads The current number of live daemon threads
# TYPE jvm_threads_daemon_threads gauge
jvm_threads_daemon_threads{application="monitoring-prometheus-grafana",} 30.0
# HELP process_uptime_seconds The uptime of the Java virtual machine
# TYPE process_uptime_seconds gauge
process_uptime_seconds{application="monitoring-prometheus-grafana",} 75.133
...

将应用与 Prometheus 对接

添加 Prometheus 的配置文件:prometheus.yml

scrape_configs:
  # 任意写,建议英文,不要包含特殊字符
  - job_name: 'spring-boot-app'
    # 多久采集一次数据
    scrape_interval: 15s
    # 采集时的超时时间
    scrape_timeout: 10s
    # 采集的路径是啥
    metrics_path: '/actuator/prometheus'
    # 采集服务的地址,设置成 Spring Boot 应用所在服务器的具体地址
    static_configs:
      - targets: ['192.168.31.44:8080']

可使用 ifconfig 查看宿主机的 IP 地址,Prometheus 服务器就会自动每隔15秒请求 http://your-ip:8080/actuator/prometheus。更多配置参见 👉官方文档

测试访问 Prometheus

STEP 1:在浏览器中访问 http://localhost:9090

STEP 2:查看监控数据

  • 点击 Insert metric at cursor,即可选择监控指标;
  • 点击 Graph,即可让指标以图表方式展示;
  • 点击 Execute 按钮,即可看到类似下图的结果。
查看监控数据

集成 Grafana 可视化

前面已经使用 docker-compose 启动了 Grafana,下面进行配置。

STEP 1:在浏览器中访问 http://localhost:3000,并使用初始帐号 admin:admin 进行登录

Grafana Login Page

STEP 2:点击 Add Data Source 进行添加 Prometheus 数据源

Add Data Source
Prometheus Data Source
image.png

STEP 3:创建 Dashboard

New Dashboard
Add Query
  • 设置监控指标
Add Query
  • 设置 Dashboard 信息
Title
  • 保存 Dashboard
Save Dashboard

可以添加不同的指标,指标的取值详见 Spring Boot 应用的 /actuator/prometheus 端点。重复以上步骤操作,即可为 Dashboard 添加新的图表。

如果你觉得自己定制一个 Dashboard 过于复杂了,那你可以逛一下 Grafana 的 Dashboard 市场https://grafana.com/grafana/dashboards),这样就可以方便快捷地复用别人精美的 Dashboard 面板了。

Demo

参考资料


感谢您的阅读,本文由 杨斌的博客 版权所有。
如若转载,请注明出处:杨斌的博客(https://y0ngb1n.github.io?utm_source=jianshu

项目已托管于 GitHub:y0ngb1n/spring-boot-samples,欢迎 Star, Fork :kissing_heart:


©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,858评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,372评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,282评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,842评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,857评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,679评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,406评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,311评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,767评论 1 315
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,945评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,090评论 1 350
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,785评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,420评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,988评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,101评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,298评论 3 372
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,033评论 2 355

推荐阅读更多精彩内容