Skip to content

Latest commit

 

History

History
584 lines (391 loc) · 25.5 KB

overview.md

File metadata and controls

584 lines (391 loc) · 25.5 KB
title titleSuffix description ms.custom ms.assetid ms.technology ms.author author ms.topic monikerRange ms.date
Understand dashboards, charts, reports & widgets
Azure DevOps
Learn about OOB charts, widgets, dashboards, & reports available to monitor status and trends in Azure DevOps.
dashboards
7BAD53A1-080E-40E8-8866-24EC00395D39
devops-analytics
kaelli
KathrynEE
overview
<= azure-devops
08/03/2022

About dashboards, charts, reports, & widgets

[!INCLUDE version-lt-eq-azure-devops]

Gain visibility into your team's progress by adding one or more widgets or charts to your dashboard. Customizable, highly configurable dashboards provide you and your teams with the flexibility to share information, monitor progress and trends, and improve your workflow processes. Each team can tailor their dashboards to share information and monitor their progress.

If you're just starting out, read Add, rename, and delete dashboards. Looking for instructions on a specific task, in context chart, widget, or report? See Dashboards and widgets quick reference. To learn about our reporting solutions, read Reporting Roadmap.

[!INCLUDE temp]

Supported capabilities, permissions, and access

Access to Azure DevOps web portal features are managed through access levels assigned to users.

Web portal data views and reports

The following features provide support for viewing Azure DevOps data through the web portal:

  • Dashboards are customizable interactive signboards that provide real-time information. Dashboards are associated with a team or a project and display configurable charts and widgets.
  • Charts are query-based status or trend charts derived from a work item query or test results.
  • Widgets display configurable information and charts on dashboards. The widget catalog provides brief descriptions of those widgets available to you. Also, you can add widgets provided through the Azure DevOps Marketplace.
  • In-context reports are system-generated charts that support specific services. Examples are team velocity, sprint burndown, and the Cumulative Flow Diagram (CFD), and the Test Failures Report. These reports are displayed on the Analytics tab for a specific service and derive data from Analytics.

::: moniker range=">= azure-devops-2019"

Power BI reports

The following features provide support for viewing Azure DevOps data using Power BI:

  • Analytics views provide a simplified way to specify the filter criteria for a Power BI report based on Analytics data for Azure Boards data. To learn more, see What are Analytics views?.

  • Power BI reports allow users to create rich, customized Power BI reports or other reports using OData queries of Analytics data and the returned JSON data. For on-premises Azure DevOps environments, project collections must be configured to support the Inherited process.

    [!NOTE]
    OData (Open Data Protocol) is an ISO/IEC approved, OASIS standard that defines a set of best practices for building and consuming REST APIs. To learn more, see OData documentation. ::: moniker-end

::: moniker range="< azure-devops-2022"

SQL Server reports

SQL Server Reporting is the legacy reporting solution available with Azure DevOps Server 2020 and earlier versions. The following features provide support for viewing Azure DevOps data using SQL Server Reports and SQL Server Analysis Services.

::: moniker-end

::: moniker range=">= azure-devops-2019 < azure-devops-2022"

  • Excel status and trend reports supports generating custom work tracking reports using Excel starting with a flat-list query. To learn more, see Create status and trend reports from a work item query.
  • SQL Server reports: For project collections that support the On-premises XML process model, allow users access to out-of-the-box SQL Server reports and support to create customized SQL Reports or Excel reports. Doing so requires that the project is configured to support SQL Server reporting. ::: moniker-end

::: moniker range="tfs-2018"

Supported features and access level

Users granted Stakeholder access have limited access to select features as indicated in the following table. To learn more, see About access levels. In addition to access levels, select features require permissions to execute.

Note

Data displayed within a chart or widget is subject to permissions granted to the signed in user. To learn more, see FAQs on Azure DevOps dashboards, charts, and reports, Access and permissions.

:::row::: :::column span="3"::: Supported features and tasks :::column-end::: :::column span="1"::: Stakeholder :::column-end::: :::column span="1"::: Basic :::column-end::: :::row-end:::

:::row::: :::column span="3"::: Dashboards (View) :::column-end::: :::column span="1"::: ✔️
:::column-end::: :::column span="1"::: ✔️
:::column-end::: :::row-end::: :::row::: :::column span="3"::: Dashboards (Create and edit) :::column-end::: :::column span="1":::

:::column-end::: :::column span="1"::: ✔️
:::column-end::: :::row-end::: :::row::: :::column span="3"::: Charts, Widgets (View) :::column-end::: :::column span="1"::: ✔️
:::column-end::: :::column span="1"::: ✔️
:::column-end::: :::row-end::: :::row::: :::column span="3"::: Charts, Widgets (Add and configure) :::column-end::: :::column span="1":::

:::column-end::: :::column span="1"::: ✔️
:::column-end::: :::row-end::: :::row::: :::column span="3"::: In-context reports :::column-end::: :::column span="1"::: ✔️ :::column-end::: :::column span="1"::: ✔️ :::column-end::: :::row-end::: ::: moniker range=">= azure-devops-2019" :::row::: :::column span="3"::: Analytic views :::column-end::: :::column span="1":::

:::column-end::: :::column span="1"::: ✔️ :::column-end::: :::row-end::: :::row::: :::column span="3"::: Power BI reports :::column-end::: :::column span="1"::: ✔️ :::column-end::: :::column span="1"::: ✔️ :::column-end::: :::row-end::: ::: moniker-end ::: moniker range="< azure-devops" :::row::: :::column span="3"::: SQL Server reports :::column-end::: :::column span="1"::: ✔️ :::column-end::: :::column span="1"::: ✔️ :::column-end::: :::row-end::: ::: moniker-end

Default permissions

Dashboards

::: moniker range="azure-devops" You can set individual dashboard permissions to grant or restrict the ability to edit or delete dashboards.
::: moniker-end

::: moniker range="< azure-devops" You set dashboard permissions at the team level for team dashboards. ::: moniker-end

[!INCLUDE temp]

::: moniker range=">= azure-devops-2019"

Power BI Integration and Analytics views

You set permissions for the service at the project level, and for shared Analytics views at the object level.

[!INCLUDE temp]

::: moniker-end

Configurable dashboards

With dashboards, you can configure an array of charts and widgets.

Each team can add and configure multiple dashboards to:

  • Share information.
  • View status, progress, and trends
  • Access quick links and other functions.

Easily add and rearrange widgets on the dashboard to show recent changes made to view build status, bug trends, and more.

Example dashboard

Sequence for adding and customizing a dashboard

Select a box below to open the corresponding article.

Add dashboardAdd widget

Charts: Work tracking status and trends

With flat-list queries, you can create various charts to monitor status, progress, and trends. Before you monitor work progress and trends, you'll need to have planned your project and made progress on work you're tracking.

You can open a shared query, create a chart, and add it to the dashboard. Once it's been added to the dashboard, you can change the Chart for work items widget configuration to resize or change the chart parameters. Or, from the dashboard, you can add a Chart for work items widget and choose a shared query and set the chart parameters. Chart types include status—pie, bar, column, stacked bar, and pivot—and trend—stacked area, line, and area—charts.

For details, see:

Sample Agile tool light-weight charts

::: moniker range=">= azure-devops-2019"

[!div class="mx-imgBorder"]
Active bug charts added to dashboards

::: moniker-end

::: moniker range="tfs-2018"

Active bugs

::: moniker-end

Sequence for adding query-based charts to a dashboard

Select a box below to open the corresponding article.

Edit queryCreate chartAdd chart to dashboard

Charts: Manual testing progress, results, and trends

The steps to creating charts that track manual testing progress and results are similar to the ones for tracking work. The starting point, however, begins with the test plan rather than a query. For example, you can find out how many test cases are ready to run, or how many tests are passing and failing in each test suite. And, just like work item query-based charts, you can add these charts to a dashboard.

For details, see:

Sample light-weight test charts

Web Team test plan is a chart that shows counts of test in various stages. Tests by Suite breaks down the same tests by test suite.

Widgets

You add widgets to a dashboard to display a chart, information, or set of links. Most widgets are configurable. For a description of each supported widget for your platform and version, see the Widget catalog. Here are the widgets that support the indicated service.

[!INCLUDE temp]


:::row::: :::column span="1"::: Work - Chart for work items
- New Work item
- Query results
- Query tile
- Sprint burndown
- Sprint capacity
- Sprint overview
- Work links
--- Code - Code tile - Pull request :::column-end::: :::column span="1"::: Build - Chart for build history --- Information and links
- Markdown
- Other links
- Team members - Team room
- Visual Studio Shortcuts - Welcome :::column-end::: :::row-end:::

Sprint chart widgets

Sprint capacity widget Sprint burndown widget

::: moniker range=">= azure-devops-2019"

Sprint scope change

There's no chart or widget that tracks changes to sprint scope. However, you can determine work items added to a sprint or moved out of a sprint using the Query Editor. To learn how, see About Sprints, Scrum and project management, Sprint scope change.

::: moniker-end

::: moniker range=">= azure-devops-2019"

Sample Cumulative Flow Diagram widget

Cumulative flow diagram widget

::: moniker-end

Monitor code activity, build progress and deployment status

With the code tile widgets, you can monitor the activity occurring within a repository or branch folder. Build history displays a histogram of all builds run for a specific build pipeline. Bar color indicates: green-completed, red-failed, and yellow-completed without tests.

Code, build, and release chart widgets

Code tile widget   Pull request widget
Build history widget    Deployment status widget

::: moniker range=">= azure-devops-2019"

Analytics widgets and reports

::: moniker-end

::: moniker range=">= azure-devops-2020"

The Analytics service is the reporting platform for Azure DevOps. As described in What is the Analytics service?, it replaces the previous platform based on SQL Server Reporting Services. The Analytics service supports Analytics widgets, in-context Analytics reports, and Analytics views for Power BI reporting.

::: moniker-end

::: moniker range="azure-devops-2019"

The Analytics service is the reporting platform for Azure DevOps. As described in What is the Analytics service?, it replaces the previous platform based on SQL Server Reporting Services. The Analytics service supports Analytics widgets and Analytics views for Power BI reporting.

Note

Analytics is in preview for Azure DevOps Server 2019 and generally available for Azure DevOps Server 2020 and later versions.

::: moniker-end

::: moniker range=">= azure-devops-2019"

Sample Lead time widget

Lead time widget

To learn more, see the following articles:

::: moniker-end

::: moniker range=">= azure-devops-2020"

Azure Boards provides several in-context reports that derive from Analytics data. From your backlog or board, you can view the Cumulative Flow Diagram and team Velocity reports by selecting the Analytics tab. Each report provides interactive controls to provide each user the view of interest to them. From a Sprint backlog, you can view the sprint burndown trend.

Cumulative Flow Diagram

Use the interactive controls to choose the time frame, swimlanes, and workflow states or Kanban board columns.

[!div class="mx-imgBorder"]
Open CFD Analytics

Velocity

Use the interactive controls to choose the count or sum field and number of iterations.

[!div class="mx-imgBorder"]
Open Velocity Analytics

Sprint Burndown Trend

Use the interactive controls to choose the start and end of the sprint and count or sum field to use in the burndown. If you don't track Remaining Work in tasks, you can view burndown based on a count of work items/tasks.

[!div class="mx-imgBorder"]
Burndown trend based on Remaining Work

::: moniker-end

::: moniker range="<= azure-devops-2019"

Azure Boards provides several in-context reports that derive from the work tracking data store. From your backlog or board, you can view the Cumulative Flow Diagram and team Velocity reports by choosing the miniature charts that appear on each page. From a Sprint backlog, you can view the sprint burndown.

Cumulative Flow Diagram

The CFD report shows the count of work items in the backlog based on their state over time.

[!div class="mx-imgBorder"]
Opened CFD chart

Velocity

Velocity is based on the values entered for Effort, Story Points, or Size fields for work items that belong to the Requirement Category.

Web portal, Velocity chart showing seven sprints of in progress and completed work

Sprint burndown

Each sprint provides access to two charts. The first tracks capacity for the team, team activities—such as Development, Test, Design—and individual team members. The second tracks the sprint burndown for remaining work.

Capacity bars Burndown
Capacity bars Burndown chart

::: moniker-end

::: moniker range=">= azure-devops-2020"

Note

You can add the in-context reports to a dashboard using the copy to dashboard option from the report's context menu.

Analytics in-context report, Copy to dashboard
::: moniker-end

::: moniker range="<= azure-devops-2019"

Note

You can't add the in-context reports to a dashboard. However, you may find a comparable widget listed in the widget catalog that tracks the same or similar data which you can add to the dashboard. ::: moniker-end

To learn more about these reports, see one of the following articles:

::: moniker range=">= azure-devops-2020"

Several in-context reports are provided for Azure Pipelines. These reports derive from Analytics data. Open a pipeline (or release summary for Test failure) to view the reports and select the Analytics tab. Select View full report on a summary card for a detailed report.

[!div class="mx-imgBorder"] Analytics Tab

For more information on each in-context Analytics report for pipeline runs, see the following articles: ::: moniker-end

::: moniker range="azure-devops"

::: moniker-end

::: moniker range="azure-devops-2020"

::: moniker range=">= azure-devops-2020" You can also use Power BI and OData to create reports based on pipeline and test data. See Overview of sample reports using OData queries ::: moniker-end

::: moniker range=">= azure-devops-2020"

Pipeline pass rate report

The Pipeline pass rate report provides a trend of pipeline failure and task failure of the pipeline. You can view the pass rate of the pipeline over a configurable period of time (7/14/30 days). You can view more details in Task failure details, which not only highlights the trend, but also list the top failing tasks.

[!div class="mx-imgBorder"] Pipeline failures report

Learn more about the Pipeline pass rate report.

Test failures report

The Test failures report provides a granular view of the top failing tests in the pipeline, along with the failure details. Summary charts are also provided for builds that indicate code coverage and test failures or success.

[!div class="mx-imgBorder"] Test analytics detail view

Learn more about the Test failures report.

Pipeline duration report

The Pipeline duration report provides the duration trend of a pipeline. It also highlights the average run time of the total successful runs over a period of time (7/14/30 days) and provides insights on the tasks that have affected the duration of the pipeline.

[!div class="mx-imgBorder"] Pipeline duration report

Learn more about the Pipeline duration report.

::: moniker-end

::: moniker range="azure-devops-2019"

In-context reports: Pipeline Test Failures

Azure Pipelines provides an in-context Test failures report, derived from Analytics data. Open a release summary to view the report and select the Analytics tab. Select the summarized card for a detailed report. To learn more, see Test failures report.

[!div class="mx-imgBorder"] Analytics Tab, Azure DevOps Server 2019

::: moniker-end

Add custom work tracking fields

::: moniker range="azure-devops"

You can add data to support reporting requirements by adding a custom field.
::: moniker-end

::: moniker range=">= azure-devops-2019 < azure-devops"

You can add data to support reporting requirements by adding a custom field Inheritance process or On-premises XML process. ::: moniker-end

::: moniker range="tfs-2018"

You can add data to support reporting requirements by adding a custom field.
::: moniker-end

Marketplace widgets and extensibility

In addition to the widgets available in the widget catalog, you may find interesting widgets in the Marketplace.

Or, you can create your own widget using the REST API.

Next steps

[!div class="nextstepaction"] Add a widget to a dashboard or Review available widgets

Related articles