Skip to main content

%Monitor.System.Servers

Class %Monitor.System.Servers Extends (%Monitor.System.Adaptor, %Monitor.System.Abstract) [ Inheritance = right, System = 4 ]

Monitor system metrics by ECP server.

This class, and others that inherit from %Monitor.System.Abstract, provides an object API to the same system metrics as the ^PERFMON utility. Instantiating this class also starts the collection of ^PERFMON system metrics, which can have a significant impact on a busy system. Note that stopping ^PERFMON will also disable the sampling here.

Parameters

APPLICATION

Parameter APPLICATION [ Internal ] = "CACHE";

INDEX

Parameter INDEX [ Internal ] = "ServerName";

Properties

Data

Property Data As %String [ Internal, MultiDimensional ];

Count

Property Count As %Integer [ Internal ];

ServerName

Property ServerName As %Monitor.String;

Server name

Buffers

Property Buffers As %Monitor.Integer;

Buffers

GloKills

Property GloKills As %Monitor.Integer;

Global kills received

GloRefs

Property GloRefs As %Monitor.Integer;

Global references received

GloSets

Property GloSets As %Monitor.Integer;

Global sets received

IJCw0

Property IJCw0 As %Monitor.Integer(CAPTION = "IJC messages received/written");

Incoming net IJC messages received and written to the IJC device

IJCw1

Property IJCw1 As %Monitor.Integer(CAPTION = "IJC messages received/not written");

Incoming net IJC messages received and NOT written to the IJC device

Locks

Property Locks As %Monitor.Integer;

Lock commands received

Requests

Property Requests As %Monitor.Integer;

Requests received

Methods

Startup

Method Startup() As %Status

On Startup enable PERFMON

Initialize

Method Initialize() As %Status

Initialize server metrics

GetSample

Method GetSample() As %Status

Get server metric sample A return code of $$$OK indicates there is a new sample instance. A return code of 0 indicates there is no sample instance.