最佳实践｜Spring Boot 应用如何快速接入 Prometheus 监控

Posted 2022-03-23 阿里巴巴云原生

<groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> <groupId>io.micrometer</groupId> <artifactId>micrometer-registry-prometheus</artifactId>注解。我们以演示项目中的 index 页面接口为例。注意这里，@Timed 注解中的 value 即为暴露到/actuator/prometheus 中的指标名字，histogram=true 表示我们暴露这个接口请求时长的 histogram 直方图类型指标，便于我们后续计算 P99，P90 等请求时间分布情况。

model.addAttribute("products", productDAO.getProductList()); model.addAttribute("FRONTEND_APP_NAME", Application.APP_NAME); model.addAttribute("FRONTEND_SERVICE_TAG", Application.SERVICE_TAG); model.addAttribute("FRONTEND_IP", registration.getHost()); model.addAttribute("PRODUCT_APP_NAME", PRODUCT_APP_NAME); model.addAttribute("PRODUCT_SERVICE_TAG", PRODUCT_SERVICE_TAG); model.addAttribute("PRODUCT_IP", PRODUCT_IP); model.addAttribute("new_version", StringUtils.isBlank(env)); return "index.html"; Counter visitCounter; public DemoService(MeterRegistry registry) visitCounter = Counter.builder("visit_counter") .description("Number of visits to the site") .register(registry); public String visit() visitCounter.increment(); return "Hello World!";

至此，我们的应用代码改造工作到这里就全部完成了，下一步工作就是将应用镜像重新构建并重新部署到已安装 ARMS Prometheus 的 Kubernetes 集群中。之后，我们 ARMS Prometheus 控制台中配置 ServiceMonitor，进行服务发现。

添加好 ServiceMonitor 后，我们可以在 Targets 列表中看到刚注册的应用 Service。

3

 第三步，看板配置

应用的监测数据已成功收集并存储到 ARMS Prometheus。接下来，也是最关键的一步，就是根据这些数据，配置相应的大盘及告警。这里，我们借助 Grafana 社区中开源大盘模板来构建我们自己的业务监测模板。主要基于以下两个模板：

Spring Boot 2.1 Statistics：

https://grafana.com/grafana/dashboards/10280

JVM (Micrometer)：

https://grafana.com/grafana/dashboards/4701

借助这些模板以及 ARMS Prometheus 内置的 Grafana 服务，我们可以很方便地将日常开发和运维过程中非常关心的指标组织在一张的 Grafana Dashboard 上。这里给大家抛砖引玉一下，放一张我们内部基于上述模板和自身业务构建的一个真实的大盘。这里面包含了一些总览，比如组件运行时间，内存使用率等等，也有一些细节指标，如堆内堆外内存，分代 GC 情况等等，还有像接口请求的 RED 等等，这里就不过多赘述了，大家可以充分发挥自己的想象力来创造独一无二的酷炫大盘~

点击“阅读原文”，了解更多阿里云可观测实践案例。

往期推荐

1、阿里云云原生微服务可观测实践

2、深度解密｜基于 eBPF 的 Kubernetes 问题排查全景图发布

3、系统架构面临的三大挑战，看 Kubernetes 监控如何解决？

Spring Boot 最佳实践快速入门

一、关于Spring Boot

在开始了解Spring Boot之前，我们需要先了解一下Spring，因为Spring Boot的诞生和Spring是息息相关的，Spring Boot是Spring发展到一定程度的一个产物，但并不是Spring的替代品，Spring Boot是为了让程序员更好的使用Spring。说到这里可能有些人会迷糊，那到底Spring和Spring Boot有着什么样的联系呢？

1.Spring发展史

在开始之前我们先了解一下Spring，Spring的前身是interface21，这个框架最初是为了解决EJB开发笨重臃肿的问题，为J2EE提供了另一种简单又实用的解决方案，并在2004年3月发布了Spring 1.0正式版之后，就引起了Java界广泛的关注和热评，从此Spring在Java界势如破竹迅速走红，一路成为Java界一颗璀璨夺目的明星，至今无可替代，也一度成为J2EE开发中真正意义上的标准了，而他的创始人Rod Johnson也在之后声名大噪，名利双收，现在是一名优秀的天使投资人，走上了人生的巅峰。

2.Spring Boot诞生

那既然Spring已经这么优秀了，为什么还有了之后Spring Boot？

因为随着Spring发展的越来越火，Spring也慢慢从一个小而精的框架变成了，一个覆盖面广大而全的框架，另一方面随着新技术的发展，比如nodejs、golang、Ruby的兴起，让Spring逐渐看着笨重起来，大量繁琐的XML配置和第三方整合配置，让Spring使用者痛苦不已，这个时候急需一个解决方案，来解决这些问题。

就在这个节骨眼上Spring Boot应运而生，2013年Spring Boot开始研发，2014年4月Spring Boot 1.0正式发布，Spring Boot诞生之初就受到业界的广泛关注，很多个人和企业陆续开始尝试，随着Spring Boot 2.0的发布，又一次把Spring Boot推向了公众的视野，也有越来越多了的中大型企业把Spring Boot使用到正式的生产环境了。值得一提的是Spring官方也把Spring Boot作为首要的推广项目，放到了官网的首位。

3.Spring Boot介绍

Spring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化Spring应用初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。Spring Boot其实就是一个整合很多可插拔的组件（框架），内嵌了使用工具（比如内嵌了Tomcat、Jetty等），方便开发人员快速搭建和开发的一个框架。

4.Spring Boot特点

• 搭建项目快，几秒钟就可以搭建完成；
• 让测试变的简单，内置了JUnit、Spring Boot Test等多种测试框架，方便测试；
• Spring Boot让配置变的简单，Spring Boot的核心理念：约定大约配置，约定了某种命名规范，可以不用配置，就可以完成功能开发，比如模型和表名一致就可以不用配置，直接进行CRUD（增删改查）的操作，只有表名和模型不一致的时候，配置名称即可；
• 内嵌容器，省去了配置Tomcat的繁琐；
• 方便监控，使用Spring Boot Actuator组件提供了应用的系统监控，可以查看应用配置的详细信息；

二、开发环境

Spring Boot 2.0.4

JDK 1.8

IDE：IntelliJ IDEA 2018.2

注意：Spring Boot 2.x 要求Java8及以上版本，不再支持Java6、Java7.

三、开发工具

IntelliJ IDEA Vs MyEclipse

开发工具的选择是每一个人入门人员要经历和选择的，如果你是老手可以忽略本节。

曾几何时Eclipse和MyEclipse统治了Java使用者，而如今，年复一年，毫不客气的说，十年前我用MyEclipse 6.0到现在的MyEclipse 2017 我没有感觉有任何的变化，还是一样的皮肤，一样的布局，一样卡的起飞使用感受，即使按照Google的指引，优化了一堆配置之后，你也会发现收效甚微。

这让我想起了曾经辉煌一时的诺基亚，到今天为止它依然不知道自己做错了什么，但时过境迁当一个事物跟不上时代变化的节奏，它就会被新来更适合的事物所代替。不得不说我曾经也是MyEclipse的忠实热爱者，并且对一个人来说一旦接受了某种事物，出于习惯的作用，通常改变也是很难的。

然而，到今天，我不得不承认IntelliJ IDEA从外观到运行速度上要比MyEclipse好太多，尤其是对Spring Boot的支持上，更好天作之合，所以IntelliJ IDEA是最好的选择。

四、Spring Boot版本号说明

Spring Boot的版本选择一般是这样的，如下图：

那版本号后面的英文代表什么含义呢？

具体含义，如下文所示：

• SNAPSHOT：快照版，表示开发版本，随时可能修改；
• M1（Mn）：M是milestone的缩写，也就是里程碑版本；
• RC1（RCn）：RC是release candidates的缩写，也就是发布预览版；
• Release：正式版，也可能没有任何后缀也表示正式版；

五、Spring Boot项目创建

Spring Boot项目创建，有两种方式：

• 方式一：访问网站构建项目，下载到本地导入开发工具
• 方式二：使用IDEA（IntelliJ IDEA的简称）工具使用Spring Initializr创建初始化（推荐使用）

说明：根据上面的“开发工具”章节得出，使用IDEA是最合适Spring Boot开发的语言，所以本节的所有内容都是使用IDEA完成的。

方式一：访问网站创建项目

1. 访问网址：https://start.spring.io/
2. 配置项目信息，点击Generate Project按钮生成项目，如下图： 其中，Group表示组织标识符，对应了Java包目录的结构；Arifact表示项目标识符，对应项目名称，也就是根目录名称。
3. 解压文件夹，点击IDEA File => New => Project from Existing Sources... => 选择你解压项目文件夹目录 => 点击Ok => 选择Import project from external model => 选中Maven => 一路点击Next直到项目导入成功。

方式二：使用IDEA Spring Initializr创建（推荐使用）

点击File => New => Project => 选择Spring Initializr，按引导操作即可，如下图：

最终的项目目录，如下图：

目录说明

如上图所示，整个项目的目录划分还是挺清晰的，其中有几个重要的文件需要单独说一下：

• pom.xml => Maven的构建文件，里面有关于组建的引用信息
• src/main/java => 项目的源码类都在此目录下
• com.hellospringboot.hellospringboot/HelloSpringBootApplication.java => 其中前半部分为包名，后半部分为项目的启动文件
• src/main/resources => 项目的资源文件目录
• src/main/resources/application.properties => 空的属性配置文件

六、项目运行

为了演示方便，我们在HelloSpringBootApplication.java直接添加一个访问方法index，返回一个Hello信息，右键Run运行项目。

注意：

1. 标识类注解，我们在访问之前，处理添加方法之后，还需要给类HelloSpringBootApplication.java设置@RestController注解，@RestController是@Controller和@ResponseBody的集合，如果只是使用@RestController注解，则Controller中的方法无法返回jsp页面，或者html，配置的视图解析器 InternalResourceViewResolver不起作用，返回的内容就是Return 里的内容，为了便于演示，我们就直接给类标注@RestController注解；
2. 标识访问方法注解，只要标识了方法注解，我们访问才能映射到相应的方法，如下图我们映射了访问地址“sayhi”，使用“sayhi2”是访问不到的

使用进阶

如果我们需要传递参数，返回JSON格式的数据，应该这样操作：重复上一步的操作，给类标识@RestController注解，即可返回JSON格式的信息，如果有参数直接在方法上添加参数的名称，方法的参数名称和url参数名称必须是一一对应的相同的，不然获取的参数值为null，如图所示：

总结：如图所示，参数的传递顺序是没有关系的，不影响取值。

七、热部署

根据上面的提示，我们已经完成了Spring Boot项目的创建和运行，但是有一个问题就是，每次修改代码之后都需要重新启动调试，代码才能生效，比较麻烦，那有没有一种简单的方式呢？

答案是有的，那就是接下来要说的热部署。

热部署的配置如下：

第一步: 设置IDEA开启项目自动编译

File => Settings => Build,Execut,Deployment => Compiler 勾中右侧Build Project automatically

如下图：

第二步: 开启项目运行时自动生成

ctrl + shift + a(windows系统),command+shift+alt+/(mac系统)

搜索命令：registry => 勾选compiler.automake.allow.when.app.running

如下图：

最终的效果如下图：

八、总结

• Spring框架从小到大的发展，和新技术的兴起让Spring开发看起来变的臃肿，人们需要一种简单而高效的方法，于是Spring Boot应运而生；
• 本文介绍了Spring Boot版本号的含义，以及开发工具使用IDEA最合适；
• 本文介绍了Spring Boot项目创建的两种方式，比较推荐使用IDEA的Spring Initializr创建；
• 本文介绍了Spring Boot目录的含义，以及项目的启动和运行，并且介绍了多参数传递的使用，以及JSON格式的输出示例；
• 本文介绍了Spring Boot的热部署配置流程，方便了Spring Boot的开发和调试。

撩起来，扫描加入圈子