Ens.MonitorService

class Ens.MonitorService extends Ens.BusinessService

Monitor Service
Checks all hosts for inactivity

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter ADAPTER = Ens.InboundAdapter;
Use an adapter to make sure we get invoked.
parameter SETTINGS = SAMDefinitionClass:Alerting,SAMDefinitionXData:Alerting;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property ActorQueueStatement as %SQL.Statement;
Property methods: ActorQueueStatementGet(), ActorQueueStatementGetSwizzled(), ActorQueueStatementIsValid(), ActorQueueStatementNewObject(), ActorQueueStatementSet()
property Config [ MultiDimensional ];
Property methods: ConfigDisplayToLogical(), ConfigGet(), ConfigIsValid(), ConfigLogicalToDisplay(), ConfigLogicalToOdbc(), ConfigNormalize(), ConfigSet()
property LastUpdate as %String;
Property methods: LastUpdateDisplayToLogical(), LastUpdateGet(), LastUpdateIsValid(), LastUpdateLogicalToDisplay(), LastUpdateLogicalToOdbc(), LastUpdateNormalize(), LastUpdateSet()
property QueueCounts [ MultiDimensional ];
Property methods: QueueCountsDisplayToLogical(), QueueCountsGet(), QueueCountsIsValid(), QueueCountsLogicalToDisplay(), QueueCountsLogicalToOdbc(), QueueCountsNormalize(), QueueCountsSet()
property QueueDelays [ MultiDimensional ];
Property methods: QueueDelaysDisplayToLogical(), QueueDelaysGet(), QueueDelaysIsValid(), QueueDelaysLogicalToDisplay(), QueueDelaysLogicalToOdbc(), QueueDelaysNormalize(), QueueDelaysSet()
property SAMDefinitionClass as %String [ InitialExpression = "Ens.SAM.SensorDefinitions" ];
Class that contains the XData JSON definition
Property methods: SAMDefinitionClassDisplayToLogical(), SAMDefinitionClassGet(), SAMDefinitionClassIsValid(), SAMDefinitionClassLogicalToDisplay(), SAMDefinitionClassLogicalToOdbc(), SAMDefinitionClassNormalize(), SAMDefinitionClassSet()
property SAMDefinitionXData as %String [ InitialExpression = "EnsMonitorService" ];
XData JSON definition name
Property methods: SAMDefinitionXDataDisplayToLogical(), SAMDefinitionXDataGet(), SAMDefinitionXDataIsValid(), SAMDefinitionXDataLogicalToDisplay(), SAMDefinitionXDataLogicalToOdbc(), SAMDefinitionXDataNormalize(), SAMDefinitionXDataSet()
property queueWaitResetPercentage as %Numeric [ InitialExpression = ##class(Ens.MonitorService).getQWTPct() , Transient ];
Property methods: queueWaitResetPercentageDisplayToLogical(), queueWaitResetPercentageGet(), queueWaitResetPercentageIsValid(), queueWaitResetPercentageLogicalToDisplay(), queueWaitResetPercentageNormalize(), queueWaitResetPercentageSet()

Methods

method CheckEnsRuntime() [ Language = objectscript ]
Check local array is in sync with ^Ens.Runtime
private method GetHostActiveTime(pHostName As %String, Output pMsgId As %Integer, Output pPriority As Ens.DataType.MessagePriority, Output pSessionId As %Integer) as %Numeric [ Language = objectscript ]
Retrieve time for active message - does not support those using Ens.Actor
private method GetHostQueueTime(pHostName As %String, Output pMsgId As %Integer, Output pPriority As Ens.DataType.MessagePriority, Output pSessionId As %Integer, Output pFailedDelayCompute As %Boolean) as %Numeric [ Language = objectscript ]
Retrieve time on queue for oldest message
method OnInit() as %Status [ Language = objectscript ]
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnProcessInput(pInput As %Library.RegisteredObject, Output pOutput As %Library.RegisteredObject, ByRef pHint As %Library.String) as %Status [ Language = objectscript ]
Inherited description: Override this method to process incoming data. Do not call SendRequestSync/Async() from outside this method (e.g. in a SOAP Service or a CSP page).
method OnTearDown() as %Status [ Language = objectscript ]
If collecting SAM data then remove last sample by this code. This is only needed if this sampler might not be running but the Production is.
This class is expected to be always running when the Production is running but is included here as an example.
classmethod Purge(Output pDeletedCount As %Integer, pDaysToKeep As %Integer = 7, pDummy As %Boolean) as %Status [ Language = objectscript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback