class %Monitor.System.SystemMetrics extends %Monitor.System.Adaptor, %Monitor.System.Abstract, %Monitor.System.AbstractMetrics, %Monitor.System.AbstractGlobals

Monitor PERFMON metrics for the system.

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.

Method Inventory


method GetSample() as %Status [ Language = objectscript ]
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.
method Initialize() as %Status [ Language = objectscript ]
Initialize system metrics
method Startup() as %Status [ Language = objectscript ]
On Startup enable PERFMON

Inherited Members

Inherited Properties

Inherited Methods