Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / %SYS.Monitor
Private  Storage   


Controling class for System Monitor. Used to start and stop System Monitor process. Includes helper config methods used by ^%SYSMONMGR.


Parameters Properties Methods Queries Indices ForeignKeys Triggers


%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject AddComponentClass CalcSignif CalcStats
ClearEvents CreateEvents Debug DebugLev
DeleteStartNS Enabled InitializeDB Interval
IsComponent IsUp KeepDashboardDays KeepReadingsDays
LatestSample ListStartNS Lock RefreshSensors
RemoveComponentClass ResetDefault SetStartNS Start
StartSystemMonitorUserNS State Stop StudentTTest


• classmethod AddComponentClass(Sclass As %String, Desc As %String = "") as %Status
Add class to Monitor
• classmethod CalcSignif(Tval, Degrees, ByRef NullProbability As %String)
Returns NullProbability = 0: Null hypothesis < 90% probability Returns NullProbability = 1: Null hypothesis < 95% probability Returns NullProbability = 2: Null hypothesis < 99% probability Returns NullProbability = 3: Null hypothesis < 99.9% probability Returns NullProbability = 4: Null hypothesis > 99.9% probability
• classmethod CalcStats(ByRef Readings As %List, ByRef Mean As %Integer, ByRef Sigma2 As %Integer) as %Status
Calculate mean and standard deviation squared based on list of values
• classmethod ClearEvents() as %Status
Clear all System monitor events
• classmethod CreateEvents() as %Status
Create all System monitor events
• classmethod Debug() as %Integer
Signal a one-time write of current Sensors to %SYS.Monitor.SensorReading
• classmethod DebugLev(level As %Boolean) as %Boolean
System Monitor debug level. Setting to '1' will cause %SYS.Monitor.Control to save SystemSensors as %SYS.Monitor.SensorReading objects.
• classmethod DeleteStartNS(Namespace As %String) as %Status
Remove a System Monitor startup namespace
• classmethod Enabled(state As %Boolean) as %Boolean
Disable / Enable System Monitor
• classmethod InitializeDB() as %Status
• classmethod Interval(int As %Integer) as %Integer
System Monitor sample interval
• classmethod IsComponent(Sclass As %String) as %Boolean
Check if class is a component of System Monitor
• classmethod IsUp() as %Integer
Check if System Monitor is running
• classmethod KeepDashboardDays(days As %Integer) as %Integer
Set number of days of Dashboard history to keep. Default is 5 days. Returns current number of days.
• classmethod KeepReadingsDays(days As %Integer) as %Integer
Set number of days Health Monitor is to keep alert records. Default is 5 days. Returns current number of days.
• classmethod LatestSample()
Display all Sensors for latest Debug Sample (see Debug() above)
• classmethod ListStartNS(Namespace As %String) as %Status
List System Monitor startup namespaces
• classmethod Lock() as %Boolean
System Monitor Lock
• classmethod RefreshSensors() as %Integer
Process sensors
• classmethod RemoveComponentClass(Sclass As %String) as %Status
Remove component class from Monitor
• classmethod ResetDefault() as %Status
Reset all system monitor configuration data to default values
• classmethod SetStartNS(Namespace As %String) as %Status
Set a System Monitor startup namespace
• classmethod Start() as %Status
Main classmethod
• classmethod StartSystemMonitorUserNS() as %Status
Start System Monitor in user namespaces where %MONAPP is active
• classmethod State() as %String
Get the state for a subscriber Return: 0 - not running, -1 - unexpected error, else string with state information.
• classmethod Stop() as %Integer
Stop the System monitor
• classmethod StudentTTest(Readings1 As %List, Readings2 As %List, ByRef Mean1 As %Integer, ByRef Mean2, ByRef Sigma1 As %Integer, ByRef Sigma2 As %Integer, ByRef TVal, ByRef Degree, ByRef Result) as %Status
Perform the Student T-Test for 2 sets of data. Result is a string giving probability that the means of the two sets are significantly (statistically) different.
• classmethod Unlock() as %Boolean
System Monitor Unlock