Apache Brooklyn 远程调试技术指南

前言

Apache Brooklyn 是一个强大的云应用管理和编排平台，在开发过程中我们经常需要对运行中的实例进行调试。本文将详细介绍如何对远程部署的 Brooklyn 实例进行调试，帮助开发者快速定位和解决问题。

准备工作

获取正确的源代码版本

调试的首要条件是确保本地代码与远程实例版本一致。通过以下 REST API 可获取远程实例的构建信息：

http://<远程地址>:<端口>/v1/server/version

响应示例：

{
    "version": "0.9.0-SNAPSHOT",
    "buildSha1": "c0fdc15291702281acdebf1b11d431a6385f5224",
    "buildBranch": "UNKNOWN"
}

关键字段 buildSha1 表示构建时使用的 Git 提交哈希。在本地代码库执行以下命令切换到对应版本：

git checkout c0fdc15291702281acdebf1b11d431a6385f5224
mvn clean install -DskipTests

配置远程调试

启动调试监听

默认情况下 Brooklyn 不启用调试监听，需要通过设置 JAVA_OPTS 参数来开启：

1. 连接到远程服务器
2. 停止当前运行的 Brooklyn 实例
3. 设置环境变量并重新启动

kill `cat pid_java`
export JAVA_OPTS="-Xms256m -Xmx1g -XX:MaxPermSize=256m -agentlib:jdwp=transport=dt_socket,address=127.0.0.1:8888,server=y,suspend=n"
bin/brooklyn launch &

成功启动后，控制台会显示：

Listening for transport dt_socket at address: 8888

建立 SSH 隧道

出于安全考虑，建议通过 SSH 隧道连接调试端口：

REMOTE_HOST=<远程地址>
REMOTE_PORT=8888
LOCAL_PORT=8888
SSH_USER=root
PRIVATE_KEY_FILE=~/.ssh/id_rsa

ssh -YNf -i $PRIVATE_KEY_FILE -l $SSH_USER -L $LOCAL_PORT:127.0.0.1:$REMOTE_PORT $REMOTE_HOST

IDE 配置

Eclipse 配置步骤

1. 打开项目
2. 选择 Run → Debug Configurations...
3. 创建新的 Remote Java Application 配置
4. 设置参数：
   • 项目：任意 Brooklyn 项目
   • 连接类型：Standard (Socket Attach)
   • 主机：localhost 或 127.0.0.1
   • 端口：8888

IntelliJ 配置步骤

1. 打开项目
2. 选择 Run → Edit Configurations
3. 添加 Remote 配置
4. 设置参数：
   • 传输方式：Socket
   • 调试模式：Attach
   • 主机：localhost 或 127.0.0.1
   • 端口：8888
   • 源代码搜索范围：整个项目

调试测试

建议在 ServerResource.java 的 getStatus() 方法设置断点进行测试。当访问 /v1/server/version 端点时，如果断点被触发，说明调试连接成功建立。

注意事项

1. 调试过程中会暂停应用执行，生产环境慎用
2. 确保网络连接稳定
3. 调试完成后及时关闭调试端口
4. 建议使用非默认端口增强安全性

通过以上步骤，开发者可以方便地对远程 Brooklyn 实例进行调试，大大提高了问题排查和功能开发的效率。