Agent Client Collector framework configuration properties

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

    The Agent Client Collector (ACC) framework configuration properties are crucial for determining how agents interact with the ServiceNow instance. These properties impact agent behavior, logging, and data processing, enabling better management and monitoring of agent operations.

    Show full answer Show less

    Key Features

    • Character Read Limit: Defines the maximum character limit for a payload item, defaulting to 1,000,000.
    • Agent Upgrade Wait Time: Sets the maximum time (30 minutes) for an agent to upgrade before showing a Warning status.
    • Application Classification Behavior: Controls how applications are classified during discovery, with a default setting to create a shell CI.
    • ECC Queue Payload Size: Specifies the maximum payload size (5,000,000) for ECC queue records processed by the agent.
    • Auto MID Selection: When enabled, agents receive a list of MID Servers to choose from automatically, with the default set to false.
    • Keep Alive Durations: Defines time limits (120 seconds for alive status, 600 seconds for disconnected status) for agent heartbeat signals.
    • Logging Verbosity: Sets the minimum logging level (default info) for ACC operations, determining the severity of logged messages.
    • Maximum MID Servers: Limits the number of MID Servers that can be selected during agent setup, defaulting to 20.
    • Upgrade History: Specifies the minimum number of upgrade records retained per agent, with a default of 2.
    • Sync Filters Interval: Establishes a 10-minute interval for detecting and syncing CMDB changes to the MID Server.
    • ECC Queue Query Time: Limits queries to ECC queues created within the last 12 hours (43,200 seconds).

    Key Outcomes

    By configuring these properties, ServiceNow customers can optimize agent performance, enhance monitoring capabilities, and ensure efficient data processing. Proper configuration contributes to improved operational stability and effective resource management within the ServiceNow ecosystem.

    Description of the properties that determine the behavior of Agent Client Collector framework configuration.

    Table 1. Framework configuration properties
    Property Description
    sn_agent.agent_static_import_char_read_limit The character read limit for a given payload item. Relates only to the configuration item being processed and not the total attachment size.

    Default: 1000000
    sn_agent.agent_upgrade_wait_time Maximum number of minutes for an agent to successfully upgrade before entering Warning status.

    Default: 30
    sn_agent.agent_version The current ACC-F release version installed on the instance.
    sn_agent.appl_classification_behavior The characteristics and behaviors for applications during Agent Discovery. When set to simple, creates a shell CI.

    Default: simple
    sn_agent.ecc_queue.max_payload_size The maximum allowable payload size for an ECC queue record to be processed by the agent.

    Default: 5000000
    sn_agent.enable_auto_mid_selection When set to true, the instance sends a list of MID Servers to the agents. To enable automatic selection of a MID Server from the list, set the auto-mid-selection property to true in the agents’ acc.yml file. Automatic selection of MID Servers ensures that each agent uses the most efficient available MID Server.

    Default: false

    Note:
    This property determines only whether a list of MID Servers is sent to the agent.
    • If this property was previously set to true and is then set to false, automatic MID selection is performed on the previously sent MID Server list if the auto-mid-selection property is set to true in the acc.yml file.
    • If this property is set to true and the auto-mid-selection property in the acc.yml file is set to false, no automatic MID Server selection is performed.
    sn_agent.installer_max_endpoints Maximum number of MID Web Server endpoint URLs to be selected during agent single line installation.

    Default: 3
    sn_agent.keep_alive.alive_duration The amount of time, in seconds, within which the agent's last_refreshed timestamp must be updated. After this time period, the agent status moves from Up to Warning. If the indicated time period passes again, the status moves from Warning to Down.

    Default: 120
    sn_agent.keep_alive.disconnected_duration The amount of time, in seconds, within which the last_keepalive timestamp must be updated. After this time period, the agent status changes from Up to Disconnected.

    Default: 600
    sn_agent.logging.verbosity The minimum level of messages that are logged for Agent Client Collector Framework. Messages with the indicated status and anything more severe are logged
    Options:
    • error
    • warn
    • info
    • debug

    Default: info
    sn_agent.maximum_mids_to_select The maximum number of MID Servers that can be selected for agent setup.

    Default: 20
    sn_agent.min_upgrade_history_per_agent The minimum number of upgrades saved per agent.

    Default: 2
    sn_agent.sync_filters_interval_min The number of minutes after which CMDB changes are detected and then synched to the MID Server.

    Default: 10
    sn_agent.time_ago_in_seconds_to_query_ecc_queue When processing ecc_queues, only query those created within the indicated time (in seconds).

    Default: 43200 (12 hours)