Skip to main content


persistent class SYS.Monitor.SAM.Config extends %Library.Persistent

SQL Table Name: SYS_Monitor_SAM.Config

Configuration parameters for SAM (System Alerting and Monitoring).

This controls behavior of the SYS.Monitor.SAM.Sensors collector class.

Property Inventory

Method Inventory


parameter METRICGROUPS = Performance,Mirrors,Database,CPU,CSPGateway,Journal,License,Memory,Process,Shadows,Transactions,SharedMemory,WriteDemon,Diagnostic;


property ExcludeMetrics as %List;
A list of Sensor Groups to omit from each collection.

Valid values are Performance, Mirrors, Database, CPU, CSPGateway, Journal, License, Memory, Process, Shadows, Transactions, SharedMemory, WriteDemon and Diagnostic

To update: set sam=##class(SYS.Monitor.SAM.Config).Open(),sam.ExcludeMetrics=$lb("Shadows","Transactions") do sam.%Save()
Property methods: ExcludeMetricsGet(), ExcludeMetricsGetStored(), ExcludeMetricsIsValid(), ExcludeMetricsLogicalToOdbc(), ExcludeMetricsOdbcToLogical(), ExcludeMetricsSet()
property Key as %String [ InitialExpression = "SAM" , Required ];
Property methods: KeyDisplayToLogical(), KeyGet(), KeyGetStored(), KeyIsValid(), KeyLogicalToDisplay(), KeyLogicalToOdbc(), KeyNormalize(), KeySet()


method %OnValidateObject() as %Status
Inherited description: This callback method is invoked by the %ValidateObject() method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject() will fail.

classmethod AddApplicationClass(ClassName As %String, Namespace As %String) as %Status
Add an Application class name to be called during each SAM collection. The class must inherit from %SYS.Monitor.SAM.Abstract and implement the GetSensors() method.

Note that the 'Namespace' argument is typically a single Namespace, but may be a comma-delimited list. Calling this method for an existing ApplicationClass will replace the Namespace(s) for this Class. For multiple Namespaces, the ApplicationClass must differentiate Sensor names for each Namespace.
classmethod DeleteApplicationClass(ClassName As %String) as %Status
Remove an Application class name from the list to be called during each SAM collection.


index (Single on Key) [IdKey, Type = key, Unique];
Index methods: SingleCheck(), SingleDelete(), SingleExists(), SingleOpen(), SingleSQLCheckUnique(), SingleSQLExists(), SingleSQLFindPKeyByConstraint(), SingleSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (SYS.Monitor.SAM.Config)

FeedbackOpens in a new tab