Skip to main content

%Monitor.System.Routines

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

Monitor system metrics by routine.

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 AbstractMetrics and AbstractGlobals.

Parameters​

APPLICATION​

Parameter APPLICATION [ Internal ] = "CACHE";

INDEX​

Parameter INDEX [ Internal ] = "RoutineName";

Properties​

Data​

Property Data As %String [ Internal, MultiDimensional ];

Count​

Property Count As %Integer [ Internal ];

RoutineName​

Property RoutineName As %Monitor.String;

Name of routine

Directory​

Property Directory As %Monitor.String;

Directory where routine is

Methods​

Startup​

Method Startup() As %Status

On Startup enable PERFMON

Initialize​

Method Initialize() As %Status

Initialize routine metrics.

GetSample​

Method GetSample() As %Status

Get routine 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.