Dashboard Gallery
Azure DevOps Dashboard
This dashboard uses SquaredUp’s WebAPI tile and data from Azure DevOps to give our DevOps Team the performance overview of our build and release pipelines that they always wanted.
Challenge
While Azure DevOps does offer a dashboard, it is limited in the options users are allowed to query – e.g. each tile on the native dashboard must be set for a specific pipeline. Our DevOps Team needed a solution that would easily display data on our builds, release pipelines and agent usage.
Because we use many release pipeline stages across several different pipeline types, we needed a way to aggregate metrics across them. We also wanted to make the automation tests in our pipelines as efficient as possible, which meant we needed to gather metrics on problem tests and the length of time tests take to execute. Finally, we wanted to spend as little as possible on our pool of MS hosted agents – and to do this we needed to see how often all the agents in the pool are being utilized.
Solution
Using the WebAPI tile alone, we are now able to easily query the data we need from Azure DevOps with a dashboard. As the Azure DevOps results data can be accessed via https://analytics.dev.azure.com, all we have to do is use the Azure Analytics API to pull the data on our builds, release pipelines and agent usage – all into a single Azure DevOps metrics dashboard.
Dashboard walk-through
- Build – a simple summary of the number of failed builds in the last 14 days.
- Build Duration – the average time taken for our builds to complete. You may want multiple instances of this tile if you have builds that take different lengths of time to complete. Ours are fairly similar so it makes more sense for us to have a single tile to identify spikes in duration.
- Build Failures – the number of failures in any release pipeline per day.
- Build failure by stage name – a count of fails per release stage for the Azure DevOps Release pipeline.
- Job queue – a count of the number of requests per day that end up in a queue.
- MS Agent Usage – the total number of MS hosted agents that are in use on a given day. Our max number is 12, so if we see that number hit on multiple days, then we may want to increase the total number of agents in our pool.
- E2ETesting failures – three tiles showing the count of fails for specific automation tests in the corresponding release pipeline stage.
- Average E2E Testing Time – three tiles displaying the average run time for our automation stages.
How do I import and configure this dashboard
-
Ensure you’re using Dashboard Server v5.4 or above.
Already a SquaredUp customer?
Get the latest version of SCOM Edition
New to SquaredUp?
-
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/your-org/tenant-id/
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 providerIn Dashboard Server navigate to the right-hand menu ☰ > system > Integrations
-
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 providersSimple 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 Dashboard Server to use a proxy.
Complete the provider fields, using your API provider’s online documentation as a guide.
You are now ready to use this provider in a Web API tile (see How to use the Web API tile).
-
Download and import this dashboard pack.
How to import a dashboard pack-
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.
-
In SCOM Edition go to the top right hand menu ☰ > Import Dashboard Packs and drag the zip file into the Manual Import box.
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.
If the dashboard pack also contains perspectives (see Working with perspectives), then you’ll see these when you drilldown to the relevant object. 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.
Edit the imported dashboard as required.
-
-
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.
Edit the tiles by clicking the Edit button.
Open the http mode panel.
Exchange the IDs with the IDs of your Azure DevOps environment.
-
Publish the dashboard.
How to publish a dashboardA 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).
How to create a Web API provider
GET STARTED TODAY
Zero to dashboard hero in 60 seconds
Start now with hundreds of customizable dashboards.