MID Server dashboard

  • Release version: Xanadu
  • Updated August 1, 2024
  • 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 monitoring MID Server operations within ServiceNow. It consolidates data from the MID Server Status table and presents it through reports and gauges. Users can access the dashboard via theMID Server > Dashboardmodule or, after upgrading to Discovery Admin Workspace version 1.3.1 (August 2024 Store), throughWorkspaces > Discovery Admin Workspace > Insightsfor an enhanced experience.

    Show full answer Show less

    Dashboard Tabs and Their Functions

    • Overview tab: Displays graphs on MID Server statuses, highlighting validation issues, pending upgrades, jobs, and the capabilities of each MID Server.
    • Performance tab: Shows CPU and memory usage statistics for MID Servers, including lifecycle event history.
    • Custom performance tab: Allows users to apply custom MID Server selection criteria to view specific MID Servers’ performance within a chosen timeframe.

    MID Server Status Gauge and Indicators

    The dashboard’s MID Server Status gauge pulls key information from the MID Server Status [eccagentstatus] table, including server name, host, status, validation, resource usage, job counts, and version information.

    Version compatibility is crucial: The dashboard uses color-coded icons to indicate MID Server version status:

    • Red: Incompatible release; requires an upgrade and clearing of the mid.version.override property.
    • Yellow: Compatible family but a newer version is recommended.
    • Green: Fully compatible; no upgrade needed.
    • Gray: Version cannot be detected by the instance.

    Note that an incompatible version might still appear as processing commands on the dashboard, so verifying the version icon is essential for accurate status.

    User Validation

    The dashboard also indicates the validity of the MID Server user based on role and configuration:

    • Red icon: User lacks the midserver role or does not match the configured username; reconfiguration is needed.
    • Green icon: User has the proper role and matches configuration.

    Practical Implications for ServiceNow Customers

    • Use the dashboard to proactively monitor MID Server health, resource usage, and job processing status.
    • Regularly check version compatibility indicators to ensure MID Servers are upgraded appropriately to maintain system integrity.
    • Utilize the custom performance tab to tailor monitoring based on specific MID Server groups or timeframes.
    • Verify user configuration to prevent role or permission issues impacting MID Server operations.

    Additional Resources

    To support effective MID Server management, customers can consult related topics such as MID Server upgrades, JVM memory settings, pausing and restarting MID Servers, as well as troubleshooting guides and system requirements. These resources help maintain optimal MID Server performance and reliability within the ServiceNow environment.

    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.