Report Parameters

Overview

Most reports have one or more parameters that allow filtering of report data and specify output formats.

The number and type of parameters vary depending on the type of report but there are some common options. This document describes these parameters.

For details regarding the purpose of the reports and what type of information they display, see Available Reports.

Baseline

Select the baseline model that will be used as the basis for your report. You can select the default baseline or a user defined model. The baseline determines the period that detailed data is held for. Detailed data is raw data, 5 minute summary or hourly summary. Summary data (daily, weekly, monthly, quarterly) is held for longer and you can report on time periods prior to the start date of the baseline.

Entities

An entity is an individual component supplying one or more metrics to Capacity Planner. Each entity is of a specific entity type, for example: cluster, host, VM, physical server, datastore, file, drive etc. Most reports allow you to filter the entities displayed in the report.

Filter by Entity Type

When you select an Entity Type, you can then select one of the options from the Grouping Filter drop-down list:

  • [Select all <Entities>] — select all entities of that type. If you select this option, no further filtering for the selected entity is available.
    Click here to see an exampleClosed
  • [Select <Entities> from list] — choose specific entities from a list. If you select this option, all available entities of the selected type are listed in the Entity Name drop-down list. You can then select one or more entries from this list.
    Click here to see an exampleClosed
  • Filter using an entity Grouping — you can select an entity grouping from the list and then use the Grouping Value drop-down list to select one or more values. The number of entities that have each Grouping Value will appear in the list.
    Click here to see an exampleClosed

Using multiple filters

For most reports, up to three levels of filtering are available. Once you set values for Grouping Filter [1], the remaining two levels default to N/A values, but these can be changed if you want to use two or three levels of filtering. Advantages of using two or three levels are:

  • You can select related entity types and different grouping options. For example, you can use level 1 to select one or more clusters, level 2 to select hosts associated with those clusters, and level 3 to select VMs associated with those hosts.
  • You can select the same entity type multiple times, but with different filters to enable a more complex selection, for example, using different groupings together.
    Click here to see an exampleClosed
  • Files and drives are only available at level 2 and 3, so to report on these it is necessary to select a parent entity type first. Examples:
    • Select VM at Level 1 Entity Type and file/drive at Level 2.
    • Select cluster at Level 1 Entity Type, VM at Level 2 and file/drive at Level 3.

Metric

The Metric filter allows you to select which metric to report on. Some reports allow for multiple metrics to be used. If you filter your report by more than one Entity Type then only the metrics available for the lowest Entity Type in the filtering selection are available.

For most reports, metrics that are stored with a capacity value have two entries listed, with or without the % sign, for example CPU Utilisation Server Level and CPU Utilisation Server Level (%):

  • CPU Utilisation Server Level enables you to view the absolute value of the metric (in this case in MHz) alongside the capacity value.
  • CPU Utilisation Server Level (%) shows the value as a percentage of the capacity.

Click here to see an exampleClosed In this example, Level 1 Entity Type is cluster, Level 2 is VM (VMs that belong to the selected cluster), Level 3 is drive (drives that belong to the selected VMs). The only metrics available are metrics applicable to the selected drives.

Red and amber thresholds

Red and amber thresholds allow you to specify threshold values against your selected metrics to highlight where these values have been exceeded. You can define the following:

  • Red Operator and Amber Operator — allow you to determine how the threshold values are compared to the metric values., For example, greater than, less than, etc.
  • Red Threshold and Amber Threshold — allow you to enter the required threshold values.

Summary level

Summary Level allows you to select the aggregation level for the metrics displayed in a report. The summary levels available vary depending on how Capacity Planner is configured for your organisation. For rolling baselines the daily, weekly, monthly, and quarterly summaries are preserved as the baseline moves forward, so the time periods available for these summaries may exceed the baseline date range.

Levels available may include:

  • Baseline Summary — provides a single set of statistical measures covering the full baseline period. For rolling baselines, this moves forward in time each time the baseline is processed.
  • Monthly Summary — provides a set of statistical measures per calendar month.
  • Weekly Summary — provides a set of statistical measures per calendar week.
  • Daily Summary — provides a set of statistical measures for each 24-hour period.
  • Hourly Average — provides average values for each hour.
  • Unaggregated Data — provides values at the frequency of the raw metric data imported into Capacity Planner. For many metrics this is typically 5 minute data. The time required to run reports is strongly related to the number of data points, so running reports using unaggregated data can take a considerable amount of time to complete if an extended date range is used across multiple entities.

Date range type

There are three Date Range Types available:

  • Relative Date Range:
    • Relative Date Range from latest data — allows you to choose a range for the report relative to the latest date for which data is available.
    • Relative Date Range from today’s date — allows you to choose a date range for the report relative to the date on which the report is run.
    If you select one of the relative date range options, then the Relative Range drop-down list gets activated. Here you can select the calendar unit, for example months, weeks, or days. In the Date/Time Periods field you can specify how many of these calendar units to include in the report.
    Examples:
    • Select Relative Date Range from today’s date, along with a relative date range of Latest ‘N’ Months and a Date/Time Periods value of 2, and run the report on the 7 December. The report includes all available data for November and December.
    • Select Relative Date Range from today’s date, along with a relative date range of Latest ‘N’ Complete Months and a Date/Time Periods value of 2, and run the report on the 7 December. This ensures that only complete calendar periods are considered and the report only includes data from October and November.
  • Specific Date Range — allows you to enter specific dates in the Date from and Date to fields. The date must be entered in US format: Month/Day/Year HH:MM:SS AM/PM.
    Click here to see an exampleClosed

Chart type

If there are multiple chart types available in a report, you can select which type to display. The available chart types vary depending on the report used and the metrics and summary level selected.

Available chart types include:

  • Box plot
  • Line chart
  • Linear Trend
  • Bar Chart
  • Radar Chart
  • Scatter Plot (Metrics Pairs Reversed)
  • Scatter Plot (Metric Pairs)
  • Stacked Bar Chart
  • Treemap

Box plots

Box plots are only available for daily, weekly, monthly, quarterly, and baseline summary levels and they display all statistical measures for the selected Summary Level. Other chart types are only able to display one measure, the one selected in the Percentile/Value drop-down list.

Scatter plot

The Scatter Plot (Metric Pairs) and Scatter Plot (Metric Pairs Reversed) are available in the Metric Analysis — Multi-Chart report when two metrics are selected. These charts show a linear regression analysis of the metric pair with a trend line, and calculated gradient, intercept, and r2 values. Switching between the two chart types transposes the X and Y axes of the resulting charts.

Linear trend

The Linear Trend chart is available in the Metric Analysis — Multi-Chart report and shows a linear regression analysis of single metrics against time with a trend line, and calculated gradient, intercept, and r2 values.

Percentile/Value

For unaggregated data and hourly averages, only a single time series value is available (mean value). For higher summary levels, such as daily summary, a set of statistical measures is available, for example median, 95th percentile, latest value, etc.

Apart from box plots, all other chart types are only able to plot a single measure, so this enables you to select which one is shown on the chart. The selected measure is also used in the calculation of threshold values and for filter values, irrespective of the chart type.

Filter operator and threshold

In some reports, you can filter the used source data values by using the Filter Operator and Threshold.

The Filter Operator allows you to specify how the comparison is made and the Filter Threshold allows you to specify the threshold value. The Filter Operator acts on the selected Percentile/Value.

If the chart type is Scatter Plot (Metric Pairs), Scatter Plot (Metric Pairs Reversed), or Linear Trend then additional options of filtering by r2 values appear in the list.

Y-Axis scale

You can decide what Y-Axis scale to use:

  • 0 - 100 — fixes the y-axis to display the values from 0 to 100. This is useful for metrics that are percentages, but if used with metrics with values that are outside of this range, not all data points are visible on the chart.
  • Scale to fit — automatically scales the y-axis to ensure all data points fit on the chart.

Legend

You can decide what to display in the legend of your report or you can hide the legend completely. Options in the Legend parameter depend on the type of the report you created.

Show/Hide capacity

Metric Capacity can be shown alongside metric values, which is particularly useful where metrics are shown as absolute values rather than percentages. This option controls whether capacity values are shown or hidden.

Report size

Some reports may take a long time to generate when a large number of data points need to be plotted. The Report Size option allows you to specify if you want to wait on the report to run to completion based on the number of rows of data generated by the report. If a report data set is larger than the selected value, you are alerted and have the option to increase the allowable report dataset size.

Example filter

The following is an example of a report filter.

In this scenario, we want to know if the CPU Ready % per vCPU metric for any SQL VM in the Consumer Business Area has had a single day in the last calendar month where it has spent 5% of its time above a value of 5 for amber or 10 for red.