Skip to main content

SYS.Stats.Dashboard

Class SYS.Stats.Dashboard Extends SYS.WSMon.wsResource [ System = 4 ]

This class provides an overview of the system "health", with all of the critical metrics and statuses gathered as properties in one class. It essentially contains all of the data that's available on the Dashboard in the System Management Portal. Each property is a different metric or status.

Most of the data is collected by an instance of the Application Monitor running in the %SYS namespace. You must have the %Monitor.System.Dashboard classes "active" to collect the data (see ^%MONAPPMGR for details).

A class may be instantiated by calling the class method 'Sample', and then the current value of each property can be accessed.

For example: s ref=##class(SYS.Stats.Dashboard).Sample() w ref.GloRefsPerSec ; display number of global references per second

Properties​

GloRefsPerSec​

Property GloRefsPerSec As %Numeric;

Most recently measured number of Global references per second.

GloRefs​

Property GloRefs As %Integer;

Number of Global references since system startup.

GloSets​

Property GloSets As %Integer;

Number of Global Sets and Kills since system startup.

RouRefs​

Property RouRefs As %Integer;

Number of routine loads and saves since system startup.

LogicalReads​

Property LogicalReads As %Integer;

Number of logical block requests since system startup.

DiskReads​

Property DiskReads As %Integer;

Number of physical block read operations since system startup.

DiskWrites​

Property DiskWrites As %Integer;

Number of physical block write operations since system startup

CacheEfficiency​

Property CacheEfficiency As %Numeric;

Most recently measured cache efficiency (Global references / (physical reads + writes))

ECPAppServer​

Property ECPAppServer As %String;

Summary status of ECP application servers connected to this system.

ECPAppSrvRate​

Property ECPAppSrvRate As %Numeric;

Most recently measured ECP application server traffic in bytes/second.

ECPDataServer​

Property ECPDataServer As %String;

Summary status of ECP data servers this system is connected to.

ECPDataSrvRate​

Property ECPDataSrvRate As %Numeric;

Most recently measured ECP data server traffic in bytes/second.

ShadowSource​

Property ShadowSource As %String;

Summary status of shadow connections on this data source. Values from SYS.Shadowing class queries.

ShadowServer​

Property ShadowServer As %String;

Summary status of shadows configured on this shadow server. Values from SYS.Shadowing class queries.

SystemUpTime​

Property SystemUpTime As %String;

Elapsed time since this system was started.

LastBackup​

Property LastBackup As %String;

Date and time of last system backup.

DatabaseSpace​

Property DatabaseSpace As %String;

Indicates whether there is a reasonable amount of diskspace available for database files. Possible values are "Normal", "Warning" (<5MB) or "Troubled" (<2MB)

JournalStatus​

Property JournalStatus As %String;

Indicates the current status of the database journaling. Possible values are "Normal", "Disabled", "Suspended", "Frozen", "Paused", "Unknown".

JournalSpace​

Property JournalSpace As %String;

Indicates whether there is a reasonable amount of diskspace available for journal files. Possible values are "Normal", "Warning" (<250MB) or "Troubled" (<50MB)

JournalEntries​

Property JournalEntries As %Integer;

Number of entries written to the system journal since system startup.

LockTable​

Property LockTable As %String;

Indicates the current status of the system Lock Table based on percentage used. Possible values are "Normal", "Warning" (>85%) or "Troubled" (>95%)

WriteDaemon​

Property WriteDaemon As %String;

Indicates the current status of the system Write Daemon. Possible values are "Normal" or "Troubled" (based on lack of movement in queue)

Processes​

Property Processes As %Integer;

Most recent number of running processes.

CSPSessions​

Property CSPSessions As %Integer;

Most recent number of CSP sessions.

SeriousAlerts​

Property SeriousAlerts As %Integer;

Number of serious alerts that have been raised.

ApplicationErrors​

Property ApplicationErrors As %Integer;

Number of application errors that have been logged.

LicenseLimit​

Property LicenseLimit As %Integer;

Maximum allowed license units for this system.

LicenseType​

Property LicenseType As %String(MAXLEN = 1024);

Text description of license type for this system.

LicenseCurrent​

Property LicenseCurrent As %Numeric;

Current count of license units being used.

LicenseHigh​

Property LicenseHigh As %Numeric;

Highest count of license units used.

LicenseCurrentPct​

Property LicenseCurrentPct As %Numeric;

License usage as a percentage of available license units.

LicenseHighPct​

Property LicenseHighPct As %Numeric;

Highest license usage as a percentage of available license units.

Methods​

Sample​

ClassMethod Sample() As SYS.Stats.Dashboard

Instantiate the class and fill in current values for all properties.