Skip to main content

%SYS.Monitor.AbstractSensor

Class %SYS.Monitor.AbstractSensor Extends %RegisteredObject [ Abstract, System = 3 ]

Abstract class for a Sensor

User classes inherit from this class to become a Sensor for System Monitor.

Properties​

Logfile​

Property Logfile As %String [ InitialExpression = {$zu(12)_"SystemMonitor.log"}, Internal ];

logfile

SensorReading​

Property SensorReading [ Internal, MultiDimensional ];

Array of sensor name / value pairs

SensorMaxValue​

Property SensorMaxValue [ Internal, MultiDimensional ];

Array of sensor name / high water mark value pairs [deprecated]

State​

Property State As %String [ InitialExpression = " " ];

Runtime state

Notifications​

Property Notifications [ MultiDimensional ];

Methods​

Start​

Method Start() As %Status

USER MAY IMPLEMENT THIS METHOD

The System Monitor Controller calls this method once when it starts. The user may initialize the properties, counters, etc.

A return code of $$$OK indicates there were no errors. A return code of 0 indicates a failure.

GetSensors​

Method GetSensors() As %Status [ Abstract ]

USER MUST IMPLEMENT THIS METHOD

The System Monitor Controller calls this method to get sensor readings. It is called every 10 seconds by default.

Users may return readings for multiple sensors (but only one reading per sensor on each call). User calls SetSensor(sensorname, value[,type]) for every sensor reading. The sensors are kept in the property SensorReading(sensor)=value, and SensorType(sensor)=type. The controller picks up the sensors and their values after the return from GetSensors().

A return code of $$$OK indicates there were no errors. A return code of 0 indicates a failure.

SetSensor​

Method SetSensor(Sensor As %String, Value As %String, Qualifier As %String = "") As %Integer

USER DOES NOT IMPLEMENT THIS METHOD The user must call this method to set a sensor reading. Readings are picked up by the controller after GetSensors() returns.

ClearSensors​

Method ClearSensors() As %Integer [ Final ]

USER DOES NOT IMPLEMENT THIS METHOD The controller calls this to initialize the SensorReadings array.

ClearNotifications​

Method ClearNotifications() As %Integer [ Final ]

USER DOES NOT IMPLEMENT THIS METHOD This method is called to clear notifications for the SYS.Monitor Controller

Notify​

Method Notify(Sensor As %String, Severity As %Integer, Msg As %String) As %Integer [ Final ]

USER DOES NOT IMPLEMENT THIS METHOD This method is called to post a notification

OpenLog​

Method OpenLog() As %Status [ Final ]

USER DOES NOT IMPLEMENT THIS METHOD

LogMsg​

Method LogMsg(msg As %String = "") As %Status [ Final ]

USER DOES NOT IMPLEMENT THIS METHOD

User may call this method to log information to the SystemMonitor.log file in the mgr directory.

LogCon​

Method LogCon(Msg As %String = "", Severity As %Integer = 0) As %Status [ Final ]

USER DOES NOT IMPLEMENT THIS METHOD

User may call this method to post alerts directly to the messages.log file.