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

The Squared Up Server KPI plugin enables you to monitor key performance indicators. This document describes how to get started with the Server KPI plugin to create a KPI dashboard like this one:


Download the Plugin Package

This plugin is not installed with Squared Up, please contact Support if you need it.


Download the Server KPI demo dashboard

1. Download  Server KPI demo dashboard from Community Dashboards:

Server KPI 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 'KPI'.



Scope

Usually you will want to type and select a suitable group here.

For more information see How to set the Scope using the Dashboard Designer.


Check that the objects are displayed before moving on to the Advanced section.


Advanced

The kpis textbox requires a correctly formatted JSON string to be entered. The default setting is "{}", an empty JSON string.

To get started, just copy and paste the following example string into the kpi value section.  This will give you an example Server KPI dashboard which can be edited as required:

   

[
                      {
                      "displayName": "CPU",
                      "comment": "CPU for Windows Server 2012 R2 Full Operating System",
                      "classId": "b4581e53-9477-0b89-fd73-89779bc0848d",
                      "monitor": "c3237fe4-2965-2594-c6b8-dc7d856e5fb9",
                      "performanceRule": "0b52aeb0-4bab-f6e9-e9e3-104482cb08ec",
                      "performanceLabel": "%"
                      },
                      {
                      "displayName": "CPU",
                      "comment": "CPU for Windows Server 2012 Full Operating System",
                      "classId":"73c80f77-9dcd-50a9-908a-c1ecb7452726",
                      "monitor": "c3237fe4-2965-2594-c6b8-dc7d856e5fb9",
                      "performanceRule": "50e648c8-4daf-4153-2cc2-af1726de4a25",
                      "performanceLabel": "%"
                      },
                      {
                      "displayName": "CPU",
                      "comment": "CPU for Windows Server 2008 / 2008 R2 Full Operating System",
                      "monitor": "32c755df-94b4-5f2e-62b7-0fef16758699",
                      "performanceRule": "b603ba1e-c5ec-221e-e9e3-cf2098e7bdbd",
                      "performanceLabel": "%"
                      },
                      {
                      "displayName": "Memory",
                      "comment": "Memory for Windows Server 2012 / 2012 R2 Full Operating System",
                      "monitor": "941a0f86-e0da-6cd2-5676-fef32dcc191b",
                      "performanceRule": "4a2efcfb-6edb-b222-ed26-cda636795502",
                      "performanceLabel": "%"
                      },
                      {
                      "displayName": "Memory",
                      "comment": "Memory for Windows Server 2008 / 2008 R2 Full Operating System",
                      "monitor": "2f9b40b7-f6ae-9dbe-862a-2a102fe12fbc",
                      "performanceRule": "ce3533de-d58c-a1fd-ce0c-f00cd2ed84a2",
                      "performanceLabel": "%"
                      },
                      {
                      "displayName": "Disk",
                      "comment": "Disk for Windows Server 2012 / 2012 R2 Full Operating System",
                      "useObjectName": "true",
                      "monitor": "06d72e61-dd02-3cb6-b530-24d53eb13312",
                      "performanceRule": "26d8d81a-93e8-1ce7-dfc1-501d93be2c32",
                      "performanceLabel": "%"
                      },
                    {
                      "displayName": "Disk",
                      "comment": "Disk for Windows Server 2008 / 2008 R2 Full Operating System",
                      "useObjectName": "true",
                      "monitor": "4ba8ff85-87fd-e855-b4a4-7aac4f8b0bf5",
                      "performanceRule": "b49f6325-f53d-9309-c133-2c73653ca29f",
                      "performanceLabel": "%"
                      },
                      {
                      "displayName": "Network",
                      "comment": "Network for Windows Server 2012 / 2012 R2 Full Operating System",
                      "useObjectName": "true",
                      "monitor": "410db05d-c4e1-0fab-f726-94944187ee67",
                      "performanceRule": "f6dc4e52-4d65-f702-7fc2-b3c01f3e7aa6",
                      "performanceLabel": "%"
                      },
                      {
                      "displayName": "Network",
                      "comment": "Network for Windows Server 2008 / 2008 R2 Full Operating System",
                      "useObjectName": "true",
                      "monitor": "aaf35272-4802-8e7f-8865-d8f2ab613f66",
                      "performanceRule": "83f26327-3805-0697-7b67-556ac72c7ef6",
                      "performanceLabel": "%"
                      }
                      ]

   





If you are using Squared Up v2.1.7 or below you will need to click 'add new setting' and type zoom as the name and list as the value.



Press 'apply changes' and the specified KPI displays will appear below.

Click 'done' and publish as required.





KPI Configuration

You may need to edit the example kpi string, if for example you have you have additional management packs that have added new monitors or performance rules. Each KPI visualization shows the health of a SCOM monitor on the server and the value of a performance metric. The following diagram shows how a KPI visualization displays a monitor and a rule.

The values of "monitor" and "performanceRule" correspond to the SCOM IDs for the relevant monitors and performance rules.

You can use Squared Up to find these IDs:

  1. Browse to an object in Squared Up (for example, the ‘Microsoft Windows Server 2008 R2’ object on a server)
  2. Click on a monitor or performance sparkline. (To show all monitors for an object, click on the ‘Show all monitors and rules’ link on the right.)
  3. The ID of the monitor or rule appears in the resulting page URLs. For example:


http://localhost/SquaredUpv2/config/monitor?monitorId=aaf35272-4802-8e7f-8865-d8f2ab613f66


http://localhost/SquaredUpv2/performance/graph?objectId=9ff25eb6-1e14-d174-ce11-dd2b611d8c3c&ruleInstanceId=156&timeframe=Last12Hours&ruleId=83f26327-3805-0697-7b67-556ac72c7ef6 


For more information see Finding MonitorId and RuleId for KPI Configuration

Troubleshooting

Troubleshooting KPI dashboards

 

KPI Settings Reference

Name Values Comments Required
displayName <string> The name of the KPI displayed. If useObjectName is true then this is replaced with the name of the object that the monitor targets. Yes (if useObjectName is false)
useObjectName true | false (default) If set to true then the name of the object that the monitor targets is used as the display name.

This is useful for KPIs that target multiple objects on a server, such as disks or network devices.
No
comment <string> Used the comment field to annotate your KPI configuration.
This has no functional purpose and is not shown in the UI.
No
classId <SCOMID> Scope the KPI to a particular class. No
monitor <SCOMID> The ID of the monitor to display. Yes
performanceRule <SCOMID> The ID of the performance rule to display. Yes
performanceLabel <string> The label to show following the metric value. Use to display a unit (e.g. 'MB/sec') or a percentage ('%') Yes
rangeMax <number> The maximum value displayed in the bar chart. (default: 100) No


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:

    <Section>
      <Id>1426622731720</Id>
      <Title>New section</Title>
      <Plugin>ServerKpi</Plugin>
      <ScomData>
        <DataType>object</DataType>
        <Scope>
          <Group>6f7e3306-beeb-2996-3795-7c1eafb925b8</Group>
          <Filters />
          <Objects />
        </Scope>
      </ScomData>
      <Settings>
        <NameValueSetting>
          <Name>kpis</Name>
          <Value>{}</Value>
        </NameValueSetting>
      </Settings>
    </Section>

 

XML Settings Reference

Name Values Comments Required Designer
kpis As above. A JSON string representing KPI settings. Yes Yes
zoom list    Yes Yes


See also:

Troubleshooting KPI dashboards

The Dashboard Designer - The Quick Start Guide