Agent Client Collector plugins

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 1 minute to read

    • An Agent Client Collector plugin is a script or group of scripts, which provides additional agent capabilities. For example, collecting more metrics, performing more checks, or generating events when an application queue size is 60% or 80% full.

    You associate a check with a plugin by creating a dependency between the check and the plugin. By default, during check execution, the check downloads and caches the plugins, for future check executions.

    To ensure that a check with plugin dependency executes properly:
    1. Verify that the disable-assets parameter in the acc.yml file is set to false (the default setting).
    2. Ensure that the agent service has proper file permissions to populate the cache folder. The default cache folder locations are:
      • Windows: C:\ProgramData\ServiceNow\agent-client-collector\cache
      • Linux: /var/cache/servicenow/agent-client-collector/
      • macOS: /Library/Caches/servicenow/agent-client-collector/

    Optionally, you can set the disable-assets parameter in the acc.yml file to true to secure your agent so that no additional plugins are downloaded during check execution.

    For details on acc.yml parameters, see Configuration file options.

    You can create Agent Client Collector plugins, as needed. Plugins are formatted as tar.gz files and run together with their associated check.