Skip to main content

%Monitor.System.SystemMetrics

Class %Monitor.System.SystemMetrics Extends (%Monitor.System.Abstract, %Monitor.System.AbstractMetrics, %Monitor.System.AbstractGlobals) [ Deprecated, Inheritance = right, System = 4 ]

Monitor PERFMON metrics for the system.

** DEPRECATED **. This class has been deprecated for performance issues, and will no longer collect SystemMetrics.

This class, and others that inherit from %Monitor.System.Abstract, provides an object API to the same system metrics as the ^PERFMON utility. Instantiating this class also starts the collection of ^PERFMON system level metrics, which can have a significant impact on a busy system. Note that stopping ^PERFMON will also disable the sampling here.

Properties are inherited from AbstractMetrics and AbstractGlobals.

Parameters​

APPLICATION​

Parameter APPLICATION [ Internal ] = "CACHE";

Properties​

Data​

Property Data As %String [ Internal, MultiDimensional ];

Methods​

Startup​

Method Startup() As %Status

On Startup enable PERFMON

Initialize​

Method Initialize() As %Status

Initialize system metrics

GetSample​

Method GetSample() As %Status

Get system metric sample A return code of $$$OK indicates there is a new sample instance. A return code of 0 indicates there is no sample instance.