Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • IT Operations Management
Table of Contents
Choose your release version
    Home Quebec IT Operations Management IT Operations Management ITOM Health Agent Client Collector Agent Client Collector Framework overview Checks and policies Create and edit checks

    Create and edit checks

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Create and edit checks

    You can select a check based on the type of entity (such as a server or an application) you want to monitor. You can view and edit the default checks or create new checks, as needed.

    Before you begin

    Role required: agent_client_collector_admin

    Procedure

    1. Navigate to Agent Client Collector > Check Definitions.
    2. Click New.
      The Check Definition page appears.
      Note: Using Ruby scripts in a Windows environment causes high CPU consumption.
    3. Enter values in the fields on the page, as described in the following table:
      Table 1. Check Definition Form
      Field Description
      Name A descriptive name for the check.
      Check Type Select the type of check. The available monitoring options are:
      • Events
      • Metrics
      Active Select to activate the check.
      Is Proxy Valid Select to indicate that the check's policy is set to work as a proxy.

      When viewing this option in the check instance, it is read-only.

      Command Auto Generation Select to automatically generate the command with the Command Prefix value and the Parameters tab values.
      Command Prefix

      The command that is used for automatic generation when the Command Auto Generation check box is selected. The prefix consists of any portion of the command which is static (does not change), such as the script name.

      Command
      Enter the command that the Agent Client Collector executes.
      Note: When the Command Auto Generation check box is selected, this field is automatically populated with the prefix and flags of the active parameters specified in the Parameters tab.

      The field contains parameters taken from one or more of the following:

      • Simple template: {{.labels.params_field_name}}: Takes values from entries in the Parameters tab. For example, a string of {{.labels.params_warning}} means that the value of the warning parameter is used (provided it has been configured on the Parameters tab).
      • Monitored CI: {{.labels.params_ci_field_name}}: Takes values automatically from the monitored CI, where field_name is replaced with the exact name of the required field in the CI table.
      Description Description of the check.
      Interval The amount of time, in seconds, to wait between check executions.

      For example, a value of 60 means that the check runs every 60 seconds.

      Specified value must be an integer.

      Timeout The amount of time, in seconds, after which the check execution stops when no output is returned.

      For example, a value of 60 means that when the check execution doesn't return a value for 60 seconds, the execution stops.

      Event status change threshold The number of consecutive times that a check's response status must happen before a new event is sent.

      For example, if this value is set to 3, a check whose response status changes from OK to Error generates a new event with an Error status only after the third consecutive occurrence of the status change.

      Event status repair threshold The number of consecutive times that a check's response status must improve to close the previous event.

      For example, if this value is set to 3, a check whose response status changes from Error to OK closes the previous event and generates a new event with an OK status only after the third consecutive occurrence of the status change.

      Credential Failure Regex The string from the check's output indicating that the check failed due to a credentials error. The agent then continues searching credentials that are part of the credential alias until it finds the correct one.

      This field is relevant (and mandatory) when the check's policy uses a credential alias. When creating a new check, enter the string manually.

      Plugins Select the plugins to be associated with the check. Once this is done, the plugins download before the check executes.
    4. On the Parameters tab, enter parameter definitions, as needed.
      Parameters are used for the Command field when the Simple template is used, as described in the previous table.

      The information you can add for parameters is as follows:

      Table 2. Parameters Tab
      Field Description
      Name A descriptive name for the parameter.
      Default value / value Default value / value of the parameter.
      Active Boolean. When set to true, the parameter is taken to the Command field when the Command Auto Generation check box is selected.
      Mandatory Boolean. When set to true, a parameter value must be specified for the command to run.
      Flag String. Prefix that is added before the parameter value in the Command field when the Command Auto Generation check box is selected.
      Value required Boolean. When set to true and when the Command Auto Generation check box is selected, the value of this parameter is added to the Command field after the Flag value.

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Create and edit checks

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Create and edit checks

      You can select a check based on the type of entity (such as a server or an application) you want to monitor. You can view and edit the default checks or create new checks, as needed.

      Before you begin

      Role required: agent_client_collector_admin

      Procedure

      1. Navigate to Agent Client Collector > Check Definitions.
      2. Click New.
        The Check Definition page appears.
        Note: Using Ruby scripts in a Windows environment causes high CPU consumption.
      3. Enter values in the fields on the page, as described in the following table:
        Table 1. Check Definition Form
        Field Description
        Name A descriptive name for the check.
        Check Type Select the type of check. The available monitoring options are:
        • Events
        • Metrics
        Active Select to activate the check.
        Is Proxy Valid Select to indicate that the check's policy is set to work as a proxy.

        When viewing this option in the check instance, it is read-only.

        Command Auto Generation Select to automatically generate the command with the Command Prefix value and the Parameters tab values.
        Command Prefix

        The command that is used for automatic generation when the Command Auto Generation check box is selected. The prefix consists of any portion of the command which is static (does not change), such as the script name.

        Command
        Enter the command that the Agent Client Collector executes.
        Note: When the Command Auto Generation check box is selected, this field is automatically populated with the prefix and flags of the active parameters specified in the Parameters tab.

        The field contains parameters taken from one or more of the following:

        • Simple template: {{.labels.params_field_name}}: Takes values from entries in the Parameters tab. For example, a string of {{.labels.params_warning}} means that the value of the warning parameter is used (provided it has been configured on the Parameters tab).
        • Monitored CI: {{.labels.params_ci_field_name}}: Takes values automatically from the monitored CI, where field_name is replaced with the exact name of the required field in the CI table.
        Description Description of the check.
        Interval The amount of time, in seconds, to wait between check executions.

        For example, a value of 60 means that the check runs every 60 seconds.

        Specified value must be an integer.

        Timeout The amount of time, in seconds, after which the check execution stops when no output is returned.

        For example, a value of 60 means that when the check execution doesn't return a value for 60 seconds, the execution stops.

        Event status change threshold The number of consecutive times that a check's response status must happen before a new event is sent.

        For example, if this value is set to 3, a check whose response status changes from OK to Error generates a new event with an Error status only after the third consecutive occurrence of the status change.

        Event status repair threshold The number of consecutive times that a check's response status must improve to close the previous event.

        For example, if this value is set to 3, a check whose response status changes from Error to OK closes the previous event and generates a new event with an OK status only after the third consecutive occurrence of the status change.

        Credential Failure Regex The string from the check's output indicating that the check failed due to a credentials error. The agent then continues searching credentials that are part of the credential alias until it finds the correct one.

        This field is relevant (and mandatory) when the check's policy uses a credential alias. When creating a new check, enter the string manually.

        Plugins Select the plugins to be associated with the check. Once this is done, the plugins download before the check executes.
      4. On the Parameters tab, enter parameter definitions, as needed.
        Parameters are used for the Command field when the Simple template is used, as described in the previous table.

        The information you can add for parameters is as follows:

        Table 2. Parameters Tab
        Field Description
        Name A descriptive name for the parameter.
        Default value / value Default value / value of the parameter.
        Active Boolean. When set to true, the parameter is taken to the Command field when the Command Auto Generation check box is selected.
        Mandatory Boolean. When set to true, a parameter value must be specified for the command to run.
        Flag String. Prefix that is added before the parameter value in the Command field when the Command Auto Generation check box is selected.
        Value required Boolean. When set to true and when the Command Auto Generation check box is selected, the value of this parameter is added to the Command field after the Flag value.

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login