* Create codeql-action-debug-logging.yml * Update troubleshooting-the-codeql-workflow.md * Update viewing-code-scanning-logs.md * Update troubleshooting-the-codeql-workflow.md * Apply suggestions from code review Co-authored-by: Aditya Sharad <6874315+adityasharad@users.noreply.github.com> * Update troubleshooting-the-codeql-workflow.md * Don't use NWO * Apply suggestions from code review * Update content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md * Apply suggestions from code review * Update content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs.md Co-authored-by: Aditya Sharad <6874315+adityasharad@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
6.5 KiB
title, intro, product, permissions, miniTocMaxHeadingLevel, redirect_from, versions, topics, shortTitle
| title | intro | product | permissions | miniTocMaxHeadingLevel | redirect_from | versions | topics | shortTitle | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Viewing code scanning logs | You can view the output generated during {% data variables.product.prodname_code_scanning %} analysis in {% data variables.product.product_location %}. | {% data reusables.gated-features.code-scanning %} | If you have write permissions to a repository, you can view the {% data variables.product.prodname_code_scanning %} logs for that repository. | 4 |
|
|
|
View code scanning logs |
{% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %}
About your {% data variables.product.prodname_code_scanning %} setup
You can use a variety of tools to set up {% data variables.product.prodname_code_scanning %} in your repository. For more information, see "Setting up {% data variables.product.prodname_code_scanning %} for a repository."
The log and diagnostic information available to you depends on the method you use for {% data variables.product.prodname_code_scanning %} in your repository. You can check the type of {% data variables.product.prodname_code_scanning %} you're using in the Security tab of your repository, by using the Tool drop-down menu in the alert list. For more information, see "Managing {% data variables.product.prodname_code_scanning %} alerts for your repository."
About analysis and diagnostic information
You can see analysis and diagnostic information for {% data variables.product.prodname_code_scanning %} run using {% data variables.product.prodname_codeql %} analysis on {% data variables.product.prodname_dotcom %}.
Analysis information is shown for the most recent analysis in a header at the top of the list of alerts. For more information, see "Managing code scanning alerts for your repository."
Diagnostic information is displayed in the Action workflow logs and consists of summary metrics and extractor diagnostics. For information about accessing {% data variables.product.prodname_code_scanning %} logs on {% data variables.product.prodname_dotcom %}, see "Viewing the logging output from {% data variables.product.prodname_code_scanning %}" below.
If you're using the {% data variables.product.prodname_codeql_cli %} outside {% data variables.product.prodname_dotcom %}, you'll see diagnostic information in the output generated during database analysis. This information is also included in the SARIF results file you upload to {% data variables.product.prodname_dotcom %} with the {% data variables.product.prodname_code_scanning %} results.
For information about the {% data variables.product.prodname_codeql_cli %}, see "Configuring {% data variables.product.prodname_codeql_cli %} in your CI system."
About summary metrics
{% data reusables.code-scanning.summary-metrics %}
About {% data variables.product.prodname_codeql %} source code extraction diagnostics
{% data reusables.code-scanning.extractor-diagnostics %}
{% ifversion codeql-action-debug-logging %}
You can see more detailed information about {% data variables.product.prodname_codeql %} extractor errors and warnings that occurred during database creation by enabling debug logging. For more information, see "Troubleshooting the CodeQL workflow."
{% endif %}
Viewing the logging output from {% data variables.product.prodname_code_scanning %}
This section applies to {% data variables.product.prodname_code_scanning %} run using {% data variables.product.prodname_actions %} ({% data variables.product.prodname_codeql %} or third-party).
After setting up {% data variables.product.prodname_code_scanning %} for your repository, you can watch the output of the actions as they run.
{% data reusables.repositories.actions-tab %}
You'll see a list that includes an entry for running the {% data variables.product.prodname_code_scanning %} workflow. The text of the entry is the title you gave your commit message.
-
Click the entry for the {% data variables.product.prodname_code_scanning %} workflow.
-
Click the job name on the left. For example, Analyze (LANGUAGE).
-
Review the logging output from the actions in this workflow as they run.
-
Once all jobs are complete, you can view the details of any {% data variables.product.prodname_code_scanning %} alerts that were identified. For more information, see "Managing {% data variables.product.prodname_code_scanning %} alerts for your repository."
{% note %}
Note: If you raised a pull request to add the {% data variables.product.prodname_code_scanning %} workflow to the repository, alerts from that pull request aren't displayed directly on the {% data variables.product.prodname_code_scanning_capc %} page until the pull request is merged. If any alerts were found you can view these, before the pull request is merged, by clicking the n alerts found link in the banner on the {% data variables.product.prodname_code_scanning_capc %} page.
{% endnote %}


