# 关于工具状态页面

工具状态页 可让您了解您的存储库中 code scanning 工具的运行状况和性能。

> \[!NOTE]
> 网站管理员必须先启用 code scanning 才能使用此功能。 有关详细信息，请参阅“[为设备配置代码扫描](/zh/enterprise-server@3.22/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-code-scanning-for-your-appliance)”。
>
> 如果企业所有者在企业级别设置了code scanning策略，则可能无法启用或禁用GitHub Code Security。 有关详细信息，请参阅“[强制实施企业的代码安全性和分析策略](/zh/enterprise-server@3.22/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)”。

## 什么是 工具状态页？

工具状态页显示有关您的所有code scanning工具的信息，并且在code scanning未按预期工作时，是排查问题的良好起点。

> \[!NOTE]
> 工具状态页 仅显示默认分支在仓库级别的工具状态，不在组织级别显示。

## 工具状态指示器

工具状态页 会显示三种状态中的一种：

* **所有配置都正常工作**：所有工具都按预期运行
* **某些配置需要注意**：某些工具存在警告或非严重问题
* **某些配置不起作用**：一个或多个工具存在严重错误

## 哪些信息可用

### 对于所有 code scanning 工具

* 配置状态和运行状况
* 扫描计划
* 首次和最新的扫描时间
* 扫描中使用的规则

### 对于集成工具，例如 CodeQL

除了上面列出的信息外，用于集成工具的 工具状态页 还提供以下详细信息：

* 按编程语言的文件覆盖率百分比
* 每种安装类型的配置详细信息
* 特定错误消息
* 已分析文件的可下载 CSV 报告
* 已使用规则和警报计数的可下载列表

## 如何 CodeQL 界定扫描的文件

CodeQL 如果该文件中的某些代码行已被处理，则会将该文件报告为已扫描。

### 解释型语言

* **默认设置**：扫描文件包括 CodeQL 可分析的所有语言的源代码文件
* **高级设置**：可以使用 `paths` 和 `paths-ignore` 定义要扫描的文件。 请参阅“[使用 CodeQL 扫描代码](/zh/enterprise-server@3.22/code-security/concepts/code-scanning/codeql/codeql-code-scanning)”。

### 已编译的语言

工具状态页 会报告在运行自动构建或手动构建步骤之前已存在的文件。 不会显示生成过程中生成的文件。 请参阅“[对编译语言进行 CodeQL 代码扫描](/zh/enterprise-server@3.22/code-security/how-tos/find-and-fix-code-vulnerabilities/manage-your-configuration/codeql-for-compiled-languages#use-autobuild-for-codeql)”。

### 覆盖率计算

文件覆盖率百分比考虑任何由 `paths` 和 `paths-ignore` 配置属性排除的文件。

## 了解文件覆盖率百分比

使用文件覆盖率百分比调试和改进分析：

* **高百分比**： Code scanning 按预期处理该语言
* **低百分比**：调查诊断结果。 请参阅“[CodeQL 扫描的行数少于预期](/zh/enterprise-server@3.22/code-security/reference/code-scanning/troubleshoot-analysis-errors/fewer-lines-scanned-than-expected)”
* **零百分比**：你可能有用当前未被分析的语言编写的代码。 更新设置以包含这些语言。 请参阅“[代码扫描的工作流配置选项](/zh/enterprise-server@3.22/code-security/reference/code-scanning/workflow-configuration-options)”

> \[!NOTE]
> 如果同时设置高级设置和默认设置，则 工具状态页 仅显示默认设置。

## 故障排除功能

工具状态页 通过以下方式帮助你排查问题：

* **错误消息**：解释工具未按预期方式执行的原因，并提供建议操作
* **文件覆盖率数据**：显示正在分析哪些文件和语言
* **配置详细信息**：显示有关每个分析任务的信息
* **可下载报表**：提供包含详细文件和规则信息的 CSV 报告

## 延伸阅读

* [使用工具状态页进行代码扫描](/zh/enterprise-server@3.22/code-security/how-tos/find-and-fix-code-vulnerabilities/manage-your-configuration/use-the-tools-status-page-for-code-scanning)