This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > Config.Monitor

Config.Monitor

persistent class Config.Monitor extends %Library.Persistent, Config.CommonSingleMethods, Config.CommonProperties, %SYSTEM.Help

SQL Table Name: Config.Monitor

This class allows you to modify and view the [Monitor] section of the CPF file through programatic APIs. While properties are usually modified through the System Management portal, there may be some occasion where modifying them through the API's is best for your system. In all the Config methods, if you do not specify the CPFFile parameter, the currently active CPF file is used. If you wish to modify a CPF file which is not the currently active one, then specify the CPFFile you wish to modify in the method call.
The Flags parameter does not normally need to be specified; the defaults are usually sufficient for most cases.
You can use either the provided API's (Get/Modify) to modify the properties by passing in the correct parameters, or use Object sytax to open and directly manipulate the config objects.

EXAMPLE:

; Use class methods to modify properties
%SYS>s Status=##Class(Config.Monitor).Get(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties
Properties("PatrolCollectionInterval")=30
Properties("PatrolDisplayMode")=0
Properties("PatrolEnabled")=0
Properties("PatrolTopProcesses")=20
Properties("SNMPEnabled")=0
Properties("WMIEnabled")=0
%SYS>s Properties("PatrolCollectionInterval")=40
%SYS>s Status=##Class(Config.Monitor).Modify(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
%SYS>s Obj=##Class(Config.Monitor).Open()
%SYS>w Obj.PatrolCollectionInterval
40
%SYS>s Obj.PatrolCollectionInterval=60
%SYS>s Status=Obj.%Save()
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property PatrolCollectionInterval as %Integer (MAXVAL = 900, MINVAL = 1) [ InitialExpression = 30 , Required ];
Enter the number of seconds between each time the system collects data and sends it to Patrol.


Modifying this property will require a restart of the system to make it active.
Property methods: PatrolCollectionIntervalDisplayToLogical(), PatrolCollectionIntervalGet(), PatrolCollectionIntervalGetStored(), PatrolCollectionIntervalIsValid(), PatrolCollectionIntervalLogicalToDisplay(), PatrolCollectionIntervalNormalize(), PatrolCollectionIntervalSet(), PatrolCollectionIntervalXSDToLogical()
property PatrolDisplayMode as %Integer (MAXVAL = 2, MINVAL = 0) [ InitialExpression = 0 , Required ];
Control how the metric data is displayed in the Patrol console.
0 - 'Total' displays the total counts since the collection was started.
1 - 'Delta' displays the count for the last collection period.
2 - 'Rate' displays a calculated count per second.


Modifying this property will require a restart of the system to make it active.
Property methods: PatrolDisplayModeDisplayToLogical(), PatrolDisplayModeGet(), PatrolDisplayModeGetStored(), PatrolDisplayModeIsValid(), PatrolDisplayModeLogicalToDisplay(), PatrolDisplayModeNormalize(), PatrolDisplayModeSet(), PatrolDisplayModeXSDToLogical()
property PatrolEnabled as %Boolean [ InitialExpression = 0 , Required ];
Aautomatically starts the connection to Patrol when the system is started.


Modifying this property will require a restart of the system to make it active.
Property methods: PatrolEnabledDisplayToLogical(), PatrolEnabledGet(), PatrolEnabledGetStored(), PatrolEnabledIsValid(), PatrolEnabledLogicalToDisplay(), PatrolEnabledLogicalToXSD(), PatrolEnabledNormalize(), PatrolEnabledSet(), PatrolEnabledXSDToLogical()
property PatrolTopProcesses as %Integer (MAXVAL = 10000, MINVAL = 0) [ InitialExpression = 20 , Required ];
Number of processes to be displayed in the Process Status window on the Patrol console.
This will show the top processes as sorted by global or routine.
A value of 0 tells the PATROL utility to stop calculating the top processes.


Modifying this property will require a restart of the system to make it active.
Property methods: PatrolTopProcessesDisplayToLogical(), PatrolTopProcessesGet(), PatrolTopProcessesGetStored(), PatrolTopProcessesIsValid(), PatrolTopProcessesLogicalToDisplay(), PatrolTopProcessesNormalize(), PatrolTopProcessesSet(), PatrolTopProcessesXSDToLogical()
property SNMPEnabled as %Boolean [ InitialExpression = 0 , Required ];
Automatically starts the SNMP agent when the system is started.


Modifying this property will require a restart of the system to make it active.
Property methods: SNMPEnabledDisplayToLogical(), SNMPEnabledGet(), SNMPEnabledGetStored(), SNMPEnabledIsValid(), SNMPEnabledLogicalToDisplay(), SNMPEnabledLogicalToXSD(), SNMPEnabledNormalize(), SNMPEnabledSet(), SNMPEnabledXSDToLogical()
property WMIEnabled as %Boolean [ InitialExpression = 0 , Required ];
Identifies this configuration as one that should be monitored by the WMI DLL.


Modifying this property will require a restart of the system to make it active.
Property methods: WMIEnabledDisplayToLogical(), WMIEnabledGet(), WMIEnabledGetStored(), WMIEnabledIsValid(), WMIEnabledLogicalToDisplay(), WMIEnabledLogicalToXSD(), WMIEnabledNormalize(), WMIEnabledSet(), WMIEnabledXSDToLogical()

Methods (Including Private)

classmethod Load(Obj As %ObjectHandle = "", Flags As %Integer = 1) as %Status
Load the parameters into memory and activate.
Parameters:
Obj = Handle to the object which caused the load. If "", then load everything, only called from STU.
Flags = Type of modification.
0 - Modify
1 - Create/Insert

Indexes

index (CPFNameSectionHeaderName on CPFName,SectionHeader,Name) [IdKey, Type = key, Unique];
Index methods: CPFNameSectionHeaderNameCheck(), CPFNameSectionHeaderNameDelete(), CPFNameSectionHeaderNameExists(), CPFNameSectionHeaderNameOpen(), CPFNameSectionHeaderNameSQLCheckUnique(), CPFNameSectionHeaderNameSQLExists(), CPFNameSectionHeaderNameSQLFindPKeyByConstraint(), CPFNameSectionHeaderNameSQLFindRowIDByConstraint()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (Config.Monitor)

^|"^^"_$ZU(12)|SYS("CONFIG")(ID)
=
%%CLASSNAME
Comments
PatrolDisplayMode
PatrolEnabled
PatrolTopProcesses
SNMPEnabled
WMIEnabled
PatrolCollectionInterval