Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %SYS.Monitor.SAM.Abstract
Private  Storage   

%SYS.Monitor.SAM.Abstract


class %SYS.Monitor.SAM.Abstract extends
%SYS.Monitor.AbstractSensor

Abstract class to provide SAM Sensor metrics. All classes which define SAM metrics should inherit from this class. Users may inherit from this class to create application metrics. The application classes may then be registered using SYS.Monitor.SAM.Config.AddApplicationClass(), and they will be added to the system metrics.

Note that this will be called directly by the SAM REST service, and not by the System Monitor. The main SAM polling API will call GetSensors(), which should create the array of:

SAMValues(key)=value or SAMValues(key,item)=value.

Users may call SetSensor(Sensor, Value, Item) or directly set ..SAMValues for each metric. All Values must be numeric values.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1


Summary


Properties
Notifications State

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
ClearNotifications ClearSensors GetSensors LogCon
LogMsg Notify OpenLog SetSensor
Start


Parameters


• parameter PRODUCT = "unknown";
Fill in the Product name here, which will be appended to all metric names. This should be a short, lower-case prefix to indicate the company or application. InterSystems IRIS will use "iris" for system metrics.

Methods


• final method SetSensor(Sensor As %String, Value As %String, Item As %String = "") as %Integer
Override Dashboard sensors which are persistent, and System sensors which get passed to Subscribers. Just store all Sensors in the local SAMValues array.