A facility to allow monitoring of ObjectScript
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.
classmethod AddRoutine(Routine As %List, Clear As %Boolean = 0)
Add a list of routines to be monitored.
classmethod GetMetrics(Select As %Integer(MINVAL=1, MAXVAL=3)=1)
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().
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.
Get a count of the routines being monitored.
classmethod GetRoutineName(Number As %Integer)
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)
Tests whether a routine is currently being monitored and returns
TRUE or FALSE.
Pause the collection. Current results will still be avaiable.
Resume collection. Results continue to accumulate.
classmethod Start(Routine As %List, Metric As %List, Process As %List)
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.
Stop the line-by-line monitor collection
query Result(Routine As %String)
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":
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)