MID Server dashboard
The MID Server dashboard is a central place for MID Server users to monitor ongoing operations. The dashboard consists of reports and gauges that display information from the MID Server Status table.
|  |
The MID Server Dashboard is available from the MID Server > Dashboard module.
After upgrading to Discovery Admin Workspace version 1.3.1 (August 2024 Store), you can navigate to Workspaces > Discovery Admin Workspace > Insights and use the enhanced dashboard.
Note: To access the MID Server Dashboard, the user must have the mid_server or admin role. The Discovery Admin Workspace requires the discovery_admin role. Group-based access follows standard ServiceNow role inheritance; ensure users in the group have the appropriate role assigned. For role setup, see Create the MID Server user and grant the role
MID Server Overview tab
The Overview tab provides graphs showing the status of MID Servers, including any validation issues or pending upgrades and jobs. The tab also displays which MID Servers by capability.
MID Server overview tab.
MID Server Performance tab
The Performance tab displays information relating to the MID Server CPU and memory usage, including the life-cycle event history.
Performance tab layout.
MID Server Custom performance tab
The Custom performance tab enables users to set custom MID Server selection criteria to show particular MID Servers in a select time frame.
Custom performance tab.
MID Server status gauge
The MID Server Status gauge on the dashboard displays basic information about each MID Server. This information comes from the MID Server Status [ecc_agent_status] table.
The MID Server Dashboard gauge
If the version is not compatible, the MID Server status is not changed to Down in the MID Server dashboard. So it might still appear to be processing commands when it actually is not doing so. You must check the MID Server Version on the dashboard.
See KB0535181 for additional MID Server troubleshooting information.
The icons in the Version column indicates the following:
- Red: Incompatible. The MID Server and instance do not belong to the same release. You must upgrade the MID Server and verify that it is not pinned to an older version with the mid.version.override property. The MID Server will not be upgraded until the parameter is cleared.
- Yellow: Compatible, but an upgrade is recommended. This indicates that the MID Server version belongs to the same family as the instance, but not the same version.
- Green: Compatible. No upgrade necessary.
- Gray: Incompatible. The instance cannot detect the version.
| Column | Description |
|---|---|
| Name | The name of the MID Server. |
| Host name | The name of the system that hosts the MID Server. |
| Status | The status of the MID Server. |
| Validated | Whether or not the MID Server was validated. |
| Max memory used % | The highest percent usage of memory on the system that hosts the MID Server, in the configured sampling interval. The default interval is 30 minutes, but this value is user configurable. See MID Server resource threshold alerts for details. |
| Mean CPU used % | The average percent usage of CPU on the system that hosts the MID Server, in the configured sampling interval. The default interval is 30 minutes, but this value is user configurable. See MID Server resource threshold alerts for details. |
| Pending jobs | Number of pending ECC queue jobs for that MID Server. |
| Processing jobs | Number of processing ECC queue jobs for that MID Server. |
| Version | The version of the MID Server. An icon indicates the validity of the MID Server:- Red: Incompatible. The MID Server and instance do not belong to the same release. You must upgrade the MID Server and verify that it is not pinned to an older version with the mid.version.override property. The MID Server will not be upgraded until the parameter is cleared. - Yellow: Compatible, but an upgrade is recommended. This indicates that the MID Server version belongs to the same family as the instance, but not the same version. - Green: Compatible. No upgrade necessary. - Gray: Incompatible. The instance cannot detect the version. |
| User | The login name of the user. An icon indicates the validity of the user:- Red: Incompatible. The user does not have themid_server role or the user does not match the value in the mid.instance.username parameter (in the Note: The user can also have any of the SOAP roles that the mid_server role inherits. |
Parent Topic:MID Server reference
Related topics
MID Server system requirements
MID Server Configuration Parameter settings and priority
MID Server protected records and reserved characters
MID Server privileged commands
Manually start, stop, and restart a MID Server