abstract class %Monitor.Process
The methods here control the Process Monitor which allow a programmer to capture
metrics for the current process. The metrics are the same counters as
captured by the PERFMON utility, but they are only captured for the current
process and stored in the process local memory. This ensures that it has
minimal effect on the rest of the system.
Application programmers can embed the methods in their code, so that the
Process Monitor can be enabled and metrics reported by user processes,
allowing them to analyze trouble spots on live systems.
|
Parameters
|
Properties
|
Methods
|
Queries
|
Indices
|
ForeignKeys
|
Triggers
|
|
|
|
6
|
|
|
|
|
• classmethod Clear()
as %Status
Set all Process Monitor counters for the current process to zero.
• classmethod Disable()
as %Status
Stop the Process Monitor for the current process. The current values for all
metrics remain in memory until they are zeroed using the Clear() method (or
the Process Monitor is enabled again).
• classmethod Enable()
as %Status
Start the Process Monitor for the current process. The counters from
any previous collections are cleared when the Process Monitor is enabled.
• classmethod Metrics()
as %String
Returns a comma-delimited list of all the Process Monitor metrics, These are in
the same order as the metric counters returned by the Report() method. Although the list
of metrics and the order of these metrics should be fairly static, it is possible
that new metrics might be added or the order changed for some reason in future
versions. Use this method to "name" the metrics when reporting them.
The metrics are the same as those reported by ^PERFMON, and the documentation for
PERFMON gives a brief description of each metric.
• classmethod Report()
as %String
Returns a comma-delimited list of all Process Monitor counters for the current
process. The Metrics() method provides a list of the names for the metrics.
Note that only the current process can report it's counters. To be viewed
by other processes they must be written to a global or file.
• classmethod Status()
as %Integer
Shows the current status of the Process Monitor for this process.
Returns a '1' for enabled and a '0' for disabled.
