14 minute readApplies to: v4

How to use the Performance tile

The Performance tile shows graph visualisations of Azure Monitor metrics data.

Graphs can be clicked on to drilldown to the resource dashboard, and from there the view in portal button allows you to link to the resource in the Azure portal:

View In Portal Button

Performance tile types

After clicking on the Performance tile there are several performance graph types to choose from:

Performance Tile

Bar Top N

Bar Top N - uses the latest data to compare data, such as the top or bottom ranking metrics in descending or ascending order, as 'Top N'.

Bar Top N tile button

As these graphs use the latest data, they do not change when the user changes the page timeframe.

Heatmap

Heatmap - displays the metric value as shades of a colour. See the walkthrough below.

Heatmap tile button

Line Graph

Line Graph - This shows metrics, such as CPU for virtual machines, on a line graph with an x-axis (time) and a y-axis. See the walkthrough below.

Line Graph tile button

Sparklines

Sparklines - show individual visualizations with maximum, minimums and current figures.

Sparklines tile button

Report

Report - this allows you to compare metrics, such as two different metrics or metrics over different time periods. For example, compare Percentage CPU with the same period last week, or compare two different metrics on left and right y axes.

Report tile button

For a step by step guide to using this tile see the walkthrough below Adding a Report to compare metrics or time periods

Performance tile options

Scope

When scoping the Performance tile all the resources must be of the same type. The filter by type option is essential when scoping by resource group, subscription or tags. When using the list option take care to select resources of the same type.

The scope section allows you to define what is shown. Results are shown across all subscriptions.

List - to select several individual resources to show.

Resource Group - to select any individual resource group. Use with filter by type to scope to only resources of a particular type (within the resource group). For example, to scope to only virtual machines, type virtual and select virtual machines from the list.

Tags - show select resources with a particular tag. Multiple tags are 'anded' to scope to resources which are tagged with all the tags listed. sort Type - scope to all resources of a particular type, for example all databases.

For more information see How to scope tiles

Metric

The metrics available for the selected scope are searchable as you start typing. If no metrics are listed and the tile is showing the message Resources must all be of the same type then check in the scope that the resources are all of the same type, such as virtual machines. For example, if you have selected a resource group in the scope you should tick filter by type to ensure that only resources of one type are returned.

For more information about metrics available see Supported metrics with Azure Monitor.

SquaredUp does not support metric namespaces.

Dimension

In Azure some metrics may have multiple dimensions. Dimensions of a metric are name-value pairs that carry additional data to describe the metric value.

You can choose to split and/or filter results using these dimensions.

For more information see this Microsoft article Filtering and splitting.

SquaredUp v4.5 and above supports metric dimensions, splitting and filtering.

Apply splitting

You can split by a dimension; this allows you to see a different line for the data for each different value that the chosen dimension has.

When you tick apply splitting you will see a list of all of the dimensions that the scope contains.

Select which dimensions you want to split by, and the data will separate by the different values that the dimension has.

Apply Splitting

Filter by dimension

Alternatively, you can filter to a dimension's specific value. This allow you to see a line that only contains the data for the dimension value that is important to you.

For a metric that has dimensions go into the dimension panel and tick filter by dimension.

Click the add button and a drop down list will allow you to choose your dimension and type in the value of the dimension on the box. This will show you a line that only contains data for the chosen value.

Filter By Dimension

Interval

This allows you to select the interval at which you would like to see data points. For example, data points a minute apart, 30 minutes apart, or a day apart.

Aggregation

Allows you to control how the data is aggregated when using intervals over 1 minute. For example, if using an interval of an hour would you like to the 60 data points collected in each hour to be aggregated together to show you one point for that hour that is the average figure, or the maximum figure.

Timeframe

When adding and editing the tile you can choose either use page timeframe or specific timeframe.

For more information see How to use Timeframe option.

Top n

This allows you to limit the number of results to the top or bottom few by specifying a number, and then ticking descending to see the top few.

Data Range

The Data Range option allows you to choose the range of the y-axis or bar chart area. The min and max will be set, depending on the option selected

percentage shows 0 to 100

fit to data shows the data minimum to data maximum

fit to data (from zero) shows from 0 to the data maximum

custom allows you to specify the min and max

custom fit - allows you to specify the min and max limits, so that data outside your settings will not be shown. If all the data falls within your specified ranges then the y-axis range will fit to the data rather than your caps.

Display

The height slider allows you stretch or shrink the graph height.

Sort

For bar charts and sparklines you can sort the order of the results either by the latest value or the label, in ascending or descending order.

Label

show legend allows you to display a key to the coloured graph lines. When this is selected you can change from the automatic label to specify your own label format. The default label shows the name metric and unit.

Custom labelling

Using the custom option you can create your own advanced label to specify exactly how you want the results to be displayed (using both static text and dynamic properties) to ensure that the results always make sense.

Custom labels use Mustache syntax to insert properties. If you're familiar with mustache, you can specify advanced labels that can transform properties prior to displaying them (such as showing only a portion of text, converting a number or reformatting a date), such as using the javascript split method to separate properties into substrings to make the result more readable.

For more information see How to use custom labelling

Time comparison (Report tile)

This allows you to add a new dashed time comparison line to the graph showing the data as it was in the past.

Time Comparison

A time comparison line can be added to any layer, and will show as a dashed line. See Adding a Report to compare metrics or time periods

Time Comparison graph

The mustache helper

When specifying a mustache for a custom label, clicking the {{}} button or typing {{ brings up a helpful picker which shows all the properties of your selected resource, along with sample values.

Once the mustache helper is displayed, the list of properties will automatically filter based on what you type, allowing you to quickly find a property using a partial name or likely term. Clicking an item in the list will automatically insert that property into your label and complete the mustache.

For example, you can change the default label for disks from name (metric unit) to:

{{name}} | {{metric}} | {{properties.hardwareProfile.vmSize}}

Custom Sublabel

Property names are case-sensitive and should be written as they appear in the mustache helper (e.g. {{resourceGroup}} not {{ResourceGroup}}).

Walkthrough: Adding a Line Graph to show % Processor Time

  1. In SquaredUp navigate to where you'd like the dashboard to be created. Hover over the + button and click dashboard.
  2. Give the dashboard a title, by replacing the text that says New Dashboard.

    The dashboard is saved as you go along so there's no need to save your changes. You can find your dashboard by clicking on the right-hand menu ☰ > system > unpublished.

  3. A new tile has already been added to the dashboard. Edit the title by overwriting the placeholder value New tile with your own title.
  4. The tile selector will already be open. Click Performance.

    Performance Tile

  5. Click on the Line Graph button to create a line graph.

    Performance (Line Graph) tile

  6. Next we need to scope the tile. In the scope section select type then start typing Virtual machines and then click on virtual machines from the results.

    Correctly scoping the tile is very important. For more information see How to scope tiles.

  7. Click next.
  8. In the metric box type cpu and then select Percentage CPU from the results.

    A line graph for the processor usage should now appear. You could stop here, but we'll continue to configure the tile.

  9. Change the interval to 15 minutes.
  10. Change the aggregation to maximum.
  11. Skip the dimension section, as this metric does not have any dimensions.
  12. Leave the timeframe set to use page timeframe so the timeframe for this tile changes when users change the page timeframe.
  13. In the top n section limit the number of results displayed to 3, and tick descending to show those with the highest processor utilisation.
  14. Leave data range as it is.
  15. Leave the display as it is.
  16. In the label tick show legend
  17. Click done.

Walkthrough: Adding a Heatmap to show Percentage CPU

  1. Click the orange + plus button to add a new tile to the dashboard.
  2. Click Performance, and then the Heatmap button.

    Heatmap tile button

  3. Next we need to scope the tile. In the scope section select type then start typing Virtual machines and then click on virtual machines from the results.

    Correctly scoping the tile is very important. For more information see How to scope tiles.

  4. In the metric box type cpu and then select Percentage CPU from the results.

    A heatmap should appear after a moment.

  5. Once you've chosen a metric give the tile a title which explains what the tile shows.
  6. Skip the dimension section, as this metric does not have any dimensions.
  7. In the display section adjust the width and height sliders to change the heatmap sizes.

    Heatmap display

    By default objects with no data are hidden, you can choose to show them by ticking the box show objects with no data.

  8. The colour section allows you to change the heatmap colour.
  9. Leave the data range section as it is for now. This allows you to change the range of values shown.
  10. Leave the label section as it is. For more information on changing the label see How to use custom labelling.
  11. Click done.

    Heatmap

Walkthrough: Adding a Report to compare different metrics and/or time periods

This walkthrough shows you how to add metrics as layers to the Report tile, and also how to compare them with historical data.

  1. Click on the Report button to create a Report.

    Report tile button

  2. Give the tile a title.
  3. The Report tile uses layers to allow you to add multiple metrics to one graph for comparison. This could get difficult to view in a narrow column, so this tile allows you to edit the tile full screen in a report editor). Click configure report to open the report editor and add layers.

    Report editor

    The report editor has opened full screen, but you can return to your dashboard at any time by clicking the back to dashboard button at the top right. The layer configuration appears on the left side of the screen, and a preview of the graph will show on the right as your proceed.

  4. The first layer is expanded ready for you to edit. Give the layer a title, such as the metric you intend to add.
  5. For this walkthrough we are going to compare two metrics for one machine. In the scope section click list then type the name of a machine, and then click on that machine in the results.
  6. In the metric > quick find box type the name of the first metric you want to add. For this walkthrough type CPU and then select the metric Percentage CPU.

    The right side of the screen will show a preview of the graph. You could stop here, but we'll continue to configure the tile.

  7. Click done.
  8. Click the orange plus button to add a second layer for your next metric.
  9. Give this layer the title of the metric you are adding.
  10. Click list then type the name of machine you used for the first layer, and then click on that machine in the results.
  11. In the metric > quick find box type the name of the first metric you want to add. For this walkthrough type disk and then select the metric Disk Read Bytes.
  12. Skip the dimension section, as this metric does not have any dimensions.
  13. Leave the top n section as it is for this walkthrough.

    You might like to add a line to allow you to compare this data with historical data. Adding the time comparison is optional.

  14. In the time comparison section click one of the time periods to compare with this data, for example click yesterday.

    Time Comparison

  15. To add a time comparison for the existing layer, hover over the existing layer and then click the compare layer button to jump straight into the time comparison section and then click yesterday.

    Compare Layer Button

  16. In the y-axis section click on right to get the Disk read bytes graph to use the right-hand y-axis. This is useful because the two metrics use quite different scales, so the two graphs show more clearly using two different y axes.
  17. At this point the graph is complete, so you can click done and then the back to dashboard button up the top right of the page.

    Report editor preview

  18. Return to editing the Report tile by clicking the edit this dashboard button at the top right, and then the edit tile button to the top right of the tile itself.
  19. Click into the legend configuration section and click on show legend to tick the box.
  20. Click done.

    Finished Report

FAQs

Why are no metrics listed?

If no metrics are listed and the tile is showing the message Resources must all be of the same type then check in the scope that the resources are all of the same type, such as virtual machines. For example, if you have selected a resource group in the scope then you should tick filter by type to ensure that only resources of one type are returned.

How to scope tiles

Multiple Metric Dimensions

Filtering and splitting

Squared Up Ltd. (c) 2020Report an issue with this article