Skip to content

Commit

Permalink
New PR: Add content for enterprise-level overview dashboard (13512) (…
Browse files Browse the repository at this point in the history
…#50159)

Co-authored-by: Sam Browning <[email protected]>
Co-authored-by: Felicity Chapman <[email protected]>
  • Loading branch information
3 people authored Apr 16, 2024
1 parent ed15079 commit 575a3d2
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ topics:

{% ifversion code-scanning-autofix %}While {% data variables.product.prodname_code_scanning %} autofix is allowed by default in an enterprise and enabled for every repository using {% data variables.product.prodname_codeql %}, you can choose to opt out and disable autofix. To learn how to disable autofix at the enterprise, organization and repository levels, see "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/disabling-autofix-for-code-scanning)."{% endif %}

In an organization's security overview dashboard, you can view the total number of autofix suggestions generated on open and closed pull requests in the organization for a given time period. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/code-security/security-overview/viewing-security-insights-for-your-organization#autofix-suggestions)" in the {% data variables.product.prodname_ghe_cloud %} documentation.
In an organization's security overview dashboard, you can view the total number of autofix suggestions generated on open and closed pull requests in the organization for a given time period. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/code-security/security-overview/viewing-security-insights#autofix-suggestions)" in the {% data variables.product.prodname_ghe_cloud %} documentation.

## Developer experience

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ When you have enabled a feature, you should communicate with repository administ
{% ifversion ghes or ghec %}You{% elsif fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %}{% endif %} can use security overview to see which teams and repositories are affected by security alerts, with a breakdown of alerts by severity. For more information, see{% ifversion ghes or ghec %} "[AUTOTITLE](/code-security/security-overview/assessing-code-security-risk)."{% elsif fpt %} "[AUTOTITLE](/enterprise-cloud@latest/code-security/security-overview/assessing-code-security-risk)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}

{% ifversion security-overview-dashboard %}
Security overview also has a dashboard (beta) where you can explore high-level trends and metrics to gain insight into your organization's security landscape. For more information, see "[AUTOTITLE](/code-security/security-overview/viewing-security-insights-for-your-organization)."
Security overview also has a dashboard (beta) where you can explore high-level trends and metrics to gain insight into your organization's security landscape. For more information, see "[AUTOTITLE](/code-security/security-overview/viewing-security-insights)."
{% endif %}

You can use various tools to monitor the actions that your organization's members are taking in response to security alerts. For more information, see "[AUTOTITLE](/code-security/getting-started/auditing-security-alerts)".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Security overview has multiple views that provide different ways to explore enab

{% data reusables.security-overview.alert-differences %}

For more information about these views, see {% ifversion security-overview-dashboard %}"[AUTOTITLE](/code-security/security-overview/viewing-security-insights-for-your-organization),"{% endif %}"[AUTOTITLE](/code-security/security-overview/assessing-adoption-code-security)" and "[AUTOTITLE](/code-security/security-overview/assessing-code-security-risk)."
For more information about these views, see {% ifversion security-overview-dashboard %}"[AUTOTITLE](/code-security/security-overview/viewing-security-insights),"{% endif %}"[AUTOTITLE](/code-security/security-overview/assessing-adoption-code-security)" and "[AUTOTITLE](/code-security/security-overview/assessing-code-security-risk)."

{% else %}

Expand Down Expand Up @@ -104,10 +104,14 @@ You can find security overview on the **Code Security** tab for your enterprise.

As with security overview for organizations, security overview for enterprises has multiple views that provide different ways to explore enablement and alert data.

{% ifversion security-overview-dashboard-enterprise %}
- Use the "Overview" view to see insights about your enterprise's security landscape and progress.{% endif %}
- Use the "Coverage" view to assess the adoption of code security features across organizations in the enterprise.
- Use the "Risk" view to assess the risk from security alerts of all types across organizations in the enterprise.
- Use the individual security alert views to identify your risk from specific vulnerable dependencies, code weaknesses, or leaked secrets.{% else %}You can view repositories owned by your enterprise that have security alerts, view all security alerts, or view security feature-specific alerts from across your enterprise.{% endif %}

For more information about these views, see {% ifversion security-overview-dashboard-enterprise %}"[AUTOTITLE](/code-security/security-overview/viewing-security-insights)," {% endif %}"[AUTOTITLE](/code-security/security-overview/assessing-adoption-code-security)" and "[AUTOTITLE](/code-security/security-overview/assessing-code-security-risk)."

For information about permissions, see "[Permission to view data in security overview](#permission-to-view-data-in-security-overview)."

{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ These qualifiers are available in the main summary views{% ifversion security-ov

## Additional filters for security overview dashboard (beta)

You can filter the "Overview" dashboard (beta) to narrow the scope of the metrics shown, so that you can view trends for specific repository or alert types. For more information on the overview dashboard, see "[AUTOTITLE](/code-security/security-overview/viewing-security-insights-for-your-organization)."
You can filter the "Overview" dashboard (beta) to narrow the scope of the metrics shown, so that you can view trends for specific repository or alert types. For more information on the overview dashboard, see "[AUTOTITLE](/code-security/security-overview/viewing-security-insights)."

| Qualifier | Description |
| -------- | -------- |
Expand Down
2 changes: 1 addition & 1 deletion content/code-security/security-overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ topics:
- Advanced Security
children:
- /about-security-overview
- /viewing-security-insights-for-your-organization
- /viewing-security-insights
- /assessing-adoption-code-security
- /assessing-code-security-risk
- /filtering-alerts-in-security-overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Viewing security insights for your organization
shortTitle: Viewing security insights
intro: 'You can use the overview dashboard in security overview to monitor the security landscape of the repositories in your organization.'
title: Viewing security insights
shortTitle: View security insights
intro: 'You can use the overview dashboard in security overview to monitor the security landscape of the repositories in your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %}.'
permissions: '{% data reusables.security-overview.permissions %}'
product: '{% data reusables.gated-features.security-overview %}'
versions:
Expand All @@ -12,19 +12,26 @@ topics:
- Advanced Security
- Alerts
- Organizations
redirect_from:
- /code-security/security-overview/viewing-security-insights-for-your-organization
allowTitleToDifferFromFilename: true
---

{% data reusables.security-overview.beta-overview-dashboard %}

## About organization-level security insights
## {% ifversion security-overview-dashboard-enterprise %}About security insights{% else %} About organization-level security insights{% endif %}

The overview page in security overview is a consolidated dashboard of insights about your organization's security landscape and progress. You can use the dashboard to monitor the health of your application security program, collaborate with engineering teams, and gather data for benchmarking purposes.
The overview page in security overview is a consolidated dashboard of insights about your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %}'s security landscape and progress. You can use the dashboard to monitor the health of your application security program, collaborate with engineering teams, and gather data for benchmarking purposes.

You can view a variety of metrics about the security alerts in your organization. The dashboard displays trending data that tracks alert counts and activity over time, as well as snapshot data that reflects the current state.
{% ifversion security-overview-dashboard-enterprise %}
Both the enterprise and organization-level security overviews have a dashboard. By default, the enterprise-level dashboard shows metrics for all the repositories in your enterprise. You can filter the data shown on the enterprise-level dashboard by owner (for example, by organization). By default, the organization-level dashboard shows metrics for all repositories owned by your organization. Both dashboards also allow you to filter by repository.
{% endif %}

You can view a variety of metrics about the security alerts in your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %}. The dashboard displays trending data that tracks alert counts and activity over time, as well as snapshot data that reflects the current state.

- The top section of the dashboard shows information about the status and age of alerts in your organization, as well as data about secrets that have been blocked or bypassed.
- The top section of the dashboard shows information about the status and age of alerts in your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %}, as well as data about secrets that have been blocked or bypassed.
- The "Remediation" section shows information about how alerts are resolved and alert activity over time.
- The "Impact analysis" section shows the repositories that pose the highest potential security risk in your organization.
- The "Impact analysis" section shows the repositories that pose the highest potential security risk in your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %}.

You can filter the overview dashboard by selecting a specific time period, and apply additional filters to focus on narrower areas of interest. All data and metrics across the dashboard will change as you apply filters. {% ifversion security-overview-additional-tools %}By default, the dashboard displays all alerts from {% data variables.product.prodname_dotcom %} tools, but you can use the tool filter to show alerts from a specific tool ({% data variables.product.prodname_secret_scanning %}, {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, a specific third-party tool) or all third-party {% data variables.product.prodname_code_scanning %} tools. This feature is in beta, and is subject to change.{% endif %} For more information, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)."

Expand All @@ -38,18 +45,22 @@ Keep in mind that the overview page tracks changes over time for security alert

{% data reusables.security-overview.alert-differences %}

## Viewing the security overview dashboard
## Viewing the security overview dashboard{% ifversion security-overview-dashboard-enterprise %} for your organization{% endif %}

{% data reusables.organizations.navigate-to-org %}
{% data reusables.organizations.security-overview %}
1. The overview page is the primary view that you will see after clicking on the "Security" tab. To get to the dashboard from another security overview page, in the sidebar, click **{% octicon "graph" aria-hidden="true" %} Overview**.
1. Use the options at the top of the overview page to filter the group of alerts you want to see metrics for. All of the data and metrics on the page will change as you adjust the filters.
- Use the date picker to set the time range that you want to view alert activity and metrics for.
- Click in the search box to add further filters on the alerts and metrics displayed.
{% data reusables.security-overview.filter-and-toggle %}

{% ifversion security-overview-dashboard-enterprise %}

![Screenshot of the Overview dashboard for an organization. The filters are outlined in dark orange, including the date picker and search field.](/assets/images/help/security-overview/security-overview-dashboard-filters.png)
## Viewing the security overview dashboard for your enterprise

1. For the alert trends graph at the top of the page, you can click **{% octicon "shield" aria-hidden="true" %} Open alerts** or **{% octicon "shield-x" aria-hidden="true" %} Closed alerts** to toggle between showing the trends for open or closed alerts. The toggle will only affect the alert trends graph. For more information, see "[Alert trends graph](#alert-trends-graph)."
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
{% data reusables.code-scanning.click-code-security-enterprise %}
{% data reusables.security-overview.filter-and-toggle %}

{% endif %}

## Understanding the overview dashboard

Expand All @@ -72,7 +83,7 @@ Some metrics in the security overview dashboard include a trend indicator, which

### Alert trends graph

The alert trends graph shows the change in the number of alerts in your organization over the time period you have chosen. Alerts are grouped by severity. You can toggle the graph between open and closed alerts.
The alert trends graph shows the change in the number of alerts in your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %} over the time period you have chosen. Alerts are grouped by severity. You can toggle the graph between open and closed alerts.

Open alerts include both newly created and existing open security alerts. New alerts are represented on their creation date, while alerts that existed before the chosen time period are represented at the start of the period. Once an alert is remediated or dismissed, it is not included in the graph. Instead, the alert will move to the closed alerts graph.

Expand Down
5 changes: 5 additions & 0 deletions data/features/security-overview-dashboard-enterprise.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Reference: #11289
# Documentation for the security overview dashboard, including for Enterprise-level
versions:
ghec: '*'
ghes: '>3.13'
4 changes: 4 additions & 0 deletions data/reusables/security-overview/beta-overview-dashboard.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{% note %}

{% ifversion security-overview-dashboard-enterprise %}
**Note:** The security overview dashboard is currently in beta and subject to change.
{% else %}
**Note:** The security overview dashboard is available at the organization level. The dashboard is currently in beta and subject to change.
{% endif %}

{% endnote %}
7 changes: 7 additions & 0 deletions data/reusables/security-overview/filter-and-toggle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
1. Use the options at the top of the overview page to filter the group of alerts you want to see metrics for. All of the data and metrics on the page will change as you adjust the filters.
- Use the date picker to set the time range that you want to view alert activity and metrics for.
- Click in the search box to add further filters on the alerts and metrics displayed.

![Screenshot of the overview page in security overview. Filtering options are outlined in dark orange, including the date picker and search field.](/assets/images/help/security-overview/security-overview-dashboard-filters.png)

1. For the alert trends graph at the top of the page, you can click **{% octicon "shield" aria-hidden="true" %} Open alerts** or **{% octicon "shield-x" aria-hidden="true" %} Closed alerts** to toggle between showing the trends for open or closed alerts. The toggle will only affect the alert trends graph. For more information, see "[Alert trends graph](#alert-trends-graph)."

0 comments on commit 575a3d2

Please sign in to comment.