tool-status-page.md

title	About the tool status page
shortTitle	Tool status page
intro	The {% data variables.code-scanning.tool_status_page %} provides visibility into the health and performance of {% data variables.product.prodname_code_scanning %} tools in your repository.
permissions	{% data reusables.permissions.code-scanning-all-alerts %}
product	{% data reusables.gated-features.code-scanning %}
versions	fpt ghes ghec * * *
contentType	concepts
category	Find and fix code vulnerabilities

{% data reusables.code-scanning.enterprise-enable-code-scanning %}

What is the {% data variables.code-scanning.tool_status_page %}?

The {% data variables.code-scanning.tool_status_page %} shows information about all of your {% data variables.product.prodname_code_scanning %} tools and is a good starting point for debugging problems when {% data variables.product.prodname_code_scanning %} isn't working as expected.

Note

The {% data variables.code-scanning.tool_status_page %} shows tool status at the repository level for the default branch only, not at the organization level.

Tool status indicators

The {% data variables.code-scanning.tool_status_page %} displays one of three statuses:

• All configurations are working: All tools are operating as expected
• Some configurations need attention: Some tools have warnings or non-critical issues
• Some configurations are not working: One or more tools have critical errors

What information is available

For all {% data variables.product.prodname_code_scanning %} tools

• Configuration status and health
• Scan scheduling
• First and most recent scan times
• Rules used in scans

For integrated tools like {% data variables.product.prodname_codeql %}

In addition to the information listed above, the {% data variables.code-scanning.tool_status_page %} for integrated tools provides the following details:

• File coverage percentages by programming language
• Configuration details for each setup type
• Specific error messages
• Downloadable CSV reports of analyzed files
• Downloadable lists of rules used and alert counts

How {% data variables.product.prodname_codeql %} defines scanned files

{% data variables.product.prodname_codeql %} reports a file as scanned if some lines of code in that file were processed.

Interpreted languages

• Default setup: Scanned files include all source code files for languages {% data variables.product.prodname_codeql %} can analyze
• Advanced setup: You can use paths and paths-ignore to define which files to scan. See AUTOTITLE.

Compiled languages

The {% data variables.code-scanning.tool_status_page %} reports files present before running autobuild or manual build steps. Files generated during the build process are not shown. See AUTOTITLE.

Coverage calculation

File coverage percentages respect any files excluded by paths and paths-ignore configuration properties.

Understanding file coverage percentages

Use file coverage percentages to debug and improve your analysis:

• High percentage: {% data variables.product.prodname_code_scanning_caps %} is working as expected for that language
• Low percentage: Investigate diagnostic output. See AUTOTITLE
• Zero percentage: You may have code in languages not currently being analyzed. Update your setup to include these languages. See AUTOTITLE

Note

If you set up both advanced setup and default setup, the {% data variables.code-scanning.tool_status_page %} only shows default setup.

Troubleshooting features

The {% data variables.code-scanning.tool_status_page %} helps you troubleshoot issues through:

• Error messages: Explains why tools aren't performing as expected with suggested actions
• File coverage data: Shows which files and languages are being analyzed
• Configuration details: Displays information about each analysis run
• Downloadable reports: Provides CSV reports with detailed file and rule information

Further reading

• AUTOTITLE