MID Server dashboard

  • Release version: Zurich
  • Updated July 31, 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 is a centralized interface for ServiceNow customers to monitor MID Server operations. It provides real-time insights using reports and gauges based on data from the MID Server Status table. Customers can access the dashboard viaMID Server > Dashboardor, after upgrading to Discovery Admin Workspace version 1.3.1, through the enhanced dashboard inWorkspaces > Discovery Admin Workspace > Insights.

    Show full answer Show less

    Key Features

    • Overview Tab: Displays graphs detailing MID Server status, including validation issues, pending upgrades, and job activity, categorized by server capability.
    • Performance Tab: Shows critical performance metrics such as CPU and memory usage along with lifecycle event history, helping customers track resource consumption.
    • Custom Performance Tab: Allows users to define custom selection criteria to view specific MID Servers over chosen time frames, enhancing targeted monitoring.
    • MID Server Status Gauge: Presents essential information from the eccagentstatus table, including server name, host, status, validation, memory and CPU usage percentages, job queues, version, and user details.

    Version Compatibility Indicators

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

    • Red: Incompatible; the MID Server must be upgraded, and any version override cleared.
    • Yellow: Compatible but an upgrade is recommended to match the instance version.
    • Green: Fully compatible; no upgrade needed.
    • Gray: Version could not be detected by the instance.

    Note that an incompatible version may still appear active on the dashboard but not process commands. Customers must verify the MID Server version to ensure accurate status.

    User Validation

    The dashboard also verifies the MID Server user account with icons indicating compatibility:

    • Red: User lacks the midserver role or does not match the configured username, requiring reconfiguration.
    • Green: User is properly configured with the necessary roles.

    Practical Use and Maintenance

    This dashboard empowers customers to proactively monitor MID Server health, resource usage, and job processing status, which aids in maintaining optimal performance and troubleshooting. It also supports key administrative tasks such as manually starting, stopping, or restarting MID Servers and adjusting JVM memory settings.

    For detailed troubleshooting and configuration, customers should refer to related concepts like MID Server upgrades, file cleaning, privileged commands, system requirements, and property settings.

    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.