Skip to content

Latest commit

 

History

History
165 lines (104 loc) · 9.52 KB

app-insights-tutorial-dashboards.md

File metadata and controls

165 lines (104 loc) · 9.52 KB
title description keywords services author ms.author ms.date ms.service ms.custom ms.topic manager
Create custom dashboards in Azure Application Insights | Microsoft Docs
Tutorial to create custom KPI dashboards using Azure Application Insights.
application-insights
mrbullwinkle
mbullwin
09/20/2017
application-insights
mvc
tutorial
carmonm

Create custom KPI dashboards using Azure Application Insights

You can create multiple dashboards in the Azure portal that each include tiles visualizing data from multiple Azure resources across different resource groups and subscriptions. You can pin different charts and views from Azure Application Insights to create custom dashboards that provide you with complete picture of the health and performance of your application. This tutorial walks you through the creation of a custom dashboard that includes multiple types of data and visualizations from Azure Application Insights. You learn how to:

[!div class="checklist"]

  • Create a custom dashboard in Azure
  • Add a tile from the Tile Gallery
  • Add standard metrics in Application Insights to the dashboard
  • Add a custom metric chart Application Insights to the dashboard
  • Add the results of an Analytics query to the dashboard

Prerequisites

To complete this tutorial:

Log in to Azure

Log in to the Azure portal at https://portal.azure.com.

Create a new dashboard

A single dashboard can contain resources from multiple applications, resource groups, and subscriptions. Start the tutorial by creating a new dashboard for your application.

  1. On the main screen of the portal, select New dashboard.

    New dashboard

  2. Type a name for the dashboard.

  3. Have a look at the Tile Gallery for a variety of tiles that you can add to your dashboard. In addition to adding tiles from the gallery you can pin charts and other views directly from Application Insights to the dashboard.

  4. Locate the Markdown tile and drag it on to your dashboard. This tile allows you to add text formatted in markdown which is ideal for adding descriptive text to your dashboard.

  5. Add text to the tile's properties and resize it on the dashboard canvas.

    Edit markdown tile

  6. Click Done customizing at the top of the screen to exit tile customization mode and then Publish changes to save your changes.

    Dashboard with markdown tile

Add health overview

A dashboard with just static text isn't very interesting, so now add a tile from Application Insights to show information about your application. You can add Application Insights tiles from the Tile Gallery, or you can pin them directly from Application Insights screens. This allows you to configure charts and views that you're already familiar with before pinning them to your dashboard. Start by adding the standard health overview for your application. This requires no configuration and allows minimal customization in the dashboard.

  1. Select Application Insights in the Azure menu and then select your application.

  2. In the Overview timeline, select the context menu and click Pin to dashboard. This adds the tile to the last dashboard that you were viewing.

    Pin Overview timeline

  3. At the top of the screen, click View dashboard to return to your dashboard.

  4. The Overview timeline is now added to your dashboard. Click and drag it into position and then click Done customizing and Publish changes. Your dashboard now has a tile with some useful information.

    Dashboard with Overview timeline

Add custom metric chart

The Metrics panel allows you to graph a metric collected by Application Insights over time with optional filters and grouping. Like everything else in Application Insights, you can add this chart to the dashboard. This does require you to do a little customization first.

  1. Select Application Insights in the Azure menu and then select your application.

  2. Select Metrics.

  3. An empty chart has already been created, and you're prompted to add a metric. Add a metric to the chart and optionally add a filter and a grouping. The example below shows the number of server requests grouped by success. This gives a running view of successful and unsuccessful requests.

    Add metric

  4. Select the context menu for the chart and select Pin to dashboard. This adds the view to the last dashboard that you were working with.

    Pin metric chart

  5. At the top of the screen, click View dashboard to return to your dashboard.

  6. The Overview Timeline is now added to your dashboard. Click and drag it into position and then click Done customizing and then Publish changes.

    Dashboard with metrics

Metrics Explorer

Metrics Explorer is similar to Metrics although it allows significantly more customization when added to the dashboard. Which you use to graph your metrics depends on your particular preference and requirements.

  1. Select Application Insights in the Azure menu and then select your application.

  2. Select Metrics Explorer.

  3. Click to edit the chart and select one or more metrics and optionally a detailed configuration. The example displays a line chart tracking average page response time.

  4. Click the pin icon in the top right to add the chart to your dashboard and then drag it into position.

    Metrics Explorer

  5. The Metrics Explorer tile allows more customization once it's added to the dashboard. Right click the tile and select Edit title to add a custom title. Go ahead and make other customizations if you want.

    Dashboard with metrics explorer

  6. You now have the Metrics Explorer chart added to your dashboard.

    Dashboard with metrics explorer

Add Analytics query

Azure Application Insights Analytics provides a rich query language that allows you to analyze all of the data collected Application Insights. Just like charts and other views, you can add the output of an Analytics query to your dashboard.

Since Azure Applications Insights Analytics is a separate service, you need to share your dashboard for it to include an Analytics query. When you share an Azure dashboard, you publish it as an Azure resource which can make it available to other users and resources.

  1. At the top of the dashboard screen, click Share.

    Publish dashboard

  2. Keep the Dashboard name the same and select the Subscription Name to share the dashboard. Click Publish. The dashboard is now available to other services and subscriptions. You can optionally define specific users who should have access to the dashboard.

  3. Select Application Insights in the Azure menu and then select your application.

  4. Click Analytics at the top of the screen to open the Analytics portal.

    Start Analytics

  5. Type the following query, which returns the top 10 most requested pages and their request count:

    requests
    | summarize count() by name
    | sort by count_ desc
    | take 10 
    
  6. Click Go to validate the results of the query.

  7. Click the pin icon and select the name of your dashboard. The reason that this option has you select a dashboard unlike the previous steps where the last dashboard was used is because the Analytics console is a separate service and needs to select from all available shared dashboards.

    Pin Analytics query

  8. Before you go back to the dashboard, add another query, but this time render it as a chart so you see the different ways to visualize an Analytics query in a dashboard. Start with the following query that summarizes the top 10 operations with the most exceptions.

    exceptions
    | summarize count() by operation_Name
    | sort by count_ desc
    | take 10 
    
  9. Select Chart and then change to a Doughnut to visualize the output.

    Analytics chart

  10. Click the pin icon to pin the chart to your dashboard and this time select the link to return to your dashboard.

  11. The results of the queries are now added to your dashboard in the format that you selected. Click and drag each into position and then click Done editing.

  12. Right click each of the tiles and select Edit Title to give them a descriptive title.

    Dashboard with Analytics

  13. Click Publish changes to commit the changes to your dashboard that now includes a variety of charts and visualizations from Application Insights.

Next steps

Now that you've learned how to create custom dashboards, have a look at the rest of the Application Insights documentation including a case study.

[!div class="nextstepaction"] Deep diagnostics