Monitor the System

Home or Project Workspace > Status drop-down > Monitoring ...

Requires System-level Monitoring - View permissions to view the information

Users in a System-level role with the appropriate permissions (by default, System Users in the System Administrator and System Manager roles) can view information about overall system health and quickly pinpoint the source of failures and performance problems.

Overview of the Monitoring Screen

The Monitoring page displays the status of and information about Realm Nodes, AE (Analytic Engine) Components (Collection Manager, Import/Export Manager, and Index Manager), Storage areas ("Storages"), Connectors, and Data Areas, allowing you to keep track of overall system health and locate the source of an operational problem or failure.

When you select Status > Monitoring on the Home page or in a Project Workspace, the Monitoring page opens in a new tab, displaying only the Realm Nodes section. This section lists each Realm Node's name and type, the status of all of its configured AE Components, Storages, and Connectors, and computing resource information. You can filter the list by name.

When you select a Realm Node in the list, additional sections display. AE Components and Storage, below Realm Nodes, show the name of each AE  Component or Storage and its status and resource information. The Connectors section, on the right, displays a list of the Connectors configured for the Organizations on the Node, including name, status, and Organization; you can filter by name and Organization.

Finally, when you select one of the Connectors in the list, the Data Areas section displays below Connectors, listing the Data Areas associated with the Connector, including the name of each and the status of its AE Components: Index Manager, Collection Manager, and Export Manager.

Monitor All Realm Nodes (Summary Information)

Initially, the Realm Nodes summary displays a list of the Nodes in the Realm, including the following information:

  • Node Name — This is the name assigned to the node during the installation process. This could be a Fully Qualified Domain Name (FQDN). If you want to monitor one or more specific Nodes, you can incrementally filter the list by name by entering one or more characters in the text box.
  • Node Type — The node type assigned during installation or configured for a Realm Node.  Possible values for an Analytic Node include the following: 
    • Standard – Runs general jobs for all provisioned Services in the Realm, including Low priority jobs. Standard Nodes are available for all tasks in an enterprise.
    • Express – Runs High or Normal priority jobs for all provisioned Services in the Realm, but not Low priority jobs, which use as many Analytic Nodes as possible and generally run the longest (Importing and Exporting documents, for example). A multinode configuration should typically include an Analytic Express Node.
    • OCR – An Analytic Node designated to run all OCR jobs for all provisioned Services in the Realm. OCR tasks can be long-running and resource intensive; OCR Nodes enable them to continue without delaying other tasks. When there is no OCR Node configured, Digital Reef software uses Standard Nodes to perform OCR tasks.
  • AE Components – Indicates the status of the node's AE Components with an icon (and hover text), as follows:
  • (Available) – The Analytic Engine (which provides the components) is online and available.
  • (Warning) – The Analytic Engine is not operating optimally.
  • ( Not Licensed) – The Analytic Engine is in a Not Licensed state (for example, it does not comply with the terms of the license, such as the core limits of the license for the Node type).
  • (Critical) – The Analytic Engine is in a failure state and unavailable.
  • Storage – Indicates the status of the storage resources provisioned for the Realm with an icon (and hover text), as follows:
  • (Available)– The storage is online and available.
  • (Warning) – The storage is not operating optimally.
  • (Critical) – The storage is in a failure state and unavailable.
  • (Unknown) – If the AE Component status is Critical, the Storage status cannot be determined and will be Unknown.

Note: These storage resources provide temporary and permanent document storage.

  • Connectors – Indicates the status of all Connectors configured for the Organizations on the Node with an icon (and hover text), as follows:
  • (Available) – All Connectors (and their associated Data Areas) are online and available.
  • (Warning) – At least one Connector (or one of its associated Data Areas) is not operating optimally.
  • (Critical) – At least one Connector (or one of its associated Data Areas) is in a failure state and unavailable.
  • (Unknown) – If the AE Component Status is Critical, the Connector Status cannot be determined and will be Unknown. The details for this node will not show any list of Connectors in this situation.
  • Cores – The number of processing cores available on the node.
  • Threads – The number of threads currently executing on the node.

The status of the Realm Nodes can be refreshed at any time using the Update All button in the upper right of the section.

To view the AE Components, Storage, Connectors, and Data Areas sections, select a Node in the Realm Nodes section.

Monitor the AE Components on a Selected Node

The AE Component section, immediately below the Realm Nodes section, displays the following information about the selected Node's AE components:

    Component Name – The name of the AE component. Standard, Express, and OCR Nodes can support all of these AE Components:
    • Collection Manager
    • Import/Export Manager
    • Index Manager
  • Status – The status of the AE component as indicated by an icon (and hover text), as follows:
    • (Available) – The component is online and available.
    • (Warning) – The component is not operating optimally.
    • (Critical) – The component is in a failure state and unavailable.
    • (Deactivated) – The component was deactivated by a change in the Node's type and therefore unavailable. (For example, if an Express Node becomes an OCR Node, the second Index Manager changes to Deactivated.)
  • Memory – The amount of memory available to this component.
  • Executing Threads – The number of threads executing for this component.
  • Last Poll Date/Time – The last time the component's status was updated.

Monitor the Storage for a Selected Node

The Storage section, immediately below AE Components, displays the following information about the selected Node's provisioned Storage:

  • Storage Name – The name assigned to the Storage when it was provisioned.
  • Status – The status of the Storage as indicated by an icon (and hover text), as follows:  
    • (Available) – The storage us online and available.
    • (Warning) – The storage us not operating optimally.
    • (Critical) – The storage us in a failure state and unavailable.
  • Total Capacity (GB) – The total storage capacity (in GB).
  • Used – The percentage of storage used (for example, 50%).

Monitor the Connectors on a Selected Node

The Connectors section, to the right of Realm Nodes, displays the following information about the Connectors associated with the selected Node :

  • Connector Name — The name assigned to the Connector when it was configured. If you want to monitor one or more specific Connectors, you can incrementally filter the list by name by entering one or more characters in the box; this filter can be combined with the filter for the Organization column.

  • Status – The overall status of the Connector, indicated by an icon (and hover text) as described below. Click the combined icons () beneath Status in the header to exclude or include Connectors with Available or Unknown status, isolating those with Warning or Critical status. 

    • (Available) – The connector is online and available.
    • (Warning) – The connector is not operating optimally.
    • (Critical) –The connector is in a Failure state and unavailable.
    • (Unknown) –Configured but not yet activated. .

    Note: A Connector can also be in a Deactivated state, but this state is not shown in this section.

  • Organization – The name of the Organization associated with each Connector. If you want to monitor one or more specific Organizations, you can incrementally filter the list by Organization name by entering one or more characters in the box; this filter can be combined with the filter for the Connector Name column. For example, to display a subset of an Organization's Connectors, you can first filter for the Organization on the right, then filter the list of that Organization's Connectors on the left.

Monitor the Data Areas Defined by a Selected Connector

Each Data Area is defined by a Connector (for example, an NFS Connector handling import or export). When you select a Connector in the Connectors section, all of the Data Areas associated with it are listed in the Data Areas section below, as follows:

  • Data Area Name – The name assigned to each Data Area when configured. You incrementally filter the list by Data Area name by entering one or more characters in the box.
  • AE Component Status – The status of each of AE Index Manager, Collection Manager, and Export Manager components the Data Area interacts with, indicated by an icon (and hover text) as described below.
    • (Available) – The component is online and available.
    • (Failure) – The component is offline and unavailable.