MID Server dashboard

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of MID Server dashboard

    The MID Server dashboard in ServiceNow is a centralized interface for monitoring MID Server operations. It displays reports and gauges using data from theMID Server Statustable, helping users track server health, performance, and job processing status. Access the dashboard viaMID Server > Dashboard, or through the enhanced version in the Discovery Admin Workspace (version 1.3.1 or later) underWorkspaces > Discovery Admin Workspace > Insights.

    Show full answer Show less

    Key Features

    • Overview tab: Shows MID Server status via graphs, including validation issues, pending upgrades, jobs, and capabilities.
    • Performance tab: Displays CPU and memory usage statistics and life-cycle event history for MID Servers.
    • Custom Performance tab: Allows setting custom selection criteria to view specific MID Servers over a chosen time frame.
    • MID Server Status gauge: Provides real-time status information from the eccagentstatus table, including version compatibility and job queue details.

    MID Server Status and Version Indicators

    The dashboard uses color-coded icons to indicate MID Server version compatibility:

    • Red: Incompatible version; the MID Server does not match the instance release and requires an upgrade. Ensure the mid.version.override property is cleared to allow upgrading.
    • Yellow: Compatible family but different version; upgrade recommended.
    • Green: Fully compatible; no upgrade needed.
    • Gray: Version not detected by the instance.

    Note: A MID Server with an incompatible version might incorrectly appear as active; always verify the version icon.

    Important Dashboard Columns and Their Practical Use

    • Name and Host name: Identify each MID Server and its host system.
    • Status and Validated: Show operational status and validation state.
    • Max memory used % and Mean CPU used %: Monitor resource utilization over configurable sampling intervals (default 30 minutes) to detect performance issues.
    • Pending and Processing jobs: Track the number of ECC queue jobs awaiting or being processed by each MID Server.
    • User: Indicates if the MID Server user has appropriate roles (midserver) and matches configured credentials, using color codes (red for incompatible, green for compatible).

    Why This Matters

    This dashboard provides critical insights to ensure MID Servers are functioning correctly, resource usage is within limits, and that versions are compatible with your ServiceNow instance. It helps you proactively manage MID Server health, avoid disruptions in automation and integration tasks, and plan upgrades efficiently.

    Additional Resources

    For further management and troubleshooting, customers can reference related concepts and tasks such as:

    • MID Server upgrades and version management
    • Manually starting, stopping, and restarting MID Servers
    • Setting JVM memory size and pausing MID Servers
    • Resolving MID Server issues, understanding system requirements, and configuring parameters

    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.

    Links to each of the MID Server sectionsEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server securityEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server security

    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.

    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.
    Figure 1. MID Server Dashboard gauge
    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 config.xml configuration file). Reconfigure the MID Server user and verify that it works.
    • Green: Compatible. The user has the mid_server role and matches the user in the configuration file.
    Note:
    The user can also have any of the SOAP roles that the mid_server role inherits.