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 > %Monitor.System.LineByLine


class %Monitor.System.LineByLine extends %Library.RegisteredObject

Line-by-line Monitor.

A facility to allow monitoring of Cache Object Script routines on a line-by-line basis. The user may select which routines to monitor and any of the standard performance metrics supported by the PERFMON utility, as well as "Time" (clock time spent in line) and "TotalTime" (total clock time including in-line calls to other subroutines). See the GetMetrics() method for a list of metric names.

WARNING ! Starting the line-by-line monitor will enable the collection of statistics for *every* line of code executed by the selected routines and processes. This can have a major impact on the performance of a system, and it is recommended that you do this only on a 'test' system.

Method Inventory


classmethod AddRoutine(Routine As %List, Clear As %Boolean = 0) as %Status
Add a list of routines to be monitored.

Normally, a list of routines can be specified simply as a parameter of the Start() method. But if the user requires a list of routines which exceeds the maximum string length, then this method may be called repeatedly with routine lists, prior to calling Start().

The first time it is called, the user should make sure they specify the "Clear" parameter to initialize the list and ensure that any previous entries are cleared. Then when Start() is invoked, the "Routine" parameter should be null (Routine = ""). Routines may use the asterisk wildcard as in Start().
classmethod GetMetrics(Select As %Integer(MINVAL=1, MAXVAL=3)=1) as %String
Returns a list of metric names (delimited by ",").

The "Select" parameter is used to select either a list of metrics which are currently being monitored (default of Select=1) or a list of all available metric names (Select=2).

If Select=3, this method will print a list of all available metrics and a short description to the current device.
classmethod GetRoutineCount() as %Integer
Get a count of the routines being monitored.
classmethod GetRoutineName(Number As %Integer) as %String
Used to fetch the names of routines being monitored. The internal list of routines is numbered from 1 to 'n', with 'n' being the count returned by the GetRoutineCount() method.
classmethod IsActive(Routine As %String) as %Boolean
Tests whether a routine is currently being monitored and returns TRUE or FALSE.
classmethod Pause() as %Status
Pause the collection. Current results will still be avaiable.
classmethod Resume() as %Status
Resume collection. Results continue to accumulate.
classmethod Start(Routine As %List, Metric As %List, Process As %List) as %Status
Start a line-by-line monitor collection. Parameters are lists of Routines, Metric names, and Process IDs to be monitored.

Routines may be "wildcarded" by using an asterisk as the final character of any routine name.

A null list of Metrics will use the default of "RtnLine, Time, TotalTime".

A null list of Process IDs will enable all processes.
classmethod Stop() as %Status
Stop the line-by-line monitor collection


query Result(Routine As %String)
Selects Counters As %List
Results of line-by-line monitoring for each routine. Each row of the ResultSet contains a list of metric counts for a line of the routine. Use the GetMetrics() method to retrieve a list of currently monitored metric names.

The following example shows how to retrieve the current results for a routine named "Test":
   s metrics=##class(%Monitor.System.LineByLine).GetMetrics(),cnt=$l(metrics,",")
   s rset=##class(%ResultSet).%New("%Monitor.System.LineByLine:Result")
   d rset.Execute("Test")
   w "LineByLine" f i=1:1:cnt w ?(12*i),$p(metrics,",",i)
   f l=1:1 s more=rset.Next() q:'more  d
   . s x=rset.GetData(1)
   . w !,l,"." f i=1:1:cnt w ?(12*i),$li(x,i)
   k rset

Inherited Members

Inherited Methods