This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > SYS.History.PerfData


persistent class SYS.History.PerfData extends %Library.Persistent, %XML.Adaptor

SQL Table Name: SYS_History.PerfData

Basic detail collection class of Performance metrics for the Monitor History database. Properties represent metrics which get collected every few seconds by the %MONAPP Application Monitor process when the %Monitor.System.HistoryPerf class is "active". The values stored for most properties are deltas calculated from the last interval.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property DateTime as %TimeStamp;
Time of sample
Property methods: DateTimeDisplayToLogical(), DateTimeGet(), DateTimeGetStored(), DateTimeIsValid(), DateTimeLogicalToDisplay(), DateTimeLogicalToXSD(), DateTimeNormalize(), DateTimeOdbcToLogical(), DateTimeSet(), DateTimeXSDToLogical()
property Length as %Integer;
Length of sample in seconds
Property methods: LengthDisplayToLogical(), LengthGet(), LengthGetStored(), LengthIsValid(), LengthLogicalToDisplay(), LengthNormalize(), LengthSet(), LengthXSDToLogical()
property Perf as SYS.History.Performance;
Performance metrics
Property methods: PerfGet(), PerfGetObject(), PerfGetObjectId(), PerfGetStored(), PerfGetSwizzled(), PerfIsEmpty(), PerfIsValid(), PerfNewObject(), PerfSet(), PerfSetObject(), PerfSetObjectId(), PerfUnSwizzle()
property WD as array of SYS.History.WriteDaemon;
WriteDaemon metrics
Property methods: WDBuildValueArray(), WDCollectionToDisplay(), WDCollectionToOdbc(), WDDateListClose(), WDDateListExecute(), WDDateListFetch(), WDDateListFetchRows(), WDDateListFunc(), WDDateListGetInfo(), WDDateListGetODBCInfo(), WDDateListPrepare(), WDDateListSendODBC(), WDDisplayToCollection(), WDGet(), WDGetObject(), WDGetObjectId(), WDGetStored(), WDGetSwizzled(), WDIsValid(), WDOdbcToCollection(), WDSet(), WDSetObject(), WDSetObjectId()
property ZDATE as %Integer [ Required ];
UTC date key
Property methods: ZDATEDisplayToLogical(), ZDATEGet(), ZDATEGetStored(), ZDATEIsValid(), ZDATELogicalToDisplay(), ZDATENormalize(), ZDATESet(), ZDATEXSDToLogical()
property ZTIME as %Integer [ Required ];
UTC time key
Property methods: ZTIMEDisplayToLogical(), ZTIMEGet(), ZTIMEGetStored(), ZTIMEIsValid(), ZTIMELogicalToDisplay(), ZTIMENormalize(), ZTIMESet(), ZTIMEXSDToLogical()

Methods (Including Private)

classmethod Export(FileName As %String, Start As %TimeStamp, End As %TimeStamp) as %Status
Export PerfData data for time range in CSV format. The default is all of the data currently in the PerfData class. Note that Write Daemon cycle properties are exported as the high-water mark for the cycles during an interval.

The default FileName is HistoryPerf_config_date_time.csv in the MGR directory.
'Start' and 'End' times (if necessary) are in YYYY-MM-DD HH:MM:SS format.
classmethod Purge(Keep As %Integer = 0) as %Integer
Purge PerfData interval data, keeping the last 'Keep' days. This is typically called at the start of each day from the %Monitor.System.HistoryPerf class, 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.
classmethod Sample() as SYS.History.PerfData
Instantiate the class and fetch current values for all metric properties.
classmethod SetPurge(Keep As %Integer = "") as %Integer
Set the system parameter for the number of days of detail data to keep. Initial system default is 7 days. Return value is the previous setting, and executing this method with a "" argument will return the current setting without modifying it.
classmethod Summary(Day As %Integer = 0) as %Status
Collect summaries of the PerfData metrics for a day into the Hourly/Daily database. This is typically done automatically by %Monitor.System.HistoryPerf at the beginning of each day (for the previous day), but could be called manually if there's a problem.

The 'Day' argument sets the end date of the collection, with the default of "0" being the start of today (i.e. $H+Day), which would collect everything for yesterday. A "-1" would collect the day before yesterday; a "1" would collect today (as much as there is).


query DateList(Start As %TimeStamp = $zdt(+$h, 3), End As %TimeStamp = $zdt($h+1, 3))
SQL Query:
SELECT * FROM PerfData WHERE (DateTime >= :Start AND DateTime <= :End)
Full listing of PerfData metrics for a day or range of date/times. Default is today.
query WDDateList(Start As %TimeStamp = $zdt(+$h, 3), End As %TimeStamp = $zdt($h+1, 3))
SQL Query:
SELECT DateTime,PerfData_WD.* FROM PerfData,PerfData_WD WHERE ((PerfData_WD.PerfData = PerfData.ID) AND (DateTime >= :Start) AND (DateTime <= :End))
Full listing of WriteDaemon PerfData metrics for a day or range of date/times. Default is today.


index (ZDTindex on ZDATE,ZTIME) [IdKey, Type = key];
Index methods: ZDTindexCheck(), ZDTindexDelete(), ZDTindexExists(), ZDTindexOpen(), ZDTindexSQLCheckUnique(), ZDTindexSQLExists(), ZDTindexSQLFindPKeyByConstraint(), ZDTindexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)


Storage Model: CacheStorage (SYS.History.PerfData)


Storage Model: CacheStorage (SYS.History.PerfData)

FeedbackOpens in a new window