2021-11-30 周二 ## 因子 最近在学`springclound`，然后看书的时候，学习到通过`actuator`来监控`springboot`应用的各项指标。又因`actuator`只提供一组`endpoints`(`restful`接口），查看不直观，才有集成`springboot admin server`来通过界面查看监控。（当然还有其他的界面监控，比如很牛逼的`普罗米修斯`） ## springboot actuator介绍 Spring Boot Actuator可以帮助你监控和管理Spring Boot应用，比如健康检查、审计、统计和HTTP追踪等。所有的这些特性可以通过JMX或者HTTP endpoints来获得。 Actuator同时还可以与外部应用监控系统整合，比如 [Prometheus](https://prometheus.io/), [Graphite](https://graphiteapp.org/), [DataDog](https://www.datadoghq.com/), [Influx](https://www.influxdata.com/), [Wavefront](https://www.wavefront.com/), [New Relic](https://newrelic.com/)等。这些系统提供了非常好的仪表盘、图标、分析和告警等功能，使得你可以通过统一的接口轻松的监控和管理你的应用。 示例： `http://localhost:9101/actuator/health` ``` json { "status": "UP", "components": { "db": { "status": "UP", "details": { "database": "SQLite", "result": 1, "validationQuery": "SELECT 1" } }, "diskSpace": { "status": "UP", "details": { "total": 250790436864, "free": 64770326528, "threshold": 10485760 } }, "ping": { "status": "UP" }, "redis": { "status": "UP", "details": { "version": "5.0.8" } } } } ``` ## springboot admin server介绍 Actuator功能强大，便于其他应用使用端点（只需要简单的REST调用）。但是开发人员使用时就没那么方便了。对于开发人员，有良好的交互界面会更方便浏览监控数据和管理应用。这正是Spring Boot Admin做的工作。它为actuator端点提供了良好的交互界面，并提供了额外的特性。 Spring Boot Admin不是Spring团队提供的模块，它是由[Codecentric](https://blog.codecentric.de/en/)公司创建的，代码在[Github](https://github.com/codecentric/spring-boot-admin)上公开。 示例：  ## springboot应用集成actuator 1. pom.xml里添加依赖 ``` xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> ``` 2. `actuator`相关配置 ``` properties # 显示actuator详情 management.endpoint.health.show-details=always # 解除浏览器访问路径，* 是所有，也可以指定为beans,health management.endpoints.web.exposure.include=* # 端点信息接口使用的端口，为了和主系统接口使用的端口进行分离 management.server.port=9101 management.server.servlet.context-path=/ ``` ## springboot应用集成springboot admin server 分为`Server`和`Client`，`Server`可以理解为注册中心，`Client`则是将集成了`actuator`的springboot应用的注册到`Server`上，然后通过界面监控各项指标。 ### Server端 1. 添加依赖 ``` xml <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-server</artifactId> <version>${springboot.admin.version}</version> </dependency> </dependencies> ``` 2. 启动类上添加`@EnableAdminServer`注解 ``` java @EnableAdminServer @SpringBootApplication public class StartupApplication { public static void main(String[] args) { SpringApplication.run(StartupApplication.class,args); } } ``` 3. 启动后访问`Server`的端口`http://127.0.0.1:9100`  ### Client端 1. 添加依赖 ``` xml <dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-client</artifactId> <version>${springboot.admin.version}</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> ``` 2. 添加配置 ``` properties # 显示actuator详情 management.endpoint.health.show-details=always # 解除浏览器访问路径，* 是所有，也可以指定为beans,health management.endpoints.web.exposure.include=* # 端点信息接口使用的端口，为了和主系统接口使用的端口进行分离 management.server.port=9101 management.server.servlet.context-path=/ spring.application.name=card-api # 配置spring-boot-admin服务端的地址 spring.boot.admin.client.enabled=true spring.boot.admin.client.url=http://localhost:9100 ``` 3. 启动Client端后，就能看到界面上有示例连上   ## 总结 1. 为了监控`springboot`应用的各项指标，才有了`springboot actuator`项目。 2. 为了更直观查看各项监控数据，就有了`springboot admin server`项目，其他的还有`Prometheus`等 3. `springboot admin`的`Server`和`Client`端都可以集成`spring-security`认证，提供安全性。 4. 框架的版本一定要对应，不然启动的时候会出各种问题。spring和spring boot和spring cloud，以及spring boot admin的版本。可以通过mvn repo参考查看。( 5. 我的版本：spring clound Hoxton.SR10 + spring boot 2.2.7 RELEASE + spring boot admin 2.2.4 ) ## 参考资料 1. https://www.jianshu.com/p/1749f04105fb 2. https://www.itmuch.com/spring-cloud/finchley-3/