Home > Class Reference > %SYS namespace > SYS.Metrics
Private  

SYS.Metrics

This class contains the methods used to calculate system metrics displayed by the System Dashboard. For internal use only.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 9

Summary

Methods
GetDatabaseMetrics GetECPStatistics GetGlobalStatistics GetMainMetrics
GetProcessMetrics GetSeparator GetShadowMetrics GetStatistics
GetTaskMetrics
Subclasses
SYS.EnsMetrics

Parameters

parameter DOMAIN = "%Utility";
Default Localization Domain

Methods

classmethod GetDatabaseMetrics(pID As %String, pCount As %Integer, Output pValues, Output pStatus, Output pMsg) as %Status
Return metrics for database specified by pID
classmethod GetECPStatistics(pID As %String, pCount As %Integer, Output pValues, Output pStatus, Output pMsg) as %Status
Return metrics for ECP statistics
classmethod GetGlobalStatistics(pID As %String, pCount As %Integer, Output pValues, Output pStatus, Output pMsg) as %Status
Return metrics for system Global and Resource statistics
classmethod GetMainMetrics(pID As %String, pCount As %Integer, Output pValues, Output pStatus, Output pMsg) as %Status
This method returns the metric values used by the main system dashboard. pID is an optional identifier; this is used for dashboards that may provide values for different items.
pCount indicates how many times the corresponding Dashboard last called this method. On the initial call, this value is 0. This is useful for cases where you do not want to recalculate value each time.
classmethod GetProcessMetrics(pID As %String, pCount As %Integer, Output pValues, Output pStatus, Output pMsg) as %Status
Return metrics for process specified by pID. The pID must be in decimal form.
classmethod GetSeparator() as %String
classmethod GetShadowMetrics(pID As %String, pCount As %Integer, Output pValues, Output pStatus, Output pMsg) as %Status
Return metrics for shadow server specified by pID
classmethod GetStatistics(pID As %String, pCount As %Integer, Output pValues, Output pStatus, Output pMsg) as %Status
Return metrics for system statistics
classmethod GetTaskMetrics(pID As %String, pCount As %Integer, Output pValues, Output pStatus, Output pMsg) as %Status
Return metrics for task schedule specified by pID