Class %Monitor.Alert

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

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

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		5

Summary

Methods
%%CLASSNAMELogicalToStorage	%%CLASSNAMEStorageToLogical	%AddToSaveSet	%AddToSyncSet
%BMEBuilt	%BuildIndicesAsync	%BuildIndicesAsyncResponse	%CheckConstraints
%CheckConstraintsForExtent	%ClassIsLatestVersion	%ClassName	%ComposeOid
%ConstructClone	%Delete	%DeleteExtent	%DeleteId
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Exists
%ExistsId	%Extends	%GUID	%GUIDSet
%GetLock	%GetParameter	%GetSwizzleObject	%Id
%InsertBatch	%IsA	%IsModified	%IsNull
%KillExtent	%KillExtentData	%LoadFromMemory	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectIsNull
%ObjectModified	%Oid	%OnBeforeAddToSync	%OnDeleteFinally
%OnDetermineClass	%OnOpenFinally	%OnSaveFinally	%Open
%OpenId	%OriginalNamespace	%PackageName	%PhysicalAddress
%PurgeIndices	%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict
%RollBack	%Save	%SaveDirect	%SaveIndices
%SerializeObject	%SetModified	%SortBegin	%SortEnd
%SyncObjectIn	%SyncTransport	%UnlockExtent	%UnlockId
%ValidateIndices	%ValidateObject	%ValidateTable	ConvertParameter
Decrypt	Encrypt	EscapeHTML	EscapeURL
External	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	Link
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RewriteURL	ShowError	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL

Methods

• classmethod External(type As %String = "SNMP", appname As %String = "", severity As %Integer = 0, msg As %String = "") as %Status

This class method allows a application to send an alert using an external monitoring or management interface, currently just SNMP. This call may be used within the Alert Evaluation Method to forward alerts generated by the Monitor, or from anywhere within the application itself to simply create an SNMP Trap.

The parameters used are:

type = use 'SNMP' 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).


[USER] > [%Monitor] > [Alert]		Private Storage