如何为Cloud Run上的Python Flask应用启用Cloud Debugger

1. 实例服务账号权限配置 #

Cloud Run 运行实例的默认服务账号默认没有 Debugger 访问权限，需要调整IAM配置：

• 给部署使用的服务账号添加 Cloud Debugger Agent 角色，遵循最小权限原则不要授予过度宽泛的权限
• 若使用自定义服务账号部署，需要在部署参数中通过 --service-account 显式指定该服务账号

2. Debugger 初始化参数补全 #

当前初始化代码缺少应用标识参数，Cloud Debugger 无法识别对应服务，需要修改初始化代码：

try:
  import googleclouddebugger
  import os
  # 读取Cloud Run内置注入的环境变量，不需要手动配置
  service_name = os.environ.get('K_SERVICE', 'default-flask-service')
  service_version = os.environ.get('K_REVISION', 'default-revision')
  googleclouddebugger.enable(
    module=service_name,
    version=service_version,
    breakpoint_enable_canary=True
  )
except ImportError:
  pass

注意：初始化代码需要放在Flask应用启动逻辑的最前面，保证在请求处理逻辑加载前完成初始化

3. Dockerfile 依赖适配 #

部分精简Python镜像缺少Debugger运行依赖的系统库，需要调整Dockerfile配置：

• 基于Debian/Ubuntu的镜像，在安装pip依赖前执行 apt-get update && apt-get install -y libpython3-dev 安装系统依赖
• 确认pip install google-python-cloud-debugger安装的Python环境和Flask应用运行的Python环境一致，避免多环境下依赖安装错位

4. 运行环境指定 #

Cloud Debugger 暂不支持 Cloud Run 第二代执行环境，部署时需要指定使用第一代环境：

• 手动部署时添加参数 --execution-environment gen1
• 若使用Cloud Build自动部署，需要在部署的gcloud命令中补全上述参数

5. 源代码匹配校验 #

• 确认部署的代码版本提交哈希和Cloud Source Repositories中的对应提交一致，Debugger需要匹配源代码才能识别应用
• 不要压缩、混淆部署的Python代码，保持代码目录结构和Cloud Source Repositories中的结构完全一致

内容的提问来源于stack exchange，提问作者Finglish