Agent Health dashboard

  • Release version: Yokohama
  • Updated January 30, 2025
  • 2 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 Agent Health dashboard

    The Agent Health dashboard in ServiceNow provides a comprehensive view of the status and distribution of agents installed in your system. It enables you to quickly assess how many agents are deployed, their operational status, data collection activity, and resource usage. This visibility helps you prioritize maintenance and operational tasks more effectively.

    Show full answer Show less

    Key Features

    • Agent Status Monitoring: Displays which agents are currently active (up) or inactive (down), allowing quick identification of agent availability.
    • Data Collection Status: Shows agents with data collection enabled or disabled, highlighting those that have stopped collecting data due to CPU threshold limits (Silent/Off state).
    • Agent Distribution Breakdowns: Visualizes agents distributed by version number, assigned MID Server, and operating system, facilitating detailed inventory and compatibility tracking.
    • Configurable CPU Threshold: Agents automatically stop data collection when CPU usage exceeds a configurable threshold, set in the acc.yml configuration file, helping manage performance impact.
    • Access Methods: The dashboard is accessible via multiple navigation paths including the AIOps Dashboards menu, Service Operations Workspace, and the Discovery Admin Workspace (version 1.3.1 or later) with enhanced capabilities.
    • Role-based Access: Users require the agentclientcollectoradmin role to view all dashboard widgets.

    Practical Use

    This dashboard is useful for administrators and operational teams who need to monitor agent health and performance. It provides actionable insights into which agents may need attention due to downtime or performance issues, and helps ensure your agent infrastructure is running optimally across different environments and MID Servers.

    Key Outcomes

    • Improved visibility into agent deployment and health status to facilitate proactive maintenance.
    • Efficient troubleshooting by identifying agents that have stopped data collection due to CPU limits.
    • Enhanced operational efficiency by understanding agent distribution across versions, MID Servers, and operating systems.
    • Ability to prioritize work based on agent health insights, reducing downtime and performance bottlenecks.

    The Agent Health dashboard provides visibility into the status and distribution of agents installed in your system. It allows you to quickly assess the number of deployed agents and their distribution, helping you prioritize your work more efficiently.

    The following example shows the agents in your system that are currently up, which agents are configured to collect data, and which agents have stopped data collection due to having reached their CPU threshold (Silent/Off). It also displays the agents according to their version, OS, and connected MID Server.

    Agent Health Dashboard

    Prerequisites

    The Agent Client Collector application must be installed.

    Required ServiceNow AI Platform roles

    A user must have the agent_client_collector_admin role to see all the widgets in the dashboard.

    Access the Events and alerts dashboard

    To open the dashboard, use one of the following methods:
    • Navigate to All > AIOps Dashboards > AIOps Operational > Agent Health.
    • Navigate to Workspaces > Service Operations Workspace and select the AIOps Dashboards icon (AIOps Dashboards icon.) and then select the Agent Health tab.

    • 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.

    Use case

    For examples of how different people in your organization would use this dashboard, see the use case in the following table.
    Table 1. Dashboard use case
    User Dashboard use
    admin Visibility into the status of the agents.

    Breakdowns

    Breakdowns available in the Agent Health are:

    • Agent status: The status of the agents currently deployed in your system.
    • Agent distribution: The distribution of the agents by the agent version number, the MID Server that the agent is assigned to, and the OS that the agent is working on.

    Reports

    Title Type Description
    Agent status breakdown Pie chart Agents deployed in your system that are up and down. Select the relevant color in the widget to display a list of up or down agents.
    Agent by data collection status Pie chart Agents deployed in your system with data collection turned on and off. Select the relevant color in the widget to display a list of agents with data collection on or off.
    Silent/Off (auto) agents Line graph

    Agents that automatically stopped collecting data after crossing the CPU usage threshold. The CPU usage threshold is configurable in the acc.yml configuration file.

    For more information on the acc.yml configuration file, see Configuration file options.
    Agent by version Bar chart Breakdown of your deployed agents by their version numbers.
    Agent by MID Server Bar chart Breakdown of the deployed agents according to the MID Server they're assigned to.
    Agent by OS Bar chart Breakdown of your deployed agents according to the operating systems they are working on.