Skip to main content

SYS.Monitor.Health.Test

Sensor for system metrics

Property Inventory

Method Inventory

Properties

property Cur as %Integer;
Property methods: CurDisplayToLogical(), CurGet(), CurIsValid(), CurLogicalToDisplay(), CurNormalize(), CurSet()
property GoodNum as %Integer;
Property methods: GoodNumDisplayToLogical(), GoodNumGet(), GoodNumIsValid(), GoodNumLogicalToDisplay(), GoodNumNormalize(), GoodNumSet()
property Num as %Integer;
Property methods: NumDisplayToLogical(), NumGet(), NumIsValid(), NumLogicalToDisplay(), NumNormalize(), NumSet()
property Sample as %String;
Property methods: SampleDisplayToLogical(), SampleGet(), SampleIsValid(), SampleLogicalToDisplay(), SampleLogicalToOdbc(), SampleNormalize(), SampleSet()
property Test as %Integer;
Property methods: TestDisplayToLogical(), TestGet(), TestIsValid(), TestLogicalToDisplay(), TestNormalize(), TestSet()

Methods

method GetSensors() as %Status
Inherited description: 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.

method Start() as %Status
Inherited description: 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.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab