Arthas 集成与扩展实战指南

一、与 Spring/Spring Boot 集成

1.1 自动装配机制

Spring Boot 应用通过 arthas-spring-boot-starter 实现自动装配：

<dependency>
    <groupId>com.taobao.arthas</groupId>
    <artifactId>arthas-spring-boot-starter</artifactId>
    <version>3.6.7</version>
</dependency>

工作原理：

通过 ArthasConfiguration 加载配置项
启动时检查 spring.arthas.enabled 配置
通过 ArthasBanner 打印连接信息

1.2 常用集成场景

Bean 方法诊断：

# 监控Spring Bean方法
watch org.springframework.context.ApplicationContext getBean '{params, returnObj}'

请求追踪：

# 追踪Controller请求
trace com.example.controller.* *

配置建议：

spring:
  arthas:
    agent-id: ${random.value} # 集群环境唯一标识
    tunnel-server: ws://arthas-tunnel-server:8080/ws
    disabled-commands: jvm,heapdump # 敏感命令禁用

二、自定义命令开发

2.1 开发流程

创建命令类：

@Name("mycmd")
@Summary("Custom command demo")
public class MyCommand extends AnnotatedCommand {
 @Argument(argName = "param", index = 0)
 private String param;
 
 @Override
 public void process(CommandProcess process) {
     process.appendResult(new MyResultModel(param.toUpperCase()));
     process.end();
 }
}

打包插件：

mvn clean package -Dmaven.test.skip=true

动态加载：

# 加载自定义命令
plugin -i mycmd-plugin.jar

2.2 最佳实践

继承 AnnotatedCommand 简化开发
使用 CommandModel 规范输出格式
通过 @Option 注解定义参数

示例项目结构：

mycmd-plugin/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           ├── MyCommand.java
│   │   │           └── MyResultModel.java
│   │   └── resources/
│   │       └── META-INF/
│   │           └── services/
│   │               └── com.taobao.arthas.core.shell.command.Command

三、插件化扩展机制

3.1 架构设计

3.2 典型插件案例

JVM监控插件：

# 安装jvm-monitor插件
plugin -i jvm-monitor.jar

# 查看扩展指标
jvm-monitor --metric gc.count

SQL分析插件：

# 监控MyBatis SQL执行
sql-trace --threshold 100ms

开发建议：

保持插件轻量化（<1MB为宜）
实现 Plugin 接口的 unload() 方法
避免与核心命令命名冲突

四、结合 CI/CD 流水线

4.1 自动化诊断流程

4.2 典型集成脚本

#!/bin/bash
# pipeline_health_check.sh

ARTHAS_BOOT_JAR="arthas-boot.jar"
CHECK_COMMANDS="check_commands.txt"

# 获取目标进程PID
APP_PID=$(jps -l | grep myapp | awk '{print $1}')

# 执行批量检查
java -jar ${ARTHAS_BOOT_JAR} ${APP_PID} -f ${CHECK_COMMANDS} -batch > report.json

# 结果分析
if grep -q "ERROR" report.json; then
    exit 1
fi

check_commands.txt 示例：

thread -n 3
jvm
watch com.example.Service healthCheck '{params, returnObj}'

五、第三方工具整合

5.1 Prometheus 监控集成

配置暴露指标：

# 启动时开启JMX
java -javaagent:arthas-agent.jar -Darthas.prometheus.port=8568

Grafana 看板配置：

{
  "targets": [{
 "expr": "sum(arthas_method_cost_seconds{app=\"$application\"}) by (method)",
 "legendFormat": "{{method}}"
  }],
  "title": "方法耗时TOP10"
}

5.2 ELK 日志收集

# 日志输出到文件
options save-result true
options job-result-log /var/log/arthas/arthas.log

# Logstash配置示例
input {
  file {
    path => "/var/log/arthas/*.log"
    codec => json
  }
}

性能数据关联方案：

trace_id --> 应用日志 --> Arthas诊断数据 --> 系统指标

实践建议

生产环境安全措施：
- 使用 arthas-tunnel-server 集中管理
- 配置网络白名单
- 定期轮换访问token

性能影响控制：

# 限制采样频率
profiler --interval 50ms
# 设置超时自动停止
trace --timeout 300s

团队协作规范：
- 建立命令使用白名单
- 记录诊断会话（session -s problem_20231101）
- 归档重要排查记录

通过以上集成与扩展方案，Arthas 可以深度融入企业技术栈，成为开发生命周期中的标准诊断工具。

Arthas集成Spring Boot与自定义命令开发实战指南