14.16 DataSummary

Use this Knowledge Script to generate a report containing a statistical summary of selected datastreams.

The data wizard allows you to select any combination of datastreams for a report. Depending on which datastreams you select and which style you select, your report can contain meaningful, easily-understood information, or it can contain information that is of no value.

The following examples of selecting datastreams and report styles show the different types of information reports can contain in each case.

By computer style

If you select different datastreams that use different units of measure, the report contains a separate value for each datastream from each computer.

For example, if you select the following datastreams:

  • Ldsk: D:USED %

  • Ldsk: D:AVAIL MB

the report contains one value for each computer for the percentage of used space on the D: drive, and one value for each computer for the available megabytes on the D: drive.

If you select different datastreams that use the same unit of measure, the report contains one value for each computer.

For example, if you select the following datastreams:

  • Ldsk: D:USED %

  • MemPhysUsage %

the report contains a single percentage value for each computer. Each single percentage value is derived from all memory usage and disk usage values taken together. In this case, the values in the report are meaningless.

By legend style

If you select multiple datastreams with the same legend from two different computers, the report contains one value for each different legend.

For example, if you select the following datastreams:

  • Ldsk: D:USED %

  • Ldsk: D:AVAIL MB

the report contains one value for the percentage of used space on both D: drives, and one value for the available megabytes on both D: drives. This type of report would be useful, for example, if you wanted an overall statistic of disk space availability or memory use for something like a server farm.

If you select multiple datastreams with different legends, the report contains one value for each legend.

For example, if you select the following datastreams:

  • Ldsk: D:USED %

  • MemPhysUsage %

the report contains a single percentage value for each legend. One percentage value is derived from disk usage on both computers, the other from memory usage on both computers. As in the previous example, this type of report is useful for overall statistics.

By computer and legend style

The by computer and legend style lets you get individual values for each datastream from each computer.

Using this style, if you select the following datastreams:

  • Ldsk: D:USED %

  • Ldsk: D:AVAIL MB

the report contains one value for each datastream for each computer.

If you select the following datastreams:

  • MemPhysUsage %

  • Ldsk: D:USED %

the report contains one value for each datastream for each computer.

Regardless of the style you select, the table in the report always shows the average, minimum, maximum, and count values for a datastream. It may show additional values, as well, depending on how you configure the report.

14.16.1 Resource Object

Report agent

14.16.2 Default Schedule

The default schedule is Run once.

14.16.3 Setting Parameter Values

Set the following parameters as needed:

Parameter

How To Set It

Data source

Select data wizard

Select the data for your report by Knowledge Script or by datastream.

Select time range

Filter the data for your report by a specific or sliding time range. The default is Sliding.

Select peak weekday(s)

Filter the data for your report by days of the week.

Select the style

Select the style for the report:

  • By computer shows values for each computer you selected.

  • By legend shows one value for each different legend.

  • By computer and legend shows one value for each unique legend from each computer.

Data settings

Statistics to show

Select a statistical method by which to display data in the report:

  • Average: The average value of data points for the aggregation interval (for example, the average value for 1 Hour)

  • Minimum: The minimum value of data points for the aggregation interval

  • Maximum: The maximum value of data points for the aggregation interval

  • Min/Avg/Max: The minimum, average, and maximum values of data points for the aggregation interval

  • Range: The range of values in the datastream (maximum - minimum = range)

  • StandardDeviation: The measure of how widely values are dispersed from the mean

  • Sum: The total value of data points for the aggregation interval

  • Close: The last value for the aggregation interval

  • Change: The difference between the first and last values for the aggregation interval (close - open = change)

  • Count: The number of data points for the aggregation interval

Select sorting/display option

Select whether data is sorted, or the method of display:

  • No sort: Data is not sorted

  • Sort: Data is sorted by value (lowest to highest from front to back; highest to lowest from left to right)

  • Top %: Chart only the top N % of selected data (sorted by default)

  • Top N: Chart only the top N of selected data (sorted by default)

  • Bottom %: Chart only the bottom N % of data (sorted by default)

  • Bottom N: Chart only the bottom N of selected data (sorted by default)

Percentage/count for top/bottom

Specify a number for either the percent or count defined in the previous parameter (for example, Top 10%, or Top 10).

The default is 25.

Truncate top/bottom?

If set to yes, then the data table shows only the top or bottom N or % (for example, only the top 10%).

Otherwise, the table shows all data.

The default is no.

Show totals on the table?

If set to yes, then additional calculations are made for each column of numbers in a table, and the following values are listed at the end of the table:

  • Report Average: An average of all values in a column

  • Report Minimum: The minimum value in a column

  • Report Maximum: The maximum value in a column

  • Report Total: The total of all values in a column

The default is no.

Report settings

Include parameter help card?

Set to yes to include a table in the report that lists parameter settings for the report script. The default is yes.

Include table/chart/both?

Select the type of datastream values you want to include in the report:

  • Table (table only)

  • Chart (chart only)

  • Both (table and chart)

Select chart style

Define the graphic properties of the charts in your report.

Select output folder

Set parameters for the output folder.

Add job ID to output folder name?

Set to yes to append the job ID to the name of the output folder.

A job ID helps you correlate a specific instance of a Report Script with the corresponding report.

The default is no.

Select properties

Set miscellaneous report properties as desired.

Add time stamp to title?

Set to yes to append a time stamp to the title of the report, making each title unique. The time stamp is made up of the date and time the report was generated.

A time stamp allows you to run consecutive iterations of the same report without overwriting previous output.

The default is no.

Event notification

Event for report success?

Set to yes to raise an event when the report is successfully generated. The default is yes.

Severity level for report success

Set the event severity level, from 1 to 40, to indicate the importance of the event. The default is 35 (magenta level indicator).

Severity level for report with no data

Set the event severity level, from 1 to 40, to indicate the importance of the event. The default is 25 (blue level indicator).

Severity level for report failure.

Set the event severity level, from 1 to 40, to indicate the importance of the event. The default is 5 (red level indicator).