Dashboard Pack - Azure DevOps Analytics

This article describes how to download a specific dashboard pack. You can download dashboard packs from dashboards.squaredup.com and learn more about how dashboard packs work here: Dashboard Packs

Description

This dashboard gives an overview of the performance of build and release pipelines by using WebAPI tiles to query https://analytics.dev.azure.com to get the data.

What do the individual tiles show?

Build	A simple summary of the number of failed builds in the last 14 days.
Build Duration	Average time for build completion.
Build Failures	Number of failures in any release pipeline per day.
Build Failure By Stage Name	A count of fails per release stage.
Job Queue	Count of the number of requests per day that end up in a queue.
MS Agent Usage	Number of MS hosted agents that are in use.
E2ETesting Failures	Three tiles showing the count of fails for specific automation tests in that release pipeline stage.
Average E2E Testing Time	Three tiles returning the average run time for automation stages.

How do I import and configure this dashboard?

1. Ensure you're using SquaredUp DS v5.4 or above.

   Already a SquaredUp customer?

   Get the latest version of DS for Azure

   New to SquaredUp?

   Try it for free

2. Create a Web API provider to connect with your Azure DevOps environment.

   Use the following settings:

   Type	Basic auth
   Name	Azure Devops Note: The name is case-sensitive and must be entered exactly like given here for the tiles to recognize the provider automatically. If you name it differently, you will need to select the provider manually for each tile on the dashboard.
   URL	Enter the base url for your Azure DevOps Analytics account: i.e. https://analytics.dev.azure.com/{organization}/{project}
   username, password	Use an Azure DevOps access token that has read access for Analytics as both the username and password

   How to create a Web API provider

   1. In SquaredUp DS navigate to the right-hand menu ☰ > system > Integrations

   2. Under Integrations click on Web API and choose either Simple, Basic Auth or OAuth depending on the API you are using.

      

      About the different types of Integrations and Web API providers

      Simple	No authentication, basic authentication (username and password in a header) or Windows authentication (configured automatically to use the application pool identity account).
      Basic auth	Basic authentication. Your specified username and password will be Base64 encoded automatically.
      OAuth	Token-based authentication according to the OAuth 2.0 standard. Many APIs use OAuth 2.0 for authorization, and will require an OAuth provider to include the additional information about how to authorize against the service.

      Note: When adding an OAuth provider you may get an message that the provider is not authorized if some of the provider configuration is incorrect (for example the username, password, secret etc), or if you use a proxy it could be that the proxy is not configured. See How to configure SquaredUp DS to use a proxy.

   3. Complete the provider fields, using your API provider's online documentation as a guide.

      ignore invalid ssl: Turn the on/off switch to on if you are using a self-signed certificate.

      default headers headers sent with all requests using this provider, for example the API token in the format the API requires.

      url parameters url parameters sent with all requests using this provider. For example, a query parameter that is always used can be added here in the provider to save adding it to every dashboard configuration.

   4. You are now ready to use this provider in a Web API tile (see How to use the Web API tile).

3. Download and import this dashboard pack.

   How to import a dashboard pack

   1. Download the dashboard pack zip file for the dashboard pack you wish to import.

      There may be additional steps before or after the import to get the dashboard working in your environment.

   2. In DS for Azure go to the top right hand menu ☰ > Import Dashboard Packs and drag the zip file into the Manual Import box.

       

      

   3. The dashboard pack is imported and if the pack contains top-level dashboards, these will automatically appear in the navigation bar, usually in a folder called 'Community Dashboards' for dashboard packs from the SquaredUp Community.

   4. Carry out any additional steps required to make the dashboard work in your environment. These steps will be described on the download page for each dashboard. For example, you may need to create the correctly named Web API provider, create a PowerShell profile, or edit tile scopes.

   5. Edit the imported dashboard as required.

4. Change the IDs to the IDs for you Azure environment.

   All tiles on this dashboard except the Job queue and the MS agent usage tile require an Azure ID to collect data. Check each tile and replace the ID with the respective ID of your Azure environment.

   1. Edit the tiles by clicking the Edit button.

   2. Open the http mode panel.

   3. Exchange the IDs with the IDs of your Azure DevOps environment.

5. Publish the dashboard.

   How to publish a dashboard

   A newly created dashboard will not be visible to others until you publish it. If you made changes to an existing dashboard, the changes will only be visible to others after you published the dashboard again.

   You can identify a dashboard that has not been published yet or has unpublished changes by the unpublished button at the top:

   

   When you click on the unpublished button, you'll have two options:

   • Publish will make the dashboard or changes visible to others.
     Note: A newly created dashboard will appear on the menu where you created it. To move the dashboard to a different place on the navigation bar see How to edit the Navigation Bar.

   • Discard will delete your draft dashboard if it has never been published or, if you made changes to an already published dashboard, discard the changes.

   Publishing dashboards to different audiences

   Find out how to publish dashboards to a subset of users using Team Folders or visible to anyone even unlicensed users with Open Access (Sharing Dashboards with anyone - Open Access).