Agent Client Collector installation

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 4 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 Client Collector Installation

    The Agent Client Collector connects to a MID Server via HTTP/S, allowing it to manage multiple agents while providing failover protection. Its configuration supports a high number of agents, with a default setup allowing 4,000 agents per MID Server. The installation process varies based on the operating system, requiring specific requirements and validations before setup.

    Show full answer Show less

    Key Features

    • Concurrent Connections: A 1 GiB MID Server can support 700 agents, while an 8 GiB configuration can handle up to 8,000 agents. Scaling out with multiple MID Servers further increases capacity.
    • Automatic Cleanup: Agents with a status of Down or Disconnected are automatically deleted after 30 days unless manually removed.
    • Supported Operating Systems: The Agent Client Collector is compatible with various Linux distributions, Windows Server versions, and macOS (both x8664 and ARM64).
    • Permissions Management: Ensure the default servicenow user has appropriate read access to necessary log paths for effective operation.

    Key Outcomes

    By properly installing the Agent Client Collector, ServiceNow customers can achieve efficient agent management, ensure high availability through failover capabilities, and monitor performance metrics effectively. Customers should also be aware of the need for minimum system requirements and the configuration of MID Servers to support their agent deployment strategy.

    You can install the Agent Client Collector on any supported host machine. The Agent Client Collector connects to a MID Server using the HTTP/S protocol, and the connection remains active after being established. One MID Server may handle several agents simultaneously, while a single agent works with one MID Server at a time and switches to a different MID Server when necessary to provide failover protection.

    When an agent's IP address changes, it selects a MID Server to connect to based on the agent's MID Server list.

    The maximum number of agents that can be connected to a single MID Server is configurable in the sn_agent.mid.max_allowed_agents MID Server property. The default value is 4,000.

    On Windows, run the agent service as gMSA, LocalService, or Local system accounts.

    On Linux and macOS, run the agent as a system account.

    For ACC-V, a default 1 GiB MID Server can support 700 agents concurrently. An 8 GiB configuration for MID Server can support 8,000 agents concurrently. You can also scale out. For example, 5 MID Servers with 8 GiB of heap size can handle up to 40k agents.

    If you completely reinstall the agent on a single host server, a second agent record registers on the instance. Delete the original agent on the Agent Client Collectors page (All > Agent Client Collector > Agents).

    Agents whose Status = Down or Disconnected which haven't been deleted are deleted automatically after 30 days. You can modify this setting on the Autoflush form page (see Autoflush form).

    Before installing the Agent Client Collector, you must do the following:

    • Ensure that one or more MID Servers are properly registered and validated with your instance, to be available for an agent connection request. For details, see Configuring MID Servers. In a staging environment, you need only one MID Server. However, in a production environment, configure at least two MID Servers to support zero-touch configuration and ensure that a MID Server is always available if one fails.
    • Ensure that there's a validated connection from the designated server where you're installing the agent to the MID Server.
    • Ensure that the MID Server port on which the Agent Client Collector listener runs is accessible.
    • Ensure that the following plugins are installed on your instance.

      For ACC-V:

      • Agent Client Collector for Visibility
      • Agent Client Collector Framework
      • Discovery [com.snc.discovery] plugin

      For ACC-M:

      • Agent Client Collector Framework
      • Agent Client Collector Monitoring
      • Event Management and Service Mapping Core
      • Metric Intelligence - WS Scoped App

      For ACC-L:

      • Agent Client Collector Log Analytics
      • Health Log Analytics

      For DEX: ITOM Cloud Services

      You can verify that these plugins are installed on the System Definitions > Plugins page.

    • All plugins that come with the base system are signed with the ServiceNow certificate. Optionally, you can use custom plugins and sign them using your own certificate, as described in Enable OpenSSL secure signing for plugins.

    • Ensure that your system has the minimum requirements for agent installation.
      Table 1. Minimum installation requirements
      Agent Client Collector component Requirements
      Agent Client Collector Framework
      • 1 GB RAM
      • 300 MB free disk space
      • 1 CPU core
      Agent Client Collector Monitoring
      • 1 GB RAM
      • 1 GB free disk space
      • 1 CPU core
      Agent Client Collector for Visibility
      • 1 GB RAM
      • 1 GB free disk space
      • 1 CPU core
    • Ensure that you are installing Agent Client Collector on one of the supported operating system distributions:
      Table 2. Supported Operating System Distributions
      Operating System Distribution
      Linux
      • Red Hat Enterprise Linux - RHEL and Oracle Linux - OL 7, 8, 9
      • CentOS 7, CentOS Stream 8 and 9
      • SLES 12, 15
      • Ubuntu 18.04, 22.04, 24.04 LTS
      • Amazon Linux 2 AMIs
      Windows (ACC-M and ACC-L are supported only on servers, not endpoints)
      • Windows Server 2012, 2012r2, 2016, 2019, 2022
      • Windows 10 Enterprise Edition
      • Windows 11 Professional and Enterprise
      • Windows 11 Surface on ARM64
      macOS (on both x86_64 and arm64 (Apple Silicon) architectures. ACC-M and ACC-L are supported only on servers, not endpoints)
      • Catalina
      • Big Sur
      • Monterey
      • Ventura
    Important:
    All supported operating systems only work with the x86-64 CPU architecture type. ACC-F v3.1.1 also adds native support for ARM64 on Apple Silicon architectures. For the latest information, see the Agent Client Collection on non- x86-64 computers and embedded boards [KB1172387] article in the Now Support Knowledge Base.

    When using ACC-L: The Agent Client Collector comes with the default servicenow user. Ensure that this user has read access to enable Agent Client Collector to view all the configured log paths. For example, the Agent Client Collector servicenow user that comes installed with the base system does not have permissions to view the paths to /var/log/ in Linux and C:\Windows\System32 in Windows. For information about configuring permissions for the servicenow user, see the ACC-L Permission Denied issues [KB1117271] article in the Now Support Knowledge Base.

    When determining the number of machines and servers needed to support your agents (such as the number of machines requiring proxy agents), you must consider the agents' performance KPIs. For details on agent performance KPIs, see Agent Client Collector performance and footprint for URL monitoring.

    For details on using Agent Client Collector in an air-gapped environment, see the Agent Client Collector Framework Air Gapped Configuration Item Management Solution [KB1585753] article in the Now Support Knowledge Base.

    Agent Client Collector supports domain separation. The domain of the agent and the CIs it creates is determined by the domain of the MID Server that the agent is connected to. The user's domain must be the lowest domain level (known as a leaf domain) to enable creating a Websocket endpoint extension for the MID Server.