故障排除
本指南可帮助你解决 SonarQube connectors 的常见问题。
Connector 未就绪
症状
SonarQube connector 显示 Ready: False 状态。
诊断步骤
-
检查 connector 状态:
查看
status.conditions字段以获取具体错误消息。 -
常见原因和解决方案:
无效 Token:
- 错误:"Authentication failed" 或 "Token invalid"
- 解决方案:验证 secret 中的 token 是否正确且未过期
- 在 SonarQube 中生成新的 token 并更新 secret
连接问题:
- 错误:"Connection refused" 或 "Timeout"
- 解决方案:验证集群是否可以访问 SonarQube 实例
- 检查网络策略、防火墙和 DNS 解析
地址错误:
- 错误:"404 Not Found" 或 "Invalid URL"
- 解决方案:验证
spec.address是否包含正确的协议(https://)和路径
Scanner 作业失败
症状
sonar-scanner 作业在分析期间失败或挂起。
诊断步骤
-
检查作业日志:
-
常见原因和解决方案:
缺少 sonar-project.properties:
- 错误:"You must define the following mandatory properties"
- 解决方案:确保 sonar-project.properties 存在于项目根目录中,并包含所需字段:
未加载代理配置:
- 错误:"Authentication required"
- 解决方案:验证 scanner 正在使用 connector 配置:
权限不足:
- 错误:"Insufficient privileges" 或 "403 Forbidden"
- 解决方案:验证 token 是否具有项目上的 "Execute Analysis" 权限
Scanner JRE 在 MicroOS 节点上失败:
- 错误:
- 背景:在 MicroOS 或其他加固的节点镜像上,较新的 SonarScanner CLI 版本可能会在运行 scanner 引擎之前自动预配 JRE。如果下载的 JRE 无法在节点安全策略下运行,即使 connector、代理、身份验证和 SonarQube 连通性都正常,scanner 容器仍可能以退出码
3失败。 - 诊断:如果 scanner 日志显示它已连接到 SonarQube,并在 JVM 初始化错误之前下载了 scanner 引擎或 JRE,则应将其视为 scanner 运行时兼容性问题,而不是 connector 身份验证问题。
- 解决方案:在与 SonarQube 版本兼容时,使用 scanner 镜像中已提供的 Java 运行时: 你也可以设置等效的环境变量:
- 验证:在 scanner 镜像中运行
java -version,并确认在禁用 JRE 预配之前存在受支持的 Java 运行时。
未找到配置
症状
Pod 无法挂载 sonar-project.properties 配置。
诊断步骤
-
验证 CSI 卷是否正确配置: 检查 Pod 规范中的 CSI 卷是否使用正确的
connectorName和configuration.names属性进行了配置。 -
常见原因和解决方案:
Connector 未就绪:
- 解决方案:等待 connector 达到 Ready 状态
- 只有在 connector 处于 Ready 状态时,配置才可用
卷配置错误:
- 解决方案:验证 CSI 卷配置是否包含:
connectorName:connector 的名称connectorNamespace:connector 的命名空间configuration.names:"sonar-scanner"
Quality Gate 失败
症状
分析已完成,但 quality gate 状态不是预期结果。
诊断步骤
-
查看 SonarQube 项目 dashboard 以了解 quality gate 详细信息
-
常见原因和解决方案:
Quality Profile 不匹配:
- 解决方案:验证是否已为项目分配正确的 quality profile
未达到覆盖率阈值:
- 解决方案:检查项目是否具有测试覆盖率数据
- 确保在分析之前已生成覆盖率报告
New Code Period 配置:
- 解决方案:验证 SonarQube 中的 new code period 定义
性能问题
症状
Scanner 运行时间过长或超时。
诊断步骤
-
常见原因和解决方案:
代码库较大:
- 解决方案:增加作业超时时间和资源限制:
网络延迟:
- 解决方案:检查到 SonarQube 实例的网络连通性
- 考虑使用更靠近集群的 SonarQube 实例
获取帮助
如果你仍然遇到问题:
-
检查 connector 日志(将
<connectors-namespace>替换为 安装 Connectors 系统的命名空间——默认是connectors-system,但可以配置): -
查看 connector 事件:
-
验证 SonarQube 实例健康状态:
- 访问 SonarQube Web 界面
- 直接检查
/api/system/status端点
-
查阅文档: