This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %Monitor.Alert

%Monitor.Alert

persistent class %Monitor.Alert extends %Library.Persistent, %CSP.Page

SQL Table Name: %Monitor.Alert

This class allows user applications to generate an alert using one of the supported external monitoring protocols. See the External() class method for details.

Method Inventory

Methods

classmethod External(type As %String = "", appname As %String = "", severity As %Integer = 0, msg As %String = "") as %Status
This class method allows a Cache application to send an alert using an external monitoring or management interface, currently either SNMP or WMI. This call may be used within the Alert Evaluation Method to forward alerts generated by the Cache Monitor, or from anywhere within the application itself to simply create an SNMP Trap or WMI Event.

The parameters used are:

type = either 'SNMP' or 'WMI' to indicate how to send the alert

appname = a brief string (MAXLEN=20) to identify the source or application creating the alert

severity = a severity code where 0=info, 1=warning, 2=severe, 3=fatal

msg = a text message (MAXLEN=1024) which describes the problem or event

For SNMP, the alert is sent using the cacheAppAlert trap, with each of the parameters attached as auxiliary objects (see the ISC-CACHE.MIB). For WMI, a Cache_Event is constructed in the same way as other Cache SNMP system traps. The severity code is included as the Severity property, and the 'appname' and 'msg' parameters are appended with a dash separator in the AdditionalInfo property.

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (%Monitor.Alert)

^Monitor.AlertD(ID)
=
%%CLASSNAME
AlertAction
ApplicationName
EvalMethod
GroupName
MetricClass
NotifyMethod
PropertyList
MetricApp
MetricGroup
EvalClass
NotifyClass
Expression
Reset
AlertOnce
Disabled
Enabled
NotifyOnce
Activated