点击上方“芋道源码”,选择“设为星标”
管她前浪,还是后浪?
能浪的浪,才是好浪!
每天 10:33 更新文章,每天掉亿点点头发...
源码精品专栏
背景
SpringBoot的应用监控方案比较多,SpringBoot+Prometheus+Grafana是目前比较常用的方案之一。它们三者之间的关系大概如下图:
![7fd059098c1807210f0421075e8d9197.png](https://i-blog.csdnimg.cn/blog_migrate/8bf95203c0d644a91f739445038e1951.png)
基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能。
项目地址:https://github.com/YunaiV/ruoyi-vue-pro
开发SpringBoot应用
首先,创建一个SpringBoot项目,pom文件如下:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>io.prometheus</groupId>
<artifactId>simpleclient_spring_boot</artifactId>
<version>0.8.1</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
注意:这里的SpringBoot版本是1.5.7.RELEASE,之所以不用最新的2.X是因为最新的simpleclient_spring_boot只支持1.5.X,不确定2.X版本的能否支持。
MonitorDemoApplication启动类增加注解
@EnablePrometheusEndpoint
@EnableSpringBootMetricsCollector
@SpringBootApplication
public class MonitorDemoApplication {
public static void main(String[] args) {
SpringApplication.run(MonitorDemoApplication.class, args);
}
}
配置文件application.yml
server:
port: 8848
spring:
application:
name: monitor-demo
security:
user:
name: admin
password: 1234
basic:
enabled: true
# 安全路径列表,逗号分隔,此处只针对/admin路径进行认证
path: /admin
> 基于微服务的思想,构建在 B2C 电商场景下的项目实战。核心技术栈,是 Spring Boot + Dubbo 。未来,会重构成 Spring Cloud Alibaba 。
>
> 项目地址:<https://github.com/YunaiV/onemall>
# actuator暴露接口的前缀
management:
context-path: /admin
# actuator暴露接口使用的端口,为了和api接口使用的端口进行分离
port: 8888
security:
enabled: true
roles: SUPERUSER
测试代码TestController
@RequestMapping("/heap/test")
@RestController
public class TestController {
public static final Map<String, Object> map = new ConcurrentHashMap<>();
@RequestMapping("")
public String testHeapUsed() {
for (int i = 0; i < 10000000; i++) {
map.put(i + "", new Object());
}
return "ok";
}
}
这里的逻辑就是在请求这个接口后,创建大量对象保存到map中增加堆内存使用量,方便后面测试邮件报警。
启动项目后,可以在IDEA中看到有很多Endpoints,如图:
![b1af91d017f30a38bead1d48e0f486f5.png](https://i-blog.csdnimg.cn/blog_migrate/aea5a561b607555c105c4c1d0ef87756.png)
开始我的IDEA是不显示这个Endpoints,后来发现是我使用的idea版本太老了,还是2017.1的,
而这个需要 idea2017.2版本以上才能看到。
后来只好重新下载安装,弄了好久。
启动完毕,访问http://localhost:8888/admin/prometheus就可以看到服务暴露的那些监控指标了。
![0bebe76ac213a941147a8ad1efc96224.png](https://i-blog.csdnimg.cn/blog_migrate/1831ee323f9b7bdce35a66923c0cfde3.png)
监控指标
注意:
由于开启了安全认证,所以访问这个URL的需要提示输入账号/密码,如果提示404请检查下你的请求地址是否正确,如果不设置management.context-path则默认地址是http://ip:port/prometheus
安装Prometheus
本文下载的是Windows版本prometheus-2.17.2.windows-amd64.tar.gz。
下载地址:https://prometheus.io/download/
解压后修改prometheus.yml文件,配置数据采集的目标信息。
scrape_configs:
# The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
# - job_name: 'prometheus'
# metrics_path defaults to '/metrics'
# scheme defaults to 'http'.
# static_configs:
# - targets: ['localhost:9090']
- job_name: 'monitor-demo'
scrape_interval: 5s # 刮取的时间间隔
scrape_timeout: 5s
metrics_path: /admin/prometheus
scheme: http
basic_auth: #认证信息
username: admin
password: 1234
static_configs:
- targets:
- 127.0.0.1:8888 #此处填写 Spring Boot 应用的 IP + 端口号
更多配置信息请查看官方文档。
现在可以启动Prometheus了,命令行输入:
prometheus.exe --config.file=prometheus.yml
访问http://localhost:9090/targets,查看Spring Boot采集状态是否正常。
![ef40c560f3c7a4a4e29918a24fe68960.png](https://i-blog.csdnimg.cn/blog_migrate/4c1d2186408cc88fa20a5fb62868b74e.png)
采集目标信息
安装Grafana
本文用到的是Windows版本grafana-6.3.3.windows-amd64.zip。
下载地址:https://grafana.com/grafana/download
解压后运行bin目录下的grafana-server.exe启动,游览器访问http://localhost:3000即可看到登录页面,默认账号密码是admin/admin。
现在开始创建自己的可视化监控面板。
1.设置数据源
![d11dae9be722d9e339e606851f4c7581.png](https://i-blog.csdnimg.cn/blog_migrate/2d206ebb10a121eb9a730b86fab022e3.png)
2. 创建一个Dashboard
![05321f30f4dc0a4255b7a9cdff671220.png](https://i-blog.csdnimg.cn/blog_migrate/d4b87a2225b8de488ed82cb1042df2e9.png)
![7a41cc67355e6cf07b77fb58c2f9cd7b.png](https://i-blog.csdnimg.cn/blog_migrate/52031970a49e08e043102070859624e0.png)
3. 填写采集的指标点
![de6296a01436b98397e00637a45dab34.png](https://i-blog.csdnimg.cn/blog_migrate/015c4cf1227193cbed84c1f3f9d3de08.png)
注意:这里的指标点不能随便填,必须是已有的可以在 Prometheus看到。
![0e66bfc28793ec154517870480dc3eed.png](https://i-blog.csdnimg.cn/blog_migrate/98103c7ad8b15137bfcf627efbf1b055.png)
4.选择图表样式
![5ced67c893b7bd7e61fef2990093b7e6.png](https://i-blog.csdnimg.cn/blog_migrate/16c350214e1d5c3178793fee42d44612.png)
5.填写标题描述
![b7c3cca89d9425e540b86762ec73a22a.png](https://i-blog.csdnimg.cn/blog_migrate/8bc48a14a2637df8ccac13038ac3e372.png)
最后点击右上角的保存,输入Dashboad的名称即可。
![3cc5fe81a450f8b14f45bd118a8730eb.png](https://i-blog.csdnimg.cn/blog_migrate/70c85d38fa2bd96dd43df743b7569057.png)
Tips: 这里的图表布局是可以用鼠标拖动的
添加邮件报警
在实际项目中当监控的某的个指标超过阈值(比如CPU使用率过高),希望监控系统自动通过短信、钉钉和邮件等方式报警及时通知运维人员,Grafana就支持该功能。
第一步:点击[Alerting]——>[Notification channels]添加通知通道
![dcbf677f5fa1d8c8c52f47e2fe34de98.png](https://i-blog.csdnimg.cn/blog_migrate/86018b154aafce7a7ec98f7f0bdfb3b3.png)
![f8d80badad99c09bc5d4b72ee29818af.png](https://i-blog.csdnimg.cn/blog_migrate/2cd9a42f4a2aca93ec94be0c0ffd4929.png)
这里的Type有很多选项,包括webhook、钉钉等,这里以邮件为例。
第二步:邮箱配置
Grafana默认使用conf目录下defaults.ini作为配置文件运行,根据官方的建议我们不要更改defaults.ini而是在同级目录下新建一个配置文件custom.ini。
以腾讯企业邮箱为例,配置如下:
################### SMTP / Emailing ###################
[smtp]
enabled = true
host = smtp.exmail.qq.com:465
user = xxxx@ininin.com
# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
password = XXX
cert_file =
key_file =
skip_verify = true
from_address = xxxx@ininin.com
from_name = Grafana
ehlo_identity = ininin.com
然后需要重启Grafana,命令
grafana-server.exe -config=E:\file\grafana-6.3.3\conf\custom.ini
第三步:为指标添加alert
![25a535a417c634eb639a706b9cbdbb27.png](https://i-blog.csdnimg.cn/blog_migrate/8e21df407ace8ff549fadb8ea4523e41.png)
![78a2c27c0857494aaa28aaffb6ee3cd1.png](https://i-blog.csdnimg.cn/blog_migrate/43afe66b2b07beaa7cfc7cd63a0c9373.png)
功能说明:
Evaluate every
表示检测评率,这里为了测试效果,改为1秒
For
如果警报规则配置了For,并且查询违反了配置的阈值,那么它将首先从OK变为Pending。从OK到Pending Grafana不会发送任何通知。一旦警报规则的触发时间超过持续时间,它将更改为Alerting并发送警报通知。
Conditions
when 表示什么时间,of 表示条件,is above 表示触发值
同时,设置了is above后会有一条红线。
If no data or all values are null
如果没有数据或所有值都为空,这里选择触发报警
If execution error or timeout
如果执行错误或超时,这里选择触发报警
注意:下一次触发,比如10秒后,它不会再次触发,防止报警风暴产生!
第四步:测试
请求http://localhost:8848/heap/test接口后,内存升高大于设置的阈值,然后就收到报警邮件。
![3e81ab6f978eb8a2b9b825460c06b3b0.png](https://i-blog.csdnimg.cn/blog_migrate/6c7a088e2f2fd844dd347147f8fb6209.png)
这里图片没有显示出来,搞不懂为什么。
总结
这套监控功能还是挺强大的,就是Prometheus的表达式有点多。
欢迎加入我的知识星球,一起探讨架构,交流源码。加入方式,长按下方二维码噢:
已在知识星球更新源码解析如下:
最近更新《芋道 SpringBoot 2.X 入门》系列,已经 101 余篇,覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。
提供近 3W 行代码的 SpringBoot 示例,以及超 4W 行代码的电商微服务项目。
获取方式:点“在看”,关注公众号并回复 666 领取,更多内容陆续奉上。
文章有帮助的话,在看,转发吧。
谢谢支持哟 (*^__^*)