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 > SYS.Stats.Dashboard

SYS.Stats.Dashboard

class SYS.Stats.Dashboard extends SYS.WSMon.wsResource

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 Cache 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
  

Property Inventory

Method Inventory

Properties

property ApplicationErrors as %Integer;
Number of application errors that have been logged.
Property methods: ApplicationErrorsDisplayToLogical(), ApplicationErrorsGet(), ApplicationErrorsIsValid(), ApplicationErrorsLogicalToDisplay(), ApplicationErrorsNormalize(), ApplicationErrorsSet(), ApplicationErrorsXSDToLogical()
property CSPSessions as %Integer;
Most recent number of CSP sessions.
Property methods: CSPSessionsDisplayToLogical(), CSPSessionsGet(), CSPSessionsIsValid(), CSPSessionsLogicalToDisplay(), CSPSessionsNormalize(), CSPSessionsSet(), CSPSessionsXSDToLogical()
property CacheEfficiency as %Numeric;
Most recently measured cache efficiency (Global references / (physical reads + writes))
Property methods: CacheEfficiencyDisplayToLogical(), CacheEfficiencyGet(), CacheEfficiencyIsValid(), CacheEfficiencyLogicalToDisplay(), CacheEfficiencyNormalize(), CacheEfficiencySet(), CacheEfficiencyXSDToLogical()
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)
Property methods: DatabaseSpaceDisplayToLogical(), DatabaseSpaceGet(), DatabaseSpaceIsValid(), DatabaseSpaceLogicalToDisplay(), DatabaseSpaceLogicalToOdbc(), DatabaseSpaceNormalize(), DatabaseSpaceSet()
property DiskReads as %Integer;
Number of physical block read operations since system startup.
Property methods: DiskReadsDisplayToLogical(), DiskReadsGet(), DiskReadsIsValid(), DiskReadsLogicalToDisplay(), DiskReadsNormalize(), DiskReadsSet(), DiskReadsXSDToLogical()
property DiskWrites as %Integer;
Number of physical block write operations since system startup
Property methods: DiskWritesDisplayToLogical(), DiskWritesGet(), DiskWritesIsValid(), DiskWritesLogicalToDisplay(), DiskWritesNormalize(), DiskWritesSet(), DiskWritesXSDToLogical()
property ECPAppServer as %String;
Summary status of ECP application servers connected to this system.
Property methods: ECPAppServerDisplayToLogical(), ECPAppServerGet(), ECPAppServerIsValid(), ECPAppServerLogicalToDisplay(), ECPAppServerLogicalToOdbc(), ECPAppServerNormalize(), ECPAppServerSet()
property ECPAppSrvRate as %Numeric;
Most recently measured ECP application server traffic in bytes/second.
Property methods: ECPAppSrvRateDisplayToLogical(), ECPAppSrvRateGet(), ECPAppSrvRateIsValid(), ECPAppSrvRateLogicalToDisplay(), ECPAppSrvRateNormalize(), ECPAppSrvRateSet(), ECPAppSrvRateXSDToLogical()
property ECPDataServer as %String;
Summary status of ECP data servers this system is connected to.
Property methods: ECPDataServerDisplayToLogical(), ECPDataServerGet(), ECPDataServerIsValid(), ECPDataServerLogicalToDisplay(), ECPDataServerLogicalToOdbc(), ECPDataServerNormalize(), ECPDataServerSet()
property ECPDataSrvRate as %Numeric;
Most recently measured ECP data server traffic in bytes/second.
Property methods: ECPDataSrvRateDisplayToLogical(), ECPDataSrvRateGet(), ECPDataSrvRateIsValid(), ECPDataSrvRateLogicalToDisplay(), ECPDataSrvRateNormalize(), ECPDataSrvRateSet(), ECPDataSrvRateXSDToLogical()
property GloRefs as %Integer;
Number of Global references since system startup.
Property methods: GloRefsDisplayToLogical(), GloRefsGet(), GloRefsIsValid(), GloRefsLogicalToDisplay(), GloRefsNormalize(), GloRefsPerSecDisplayToLogical(), GloRefsPerSecGet(), GloRefsPerSecIsValid(), GloRefsPerSecLogicalToDisplay(), GloRefsPerSecNormalize(), GloRefsPerSecSet(), GloRefsPerSecXSDToLogical(), GloRefsSet(), GloRefsXSDToLogical()
property GloRefsPerSec as %Numeric;
Most recently measured number of Global references per second.
Property methods: GloRefsPerSecDisplayToLogical(), GloRefsPerSecGet(), GloRefsPerSecIsValid(), GloRefsPerSecLogicalToDisplay(), GloRefsPerSecNormalize(), GloRefsPerSecSet(), GloRefsPerSecXSDToLogical()
property GloSets as %Integer;
Number of Global Sets and Kills since system startup.
Property methods: GloSetsDisplayToLogical(), GloSetsGet(), GloSetsIsValid(), GloSetsLogicalToDisplay(), GloSetsNormalize(), GloSetsSet(), GloSetsXSDToLogical()
property JournalEntries as %Integer;
Number of entries written to the system journal since system startup.
Property methods: JournalEntriesDisplayToLogical(), JournalEntriesGet(), JournalEntriesIsValid(), JournalEntriesLogicalToDisplay(), JournalEntriesNormalize(), JournalEntriesSet(), JournalEntriesXSDToLogical()
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)
Property methods: JournalSpaceDisplayToLogical(), JournalSpaceGet(), JournalSpaceIsValid(), JournalSpaceLogicalToDisplay(), JournalSpaceLogicalToOdbc(), JournalSpaceNormalize(), JournalSpaceSet()
property JournalStatus as %String;
Indicates the current status of the database journaling. Possible values are "Normal", "Disabled", "Suspended", "Frozen", "Paused", "Unknown".
Property methods: JournalStatusDisplayToLogical(), JournalStatusGet(), JournalStatusIsValid(), JournalStatusLogicalToDisplay(), JournalStatusLogicalToOdbc(), JournalStatusNormalize(), JournalStatusSet()
property LastBackup as %String;
Date and time of last system backup.
Property methods: LastBackupDisplayToLogical(), LastBackupGet(), LastBackupIsValid(), LastBackupLogicalToDisplay(), LastBackupLogicalToOdbc(), LastBackupNormalize(), LastBackupSet()
property LicenseCurrent as %Numeric;
Current count of license units being used.
Property methods: LicenseCurrentDisplayToLogical(), LicenseCurrentGet(), LicenseCurrentIsValid(), LicenseCurrentLogicalToDisplay(), LicenseCurrentNormalize(), LicenseCurrentPctDisplayToLogical(), LicenseCurrentPctGet(), LicenseCurrentPctIsValid(), LicenseCurrentPctLogicalToDisplay(), LicenseCurrentPctNormalize(), LicenseCurrentPctSet(), LicenseCurrentPctXSDToLogical(), LicenseCurrentSet(), LicenseCurrentXSDToLogical()
property LicenseCurrentPct as %Numeric;
License usage as a percentage of available license units.
Property methods: LicenseCurrentPctDisplayToLogical(), LicenseCurrentPctGet(), LicenseCurrentPctIsValid(), LicenseCurrentPctLogicalToDisplay(), LicenseCurrentPctNormalize(), LicenseCurrentPctSet(), LicenseCurrentPctXSDToLogical()
property LicenseHigh as %Numeric;
Highest count of license units used.
Property methods: LicenseHighDisplayToLogical(), LicenseHighGet(), LicenseHighIsValid(), LicenseHighLogicalToDisplay(), LicenseHighNormalize(), LicenseHighPctDisplayToLogical(), LicenseHighPctGet(), LicenseHighPctIsValid(), LicenseHighPctLogicalToDisplay(), LicenseHighPctNormalize(), LicenseHighPctSet(), LicenseHighPctXSDToLogical(), LicenseHighSet(), LicenseHighXSDToLogical()
property LicenseHighPct as %Numeric;
Highest license usage as a percentage of available license units.
Property methods: LicenseHighPctDisplayToLogical(), LicenseHighPctGet(), LicenseHighPctIsValid(), LicenseHighPctLogicalToDisplay(), LicenseHighPctNormalize(), LicenseHighPctSet(), LicenseHighPctXSDToLogical()
property LicenseLimit as %Integer;
Maximum allowed license units for this system.
Property methods: LicenseLimitDisplayToLogical(), LicenseLimitGet(), LicenseLimitIsValid(), LicenseLimitLogicalToDisplay(), LicenseLimitNormalize(), LicenseLimitSet(), LicenseLimitXSDToLogical()
property LicenseType as %String (MAXLEN = 1024);
Text description of license type for this system.
Property methods: LicenseTypeDisplayToLogical(), LicenseTypeGet(), LicenseTypeIsValid(), LicenseTypeLogicalToDisplay(), LicenseTypeLogicalToOdbc(), LicenseTypeNormalize(), LicenseTypeSet()
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%)
Property methods: LockTableDisplayToLogical(), LockTableGet(), LockTableIsValid(), LockTableLogicalToDisplay(), LockTableLogicalToOdbc(), LockTableNormalize(), LockTableSet()
property LogicalReads as %Integer;
Number of logical block requests since system startup.
Property methods: LogicalReadsDisplayToLogical(), LogicalReadsGet(), LogicalReadsIsValid(), LogicalReadsLogicalToDisplay(), LogicalReadsNormalize(), LogicalReadsSet(), LogicalReadsXSDToLogical()
property Processes as %Integer;
Most recent number of running processes.
Property methods: ProcessesDisplayToLogical(), ProcessesGet(), ProcessesIsValid(), ProcessesLogicalToDisplay(), ProcessesNormalize(), ProcessesSet(), ProcessesXSDToLogical()
property RouRefs as %Integer;
Number of routine loads and saves since system startup.
Property methods: RouRefsDisplayToLogical(), RouRefsGet(), RouRefsIsValid(), RouRefsLogicalToDisplay(), RouRefsNormalize(), RouRefsSet(), RouRefsXSDToLogical()
property SeriousAlerts as %Integer;
Number of serious alerts that have been raised.
Property methods: SeriousAlertsDisplayToLogical(), SeriousAlertsGet(), SeriousAlertsIsValid(), SeriousAlertsLogicalToDisplay(), SeriousAlertsNormalize(), SeriousAlertsSet(), SeriousAlertsXSDToLogical()
property ShadowServer as %String;
Summary status of shadows configured on this shadow server. Values from SYS.Shadowing class queries.
Property methods: ShadowServerDisplayToLogical(), ShadowServerGet(), ShadowServerIsValid(), ShadowServerLogicalToDisplay(), ShadowServerLogicalToOdbc(), ShadowServerNormalize(), ShadowServerSet()
property ShadowSource as %String;
Summary status of shadow connections on this data source. Values from SYS.Shadowing class queries.
Property methods: ShadowSourceDisplayToLogical(), ShadowSourceGet(), ShadowSourceIsValid(), ShadowSourceLogicalToDisplay(), ShadowSourceLogicalToOdbc(), ShadowSourceNormalize(), ShadowSourceSet()
property SystemUpTime as %String;
Elapsed time since this system was started.
Property methods: SystemUpTimeDisplayToLogical(), SystemUpTimeGet(), SystemUpTimeIsValid(), SystemUpTimeLogicalToDisplay(), SystemUpTimeLogicalToOdbc(), SystemUpTimeNormalize(), SystemUpTimeSet()
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)
Property methods: WriteDaemonDisplayToLogical(), WriteDaemonGet(), WriteDaemonIsValid(), WriteDaemonLogicalToDisplay(), WriteDaemonLogicalToOdbc(), WriteDaemonNormalize(), WriteDaemonSet()

Methods

classmethod Sample() as SYS.Stats.Dashboard
Instantiate the class and fill in current values for all properties.

Inherited Members

Inherited Methods