Skip to content

Commit cc235ce

Browse files
mchammer01Copilotsophietheking
authored
[EDI] About the tool status page for code scanning (#59706)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
1 parent 09b5900 commit cc235ce

File tree

6 files changed

+188
-119
lines changed

6 files changed

+188
-119
lines changed

content/code-security/concepts/code-scanning/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ children:
2020
- /sarif-files
2121
- /merge-protection
2222
- /codeql
23+
- /tool-status-page
2324
---
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: About the tool status page
3+
shortTitle: Tool status page
4+
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.'
5+
permissions: '{% data reusables.permissions.code-scanning-all-alerts %}'
6+
product: '{% data reusables.gated-features.code-scanning %}'
7+
versions:
8+
fpt: '*'
9+
ghes: '*'
10+
ghec: '*'
11+
topics:
12+
- Code Security
13+
- Code scanning
14+
- CodeQL
15+
contentType: concepts
16+
---
17+
18+
{% data reusables.code-scanning.enterprise-enable-code-scanning %}
19+
20+
## What is the {% data variables.code-scanning.tool_status_page %}?
21+
22+
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.
23+
24+
> [!NOTE]
25+
> 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.
26+
27+
## Tool status indicators
28+
29+
The {% data variables.code-scanning.tool_status_page %} displays one of three statuses:
30+
31+
* **All configurations are working**: All tools are operating as expected
32+
* **Some configurations need attention**: Some tools have warnings or non-critical issues
33+
* **Some configurations are not working**: One or more tools have critical errors
34+
35+
## What information is available
36+
37+
### For all {% data variables.product.prodname_code_scanning %} tools
38+
39+
* Configuration status and health
40+
* Scan scheduling
41+
* First and most recent scan times
42+
* Rules used in scans
43+
44+
### For integrated tools like {% data variables.product.prodname_codeql %}
45+
46+
In addition to the information listed above, the {% data variables.code-scanning.tool_status_page %} for integrated tools provides the following details:
47+
48+
* File coverage percentages by programming language
49+
* Configuration details for each setup type
50+
* Specific error messages
51+
* Downloadable CSV reports of analyzed files
52+
* Downloadable lists of rules used and alert counts
53+
54+
## How {% data variables.product.prodname_codeql %} defines scanned files
55+
56+
{% data variables.product.prodname_codeql %} reports a file as scanned if some lines of code in that file were processed.
57+
58+
### Interpreted languages
59+
60+
* **Default setup**: Scanned files include all source code files for languages {% data variables.product.prodname_codeql %} can analyze
61+
* **Advanced setup**: You can use `paths` and `paths-ignore` to define which files to scan. See [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql).
62+
63+
### Compiled languages
64+
65+
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](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages#about-autobuild-for-codeql).
66+
67+
### Coverage calculation
68+
69+
File coverage percentages respect any files excluded by `paths` and `paths-ignore` configuration properties.
70+
71+
## Understanding file coverage percentages
72+
73+
Use file coverage percentages to debug and improve your analysis:
74+
75+
* **High percentage**: {% data variables.product.prodname_code_scanning_caps %} is working as expected for that language
76+
* **Low percentage**: Investigate diagnostic output. See [AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected)
77+
* **Zero percentage**: You may have code in languages not currently being analyzed. Update your setup to include these languages. See [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#changing-the-languages-that-are-analyzed)
78+
79+
> [!NOTE]
80+
> If you set up both advanced setup and default setup, the {% data variables.code-scanning.tool_status_page %} only shows default setup.
81+
82+
## Troubleshooting features
83+
84+
The {% data variables.code-scanning.tool_status_page %} helps you troubleshoot issues through:
85+
86+
* **Error messages**: Explains why tools aren't performing as expected with suggested actions
87+
* **File coverage data**: Shows which files and languages are being analyzed
88+
* **Configuration details**: Displays information about each analysis run
89+
* **Downloadable reports**: Provides CSV reports with detailed file and rule information
90+
91+
## Further reading
92+
93+
* [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/use-the-tools-status-page-for-code-scanning)

content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/about-the-tool-status-page.md

Lines changed: 0 additions & 117 deletions
This file was deleted.

content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ topics:
1919
redirect_from:
2020
- /code-security/code-scanning/managing-your-code-scanning-configuration
2121
children:
22-
- /about-the-tool-status-page
2322
- /editing-your-configuration-of-default-setup
23+
- /use-the-tools-status-page-for-code-scanning
2424
- /set-code-scanning-merge-protection
2525
- /configuring-larger-runners-for-default-setup
2626
- /codeql-code-scanning-for-compiled-languages

0 commit comments

Comments
 (0)