Caché Monitoring Guide - InterSystems Documentation

9
Monitoring Performance Using ^mgstat
This chapter describes the ^mgstat utility, a tool for collecting basic performance data. The utility works with all versions
of Caché since release 5.0.
Note:
This utility may be updated between releases. Contact the InterSystems Worldwide Response Center (WRC) for
information about downloading newmgstat.xml from ftp://ftp.intersys.com/pub/performance/.
The calling sequence uses the following arguments:
Argument
sample time
Description
Required. This argument specifies the frequency (in seconds) for sampling
counters; defaults to 2 seconds if sample time is not specified.
Note:
If you specify a sample time greater than 10 seconds, ^mgstat reduces
it to 10 seconds. See the number of samples argument in this table.
number of samples
Required. This argument specifies the maximum number of samples to be
obtained; defaults to 10 iterations if number of samples is not specified.
Note:
If ^mgstat reduces the sample time, it increases the specified number
of samples to ensure that the duration (sample time * number of
samples) of the run is effectively the same as it would have been if
none of the arguments were modified.
filename
page length
Optional. This argument is used only by other WRC performance tools.
Optional. If you run ^mgstat interactively, this argument specifies the number
of lines to display before the header rows are repeated.
Note:
This argument is ignored when you run ^mgstat as a background job.
If you specify a page length less than 5 lines, ^mgstat increases it to
5 lines; if you omit this argument or specify a page length of 0, ^mgstat
displays the header once, at the beginning of the page.
For example, running ^mgstat as a background job to specify that file samples be obtained every 5 seconds until 17280
samplings are obtained (in the Caché Terminal, from the %SYS namespace), enter the following:
%SYS> JOB ^mgstat(5,17280)
Caché Monitoring Guide 87