docs/content/code-security/security-overview/viewing-metrics-for-pull-re...

4.4 KiB

title shortTitle allowTitleToDifferFromFilename intro permissions type topics versions
Viewing metrics for pull request alerts View PR alert metrics true You can use security overview to see how {% data variables.product.prodname_codeql %} is performing in pull requests for repositories across your organization, and to identify repositories where you may need to take action. {% data reusables.permissions.security-overview %} how_to
Security overview
Advanced Security
Code scanning
CodeQL
Organizations
Teams
feature
security-overview-org-codeql-pr-alerts

About {% data variables.product.prodname_codeql %} pull request alerts metrics for an organization

The metrics overview for {% data variables.product.prodname_codeql %} pull request alerts helps you to understand how well {% data variables.product.prodname_codeql %} is preventing vulnerabilities in your organization. You can use the metrics to assess how {% data variables.product.prodname_codeql %} is performing in pull requests, and to easily identify the repositories where you may need to take action in order to identify and reduce security risks.

The overview shows you a summary of how many vulnerabilities prevented by {% data variables.product.prodname_codeql %} have been caught in pull requests. The metrics are only tracked for pull requests that have been merged into the default branches of repositories in your organization.

You can also find more granular metrics, such as how many alerts were fixed with and without {% data variables.product.prodname_copilot_autofix_short %} suggestions, how many were unresolved and merged, and how many were dismissed as false positive or as risk accepted.

You can also view:

  • The rules that are causing the most alerts in your organization, and how many alerts each rule is associated with.

  • The number of alerts that were fixed with an accepted {% data variables.product.prodname_copilot_autofix_short %} suggestion, displayed as a fraction of how many total {% data variables.product.prodname_copilot_autofix_short %} suggestions were available.

  • Remediation rates, in a graph showing the percentage of alerts that were remediated with an available {% data variables.product.prodname_copilot_autofix_short %} suggestion, and the percentage of alerts that were remediated without a {% data variables.product.prodname_copilot_autofix_short %} suggestion.

You can apply filters to the data. The metrics are based on activity from the default period or your selected period.

Screenshot of the "CodeQL pull request alerts" view for an organization, showing status and trends over 90 days.

Viewing {% data variables.product.prodname_codeql %} pull request alerts metrics for an organization

{% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.security-overview %}

  1. In the sidebar, under "Metrics", click {% octicon "graph" aria-hidden="true" %} {% data variables.product.prodname_codeql %} pull request alerts.
  2. Optionally, use the date picker to set the time range. The date picker will show data based on the pull request alerts' creation dates.
  3. Optionally, apply filters in the search box at the top of the page.
  4. Alternatively, you can open the advanced filter dialog:
    • At the top of the page, next to the search box, click {% octicon "filter" aria-hidden="true" %} Filter.
    • Click {% octicon "plus" aria-hidden="true" %} Add a filter, then select a filter from the dropdown menu.
    • To search for repositories matching the selected filter, fill out the available fields for that filter, then click Apply. You can repeat this process to add as many filters as you would like to your search.
    • Optionally, to remove a filter from your search, click {% octicon "filter" aria-hidden="true" %} Filter. In the row of the filter you want to remove, click {% octicon "x" aria-label="Delete FILTER-NUMBER: FILTER-PROPERTIES" %}, then click Apply.{% ifversion security-overview-export-data %}
  5. You can use the {% octicon "download" aria-hidden="true" %} Export CSV button to download a CSV file of the data currently displayed on the page for security research and in-depth data analysis. For more information, see "AUTOTITLE." {% endif %}