%SYS
Hourly Class Reference

This class is an Hourly summary of the detail PerfData and SysData collections. More...

Inheritance diagram for Hourly:
Collaboration diagram for Hourly:

Static Public Member Functions

_.Library.Status Export (_.Library.String FileName, _.Library.TimeStamp Start, _.Library.TimeStamp End, _.Library.String Class, _.Library.String Function, _.Library.String Database)
 Export Hourly data for a time range in CSV format. More...
 
_.Library.Integer Purge (_.Library.Integer Keep)
 Purge Hourly total data, keeping the last 'Keep' days. More...
 
_.Library.Integer SetPurge (_.Library.Integer Keep)
 Set the system parameter for the number of days of hourly data to keep. More...
 

Public Attributes

 DB
 Database metrics. More...
 
 DateTime
 Time of summary. More...
 
 Perf
 Performance metrics. More...
 
 PerfCount
 Number of Performance samples in this Hourly period. More...
 
 Sys
 System Usage metrics. More...
 
 SysCount
 Number of SystemUsage samples in this Hourly period. More...
 
 WD
 WriteDaemon metrics. More...
 
 WDCount
 Number of WriteDaemon cycles in this Hourly period. More...
 
 ZDATE
 UTC date key. More...
 
 ZTIME
 UTC time key. More...
 

Detailed Description

This class is an Hourly summary of the detail PerfData and SysData collections.

For each class sample collected you may chose to have the Average, Maximum, Minimum, Median, Standard Deviation, and Total maintained for the day. By default Average, Maximum, and Standard Deviation are kept. Use the SetSummary method in each individual class (Performance, SystemUsage, etc.) to modify this. Performance counters (SYS.History.Performance) are normalized to a per-second rate for all the calculations.



By default, this data is automatically purged after 60 days.

For details, see History Monitor.

Member Function Documentation

◆ Export()

_.Library.Status Export ( _.Library.String  FileName,
_.Library.TimeStamp  Start,
_.Library.TimeStamp  End,
_.Library.String  Class,
_.Library.String  Function,
_.Library.String  Database 
)
static

Export Hourly data for a time range in CSV format.

The default is all of the

Perf, Sys and WD data currently in the Hourly class.

The default FileName is HistoryHour_config_date_time.csv in the MGR directory.
'Start' and 'End' times (if necessary) are in YYYY-MM-DD HH:MM:SS format.
'Class' can be a comma-delimited list one or more of these classes of metrics: "Perf", "Sys", "WD". Or it can be "DB" to select the Database properties. The Database class can not be mixed with the other classes since it uses a different key structure to accommodate multiple databaes.
'Function' can be a comma-delimited list one or more of these summary functions: "Avg", "Max", "Min", StDev", Med" or "Tot". The default is to include all summary functions.
'Database' can be used to select a specific database (by name). Only used if "DB" is selected in 'Class'

◆ Purge()

_.Library.Integer Purge ( _.Library.Integer  Keep)
static

Purge Hourly total data, keeping the last 'Keep' days.

This is typically called at

the start of each day from the Monitor.System.History* classes, using the current system default for 'Keep' (see the SetPurge() method). The 'Keep' argument allows you to over ride the system default (a value of "0" or "" uses the system default)

Returns the number of entries purged.

◆ SetPurge()

_.Library.Integer SetPurge ( _.Library.Integer  Keep)
static

Set the system parameter for the number of days of hourly data to keep.

Initial system default is 60 days. Return value is the previous setting, and executing this method with a "" argument will return the current setting without modifying it.

Member Data Documentation

◆ DB

DB

Database metrics.

 

◆ DateTime

DateTime

Time of summary.

 

◆ Perf

Perf

Performance metrics.

 

◆ PerfCount

PerfCount

Number of Performance samples in this Hourly period.

 

◆ Sys

Sys

System Usage metrics.

 

◆ SysCount

SysCount

Number of SystemUsage samples in this Hourly period.

 

◆ WD

WD

WriteDaemon metrics.

 

◆ WDCount

WDCount

Number of WriteDaemon cycles in this Hourly period.

 

◆ ZDATE

ZDATE

UTC date key.

 

◆ ZTIME

ZTIME

UTC time key.