This article only applies to Squared Up Version 2.0. If you're looking for help with Squared Up Version 3.0, please visit our new knowledge base

Overview

Squared Up enables you to add a wide range of visualizations using performance data from the SCOM data warehouse. This document describes how to get started with the Performance plugin. This plugin is installed with Squared Up.

Performance Plugin Demo Dashboard

If you wish, you can download a demo dashboard from Community Dashboards:

1. Download the Performance Plugin demo dashboard:

Performance Plugin Demo Dashboard

2. Import it into Squared Up by clicking 'import dashboard' on the right hand menu.

Configuration


Create a new section within the designer, then in Type select 'Performance'.


Setting the Scope

See How to set the scope using the dashboard designer.

Setting the Visualisation


Choose from three styles of chart: Graph, Sparkline or Bar.

A graph shows several servers on one graph with a y-axis:

Sparklines show individual server visualizations with maximum, minimums and current figures:

Bar charts show comparable data, and can also show the top or bottom ranking metrics in descending or ascending order as Top N:

Setting the Metric

The 'quick find' option will find metrics available for the scope you have set as you type.   To see a list of all the metrics available, press the down arrow on your keyboard.


See also:

How to show multiple metrics on one graph

How to use wildcards in metrics to display performance information

How to find the CounterName for a Performance section

Dragging a Performance Graph onto a dashboard

No available data


Changing the data range

The 'data range' option allows you to change how the graph is displayed.

Percentage - This is the default, and will adapt to any data type adjusting the y-axis to the data.

Fit to data - Will adjust the y-axis to range from the the minimum data point to the maximum.

Fit to data (from zero) - y-axis will range from 0 to the maximum data point.

Custom - Allows you to set the minimum and maximum points of the y-axis.



Total / Average / Top


For a Sparkline graph or bar chart you can choose whether to display an individual graph, the data as a total, or the data as an average:

For Bar charts you have the additional option of showing top N, for example the top 3 results in descending or ascending order.


Setting the timeframe, resolution and data type


You can choose the timeframe over which the graph will display.


Resolution

Squared Up shows the highest resolution data available for the graph period, by default 'real-time' data.  So it will show the real-time data, unless this data is not available in the data warehouse (depending on your retention settings) for the whole graph period, then it will show the next highest resolution data available, i.e. hourly or daily.  The 'hourly' setting will show hourly data, if available, otherwise it will show daily. The 'daily' setting will show daily aggregated data.


With 'hourly' and 'daily' data there may be less detail and therefore smoother looking graphs. (On the graph drilldown it is dynamic based on the data warehouse retention settings, i.e. it will show raw data if it's available for the period selected.)


Hourly/daily data type

Here you can choose whether you'd like to see the average, minimium or maximum figures for the aggregated time period.  For example, for a web transaction you might want to see the maximum or minimum figures rather than the average. 


If no data is shown, try increasing the timeframe.


The data resolution defaults to real-time, but you can change this to hourly or daily.

When hourly or daily are chosen you can change the data type from average to min (lowest data value within that timeframe) or max(largest data value within the timeframe).


Graphs are displaying daily data instead of hourly, why?

See Graphs are displaying daily data instead of hourly, why?


Setting the display options

You can now choose to display your graphs in colour.  Graphs default to coloured, while sparklines and bar charts default to single-colour (blue).  For graphs you can choose to show a key, which is particularly useful for Open Access dashboards where hovering over a line does not show any details.



Changing the graph size

To make a graph display larger or smaller on the dashboard simply drag the orange bar beneath the graph (while in Edit mode).

Troubleshooting

Troubleshooting the Performance plugin

XML Configuration

The dashboard designer writes these settings as XML to a dashboard file within C:\inetpub\wwwroot\SquaredUpv2\Configuration\Views. Below is an example of the XML it will write for this section:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<Section>
  <Id>1426624303412</Id>
  <Title>New section</Title>
  <Plugin>Performance</Plugin>
  <ScomData>
    <DataType>object</DataType>
    <Scope>
      <Group>6f7e3306-beeb-2996-3795-7c1eafb925b8</Group>
      <Filters />
      <Objects />
    </Scope>
  </ScomData>
  <Settings>
    <NameValueSetting>
      <Name>style</Name>
      <Value>sparkline</Value>
    </NameValueSetting>
    <NameValueSetting>
      <Name>timeframe</Name>
      <Value>Last24Hours</Value>
    </NameValueSetting>
    <NameValueSetting>
      <Name>range</Name>
      <Value>percentage</Value>
    </NameValueSetting>
    <NameValueSetting>
      <Name>graphheight</Name>
      <Value>200</Value>
    </NameValueSetting>
    <NameValueSetting>
      <Name>object</Name>
      <Value>LogicalDisk</Value>
    </NameValueSetting>
    <NameValueSetting>
      <Name>counter</Name>
      <Value>Free Megabytes</Value>
    </NameValueSetting>
    <NameValueSetting>
      <Name>instance</Name>
      <Value />
    </NameValueSetting>
  </Settings>
</Section>

XML Settings Reference

Name Values Comments Required Designer
style graph (default) | sparkline | bar
Yes Yes
graphheight <number> The height in number of pixels No No
range percentage | fit | zero-fit | custom

The min and max will be set, depending on the option selected

percentage = 0 to 100

fit = data min to data max
zero-fit = 0 to data max

custom = rangemin to rangemax

No Yes
rangemin <number> When custom range is selected, the number at which the range starts No No
rangemax <number> When custom range is selected, the number at which the range finishes No No
object <comma-separated strings>

Comma-separated values can be used to specify multiple objects.

Wildcards can be used. The wildcard character is *
Yes Yes
counter <comma-separated strings> Comma-separated values can be used to specify multiple counters.
Wildcards can be used. The wildcard character is *
Yes Yes
instance <comma-separated strings>
Comma-separated values can be used to specify multiple instances.
Wildcards can be used. The wildcard character is *
No No
aggregate average | total The calculation used to aggregate the data No No
top <number> For bar charts, you can show the objects with the ‘top N’ values (or bottom N if the sort order is ascending). No No
sort desc | asc The sort order of the displayed data No No
timeframe All | LastHour | Last12Hours | Last24Hours | Last7Days | Last30Days The timeframe of the data displayed Yes Yes
monitorId <SCOMID> The ID of the SCOM monitor(s) appropriate for the counter used. No No

See also:

Troubleshooting the Performance plugin

The Dashboard Designer - The Quick Start Guide

How to find the CounterName for a Performance section

How to show multiple metrics on one graph

How to use wildcards in metrics to display performance information

How to set the scope using the dashboard designer

Dragging a Performance Graph onto a dashboard

How to resize a performance graph

Graphs are displaying daily data instead of hourly, why?