boot-actuator 项目教程

boot-actuator 项目教程

boot-actuator 项目地址: https://gitcode.com/gh_mirrors/boo/boot-actuator

1. 项目介绍

boot-actuator 是一个基于 SpringBoot 2.0 实现的 JVM 远程监控图形化工具。它可以同时监控多个 Web 应用，并支持远程监控。该项目借鉴了另一个开源项目 JavaMonitor 的初始版，剔除了一些功能，并增加了远程监控模块。用户只需在需要监控的项目中集成监控的 JAR 包，并设置可访问的 IP（默认为空，则不拦截 IP 访问），即可实现远程监控和用户管理模块，动态定时任务，支持 Windows 服务器和 Linux 服务器的监控，Mac 系统尚未测试，但应该也支持。

2. 项目快速启动

2.1 编译 actuator-service 工程

首先，编译 actuator-service 工程并生成 JAR 包：

mvn install:install-file -Dfile=actuator-service-1.0.jar -DgroupId=com.github.qinxuewu -DartifactId=actuator-service -Dversion=1.0 -Dpackaging=jar

2.2 在需要监控的项目中引入 actuator-service

在需要监控的项目中引入生成的 JAR 包：

<dependency>
    <groupId>com.github.qinxuewu</groupId>
    <artifactId>actuator-service</artifactId>
    <version>1.0</version>
</dependency>

2.3 配置文件

在项目的配置文件中添加以下配置：

# 监控应用名称，唯一
spring.application.name=web1

# 限制白名单访问监控端点，为空则不限制，建议设置
actuator.server.ip=

# 监控远程应用日志
actuator.log.path=F:/log/boot-monitor/spring.log

2.4 启动类配置

在启动类上增加扫描包注解：

@ComponentScan("com.pflm.**, com.github.qinxuewu.core")

2.5 启动监控 boot-monitor

编译并启动 boot-monitor 工程：

nohup java -jar boot-monitor.jar &

访问 http://localhost:8080/login，使用默认账号 admin/admin 登录。

3. 应用案例和最佳实践

3.1 应用案例

假设你有一个基于 Spring Boot 的 Web 应用，希望对其进行 JVM 监控。你可以按照上述步骤，将 actuator-service 集成到你的项目中，并启动 boot-monitor 进行监控。通过监控界面，你可以实时查看 JVM 的各项指标，如内存使用情况、GC 次数、线程状态等。

3.2 最佳实践

• 配置白名单：在生产环境中，建议配置 actuator.server.ip 以限制访问监控端点的 IP 地址，确保安全性。
• 日志路径配置：根据实际需求配置 actuator.log.path，确保日志文件能够正确生成并被监控工具读取。
• 定期检查监控数据：定期检查监控数据，及时发现并解决潜在的性能问题。

4. 典型生态项目

• Spring Boot Actuator：Spring Boot 自带的监控和管理端点，提供了丰富的监控和管理功能。
• Prometheus：一个开源的监控和报警工具，可以与 Spring Boot Actuator 集成，提供更强大的监控和报警功能。
• Grafana：一个开源的指标分析和可视化工具，可以与 Prometheus 集成，提供更直观的监控数据展示。

通过这些生态项目的集成，可以进一步提升 boot-actuator 的监控能力和可视化效果。

boot-actuator 项目地址: https://gitcode.com/gh_mirrors/boo/boot-actuator