Skip to main content

SYS.History.Hourly

Class SYS.History.Hourly Extends (%Persistent, %XML.Adaptor) [ System = 4 ]

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.

Properties​

DateTime​

Property DateTime As %TimeStamp [ SqlColumnNumber = 2 ];

Time of summary

PerfCount​

Property PerfCount As %Integer;

Number of Performance samples in this Hourly period

SysCount​

Property SysCount As %Integer;

Number of SystemUsage samples in this Hourly period

WDCount​

Property WDCount As %Integer;

Number of WriteDaemon cycles in this Hourly period

Perf​

Property Perf As array Of SYS.History.Performance;

Performance metrics

WD​

Property WD As array Of SYS.History.WriteDaemon;

WriteDaemon metrics

Sys​

Property Sys As array Of SYS.History.SystemUsage;

System Usage metrics

DB​

Property DB As array Of SYS.History.Database;

Database metrics

ZDATE​

Property ZDATE As %Integer;

UTC date key

ZTIME​

Property ZTIME As %Integer;

UTC time key

Methods​

Purge​

ClassMethod Purge(Keep As %Integer = 0) As %Integer

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.

Export​

ClassMethod Export(FileName As %String, Start As %TimeStamp, End As %TimeStamp, Class As %String, Function As %String, Database As %String) As %Status

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'

SetPurge​

ClassMethod SetPurge(Keep As %Integer = "") As %Integer

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.