%Monitor.System.Globals
Class %Monitor.System.Globals Extends (%Monitor.System.Adaptor, %Monitor.System.Abstract, %Monitor.System.AbstractGlobals) [ Inheritance = right, System = 4 ]
Monitor system metrics by globals.
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 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 AbstractGlobals.
Parameters
APPLICATION
Parameter APPLICATION [ Internal ] = "CACHE";
INDEX
Parameter INDEX [ Internal ] = "Name";
Properties
Data
Property Data As %String [ Internal, MultiDimensional ];
GloCount
Property GloCount As %Integer [ Internal ];
Name
Property Name As %Monitor.String;
Full Global name
Directory
Property Directory As %Monitor.String;
Directory where Global is
GlobalName
Property GlobalName As %Monitor.String;
Name of the Global
Methods
Startup
Method Startup() As %Status
On Startup enable PERFMON
Initialize
Method Initialize() As %Status
Initialize global metrics
GetSample
Method GetSample() As %Status
Get global 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.