This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > SYS.Stats.Routine


class SYS.Stats.Routine extends SYS.WSMon.wsResource

This class represents system metrics captured for routines. Each property is a different metric. A class may be instantiated by calling the class method 'Sample', and then the current value of each property can be accessed.

For example:
  s ref=##class(SYS.Stats.Routine).Sample()
  w ref.RtnCommands ; display number of routine commands executed
System stats for Routine activity

Property Inventory

Method Inventory


property RtnCallsLocal as %Integer;
The count of all routine calls where the routine is stored locally.
Property methods: RtnCallsLocalDisplayToLogical(), RtnCallsLocalGet(), RtnCallsLocalIsValid(), RtnCallsLocalLogicalToDisplay(), RtnCallsLocalNormalize(), RtnCallsLocalSet(), RtnCallsLocalXSDToLogical()
property RtnCallsRemote as %Integer;
The count of all routine calls where the routine is stored remotely.
Property methods: RtnCallsRemoteDisplayToLogical(), RtnCallsRemoteGet(), RtnCallsRemoteIsValid(), RtnCallsRemoteLogicalToDisplay(), RtnCallsRemoteNormalize(), RtnCallsRemoteSet(), RtnCallsRemoteXSDToLogical()
property RtnCommands as %Integer;
The count of all routine commands executed on the system.
Property methods: RtnCommandsDisplayToLogical(), RtnCommandsGet(), RtnCommandsIsValid(), RtnCommandsLogicalToDisplay(), RtnCommandsNormalize(), RtnCommandsSet(), RtnCommandsXSDToLogical()
property RtnFetchLocal as %Integer;
The number of times that local routines were fetched from disk into buffers (or saved to disk)
Property methods: RtnFetchLocalDisplayToLogical(), RtnFetchLocalGet(), RtnFetchLocalIsValid(), RtnFetchLocalLogicalToDisplay(), RtnFetchLocalNormalize(), RtnFetchLocalSet(), RtnFetchLocalXSDToLogical()
property RtnFetchRemote as %Integer;
The number of times that remote routines were fetched from disk into buffers (or saved to disk)
Property methods: RtnFetchRemoteDisplayToLogical(), RtnFetchRemoteGet(), RtnFetchRemoteIsValid(), RtnFetchRemoteLogicalToDisplay(), RtnFetchRemoteNormalize(), RtnFetchRemoteSet(), RtnFetchRemoteXSDToLogical()
property RtnLines as %Integer;
The count of all routine lines executed on the system. NOTE: This property is deprecated, line counts are no longer available and this actually returns the RtnCommands. It is left here for backwards compatibility, but should no longer be used.
Property methods: RtnLinesDisplayToLogical(), RtnLinesGet(), RtnLinesIsValid(), RtnLinesLogicalToDisplay(), RtnLinesNormalize(), RtnLinesSet(), RtnLinesXSDToLogical()
property RtnNotCached as %Integer;
The number of times processes were unable to directly access the routine in memory. An indicator of extra work in loading routines.
Property methods: RtnNotCachedDisplayToLogical(), RtnNotCachedGet(), RtnNotCachedIsValid(), RtnNotCachedLogicalToDisplay(), RtnNotCachedNormalize(), RtnNotCachedSet(), RtnNotCachedXSDToLogical()


classmethod Sample() as SYS.Stats.Global
Instantiate the class and fill in current values for all properties.

Inherited Members

Inherited Methods