Caché Monitoring Guide - InterSystems Documentation

Sample User-defined SNMP Monitor Class
Parameter GROUPNAME = "MyTable";
/// An integer metric counter
Property Counter1 As %Monitor.Integer;
/// Another integer metric counter
Property Counter2 As %Monitor.Integer;
/// A status indicator as a string data type
Property Status As %Monitor.String;
/// The method is REQUIRED. It is where the Application Monitor
/// calls to collect data samples, which then get picked up by the
/// ^SNMP server process when requested.
Method GetSample() As %Status
{
set ..Counter1=$r(200)
set ..Counter2=200+$r(100)
set n=$r(4)
set ..Status=$s(n=1:"Crashed",n=2:"Warning",n=3:"Error",1:"Normal")
Quit $$$OK
}
}
Before compiling this class in a user namespace, Caché must load supporting classes into the user namespace; these classes
are required to store the data samples for SNMP.
To load the classes, run ^%MONAPPMGR and do the following:
• Select option 2, Manage Monitor Classes
• Select option 3, Register Monitor System Classes.
When you compile the sample class, it creates the SNMP.Sample.Example class to store the sample data.
Important:
Do not delete generated sample classes explicitly; if you select both the monitor and generated sample
classes for deletion, the sample class routines remain although the monitor class routines are deleted, which
causes an error. To ensure that all sample class routines are properly removed, delete only the application
monitor class that generated it; when you delete the monitor class both the monitor class and generated
sample class, as well as related routines for both classes, are deleted. For example, to deleted a sample
class (for example, SNMP.Sample.Example), use the Management Portal or Studio to delete the monitor
class from which it is generated (that is, SNMP.Example).
Run ^%MONAPPMGR to activate the sample class and start the Application Monitor to collect samples:
1. Select option 2, Manage Monitor Classes.
2. Select option 1, Activate/Deactivate a Monitor Class.
3. To see an numbered list of registered Monitor Classes, enter .
4. Enter the number of Monitor Class you want to activate; for example, to activate a user-defined class named
SNMP.Example, enter the number next to the class name.
5. Select option 6, Exit (to return to the Application Monitor main menu).
6. Select option 1, Manage Application Monitor.
7. Select option 1, Start Application Monitor.
8. Select option 5, Exit (to return to the Application Monitor main menu).
9. Select option 6, Exit (to exit from Application Monitor main menu).
Note:
For information about configuring and using the Application Monitor, see Caché Application Monitor in the
“Using the Caché Monitor” chapter.
Caché Monitoring Guide 115