Caché Monitoring Guide - InterSystems Documentation

Monitoring Caché Using SNMP
• Finally, the individual data objects contained in that table, including any that are designated as indices.
• The notifications (traps) are defined as individual entries at the same hierarchical level as the “table”. For more
information, see Caché SNMP Traps in this appendix.
• Caché-specific auxiliary objects sent via notifications (traps) are defined as individual entries at the same hierarchical
level as the “table”. For more information, see Caché SNMP Traps in this appendix.
For example, encode the size of a database as:
1.3.6.1.4.1.16563.1.1.3.1.6.4.84.69.83.84.1
This translates to:
iso.org.dod.internet.private.enterprises.intersystems.iscCache.cacheObjects
.cacheDBTab.cacheDBRow.cacheDBSize.TEST(instname).1(DBindex)
B.4.1 Ensemble MIB Structure
In addition to the Caché managed object data defined in ISC-CACHE.mib, Ensemble also has the information defined in
ISC-ENSEMBLE.mib available. Ensemble uses the same IANA private enterprise number as Caché, 16563 which represents
intersystems.
Below this, Ensemble implements its enterprise private subtree as follows:
• The level below intersystems is the “product” or application ID level. For Ensemble this is .2 (iscEnsemble). This
serves as the MIB module identity.
• The next level is the “object” level, which separates data objects from notifications. For Ensemble, these are: .1
(ensObjects) and .2 (ensTraps). By convention, the intersystems tree uses a brief lowercase prefix added to all
data objects and notification names. For Ensemble this is ens.
• Subsequent levels follow the same implementation as Caché described in the Caché MIB Structure section.
B.4.2 Extending the Caché MIB
Application programmers can add managed object definitions and extend the MIB for which the Caché subagent provides
data. This is not intended to be a complete MIB editor or SNMP toolkit; rather, it is a way to add simple application metrics
that you can browse or query through SNMP.
Note:
The objects must follow the basic Caché SNMP structure, there is limited support for SNMP table structures (only
integer-valued indexes are supported), and SNMP traps are not created (see the %Monitor.Alert class). A basic
understanding of SNMP structure of management information is helpful.
To create these objects do the following:
1. Create Caché object definitions in classes that inherit from the %Monitor.Adaptor class. See the Caché Class Reference
for details about adding managed objects to the %Monitor package.
2. Execute an SNMP class method to enable these managed objects in SNMP and create a MIB definition file for management
applications to use. The method to accomplish this is MonitorTools.SNMP.CreateMIB().
See the MonitorTools.SNMP class documentation in the Caché Class Reference for details of the CreateMIB() method
parameters.
The method creates a branch of the private enterprise MIB tree for a specific application defined in the %Monitor database.
In addition to creating the actual MIB file for the application, the method also creates an internal outline of the MIB tree.
112 Caché Monitoring Guide