Amazon CloudWatch data input configuration fields

  • Release version: Yokohama
  • Updated January 30, 2025
  • 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 Amazon CloudWatch data input configuration fields

    This guide details the configuration fields for setting up Amazon CloudWatch data inputs in ServiceNow, specifically for the Yokohama release. It enables customers to ingest and stream log data from Amazon CloudWatch into their ServiceNow instances via MID Servers or MID Server clusters, supporting effective log analytics and monitoring.

    Show full answer Show less

    Basic configuration

    • Name: Required field to name the data input.
    • Description: Optional description of the data input.
    • Execute on: Choose to run on a specific MID Server or a MID Server cluster.
    • MID Server: When using a specific MID Server, select one supporting basic authentication (mTLS not supported). By default, a MID Server can stream up to 10 data inputs, configurable via MID Server properties. Log ingestion is auto-enabled if not already active.
    • MID Server Cluster: Supports failover clusters with basic authentication only. Data inputs run on one MID Server until failover occurs. Clusters must have at least one MID Server with capacity under 10 data inputs. Log ingestion is auto-enabled for active MID Servers.
    • Service instance: Required field to bind log data to a ServiceNow service instance, which must be set to Operational.

    Read-only status fields

    • Status of the data input
    • Transport protocol used to stream logs (Amazon CloudWatch)
    • Count of log sources created
    • Timestamp for when data input last stopped or failed
    • Timestamp of last streamed log
    • Error message shown if streaming errors occur

    Query settings

    • From: Required start date/time for reading logs; older data is ignored. Setting a date far in the past may cause congestion.
    • Group Name(s): Required comma-separated list of Amazon CloudWatch log groups to search; wildcard () supported for all groups.
    • Prefix: Filter to read only log streams whose names begin with the specified prefix. Only one prefix per data input; create multiple inputs for multiple prefixes.
    • Filter pattern: Case-sensitive filter expressions to include or exclude log events based on terms. Supports single or multiple terms and exclusion syntax.

    Transport settings

    • AWS credentials: Select AWS credentials containing access and secret keys.
    • AWS region: Required field indicating the AWS region where the CloudWatch cluster resides (e.g., us-west-1).

    Advanced configuration

    These optional fields fine-tune connectivity and data ingestion:

    • Connection timeout: Time in milliseconds to wait for AWS connection (default 1000 ms).
    • Batch size: Maximum log entries retrieved per query (default 2500).
    • Socket timeout: Time in milliseconds to wait for data transfer (default 10000 ms).
    • Default timezone: Timezone used if logs lack timezone info (default GMT).
    • Sub sample drop and receive ratios: Controls log sampling to reduce volume (defaults set to -1 disables sampling).
    • Max length in bytes: Maximum size of log messages (default 32766 bytes).
    • Sleep interval: Seconds to wait before retrying after receiving no logs (default 60 seconds).
    • Polling interval: Seconds to wait before polling for new logs (default 0).
    • Drop if queue is full: Option to discard logs if the MID Server is overloaded (default false).

    These configuration options empower ServiceNow customers to efficiently integrate Amazon CloudWatch logs, manage failover with MID Server clusters, control log ingestion volume, and handle connection reliability to optimize log analytics workflows.

    Description of the fields on the Amazon CloudWatch data input configuration form.

    Basic configuration

    Field Description
    Name Name of the new data input. This field is required.
    Description Description of the data input.
    Execute on Option to select whether to use a specific MID Server or a MID Server cluster. This field is required.
    MID

    (Only when the Execute on field is set to Specific MID Server)

    MID Server to which log data from Amazon CloudWatch is pulled.
    Note:
    • You can select only MID Servers that support basic authentication. MID Servers that support mTLS are not listed.
    • The default maximum number of data inputs streaming logs to a single MID Server is 10. You can modify this number in the MID Server properties.
    • If log ingestion is not enabled for the selected MID Server, Health Log Analytics enables it automatically.
    This field is required.
    MID Server Cluster

    (Only when Execute on is set to Specific MID Server cluster.)

    The MID Server cluster to which the log data is pulled. This field is required.

    The data input runs on a single MID Server in the cluster until that MID Server fails. The system then moves all the data input tasks to the next available MID Server in the cluster according to the configured order.

    Note:
    • Health Log Analytics supports only failover MID Server clusters. In these clusters, multiple MID Servers are grouped together for failover protection. When selecting a cluster from the data input or integration form, the MID Server clusters list displays only failover clusters.
    • The MID Server cluster must include only MID Servers that support basic authentication. mTLS is not supported for log ingestion.
    • Log ingestion must be enabled for each MID Server in the cluster. If log ingestion is not enabled for the active MID Server, Health Log Analytics enables it automatically.
    • The default maximum number of data inputs or integrations streaming logs to a single MID Server is 10. A cluster passes capacity validation if it contains at least one MID Server with fewer than 10 data inputs or integrations running on it, even when that MID Server is down.
    For more information about MID Server clusters, see Configure a MID Server cluster.
    Service instance The service instance to which to bind the log data.
    Note:
    If no relevant service instance exists, Create an service instance and add CIs to it. Set the status of the new service instance to Operational.
    This field is required.
    The following fields show read-only information:
    Field Description
    Status Status of the data input.
    Transport Protocol used to stream the log data.

    This data input uses Amazon CloudWatch to stream log data to your instance.
    Sources count The number of log sources this data input has created.
    Disabled since The time when the data input stopped or failed.
    Last log time The time when the last log streamed in the data input.
    Error message The streaming error.

    This field is populated automatically. It displays only when a streaming error has occurred.
    Table 1. Query settings tab
    Field Description Example
    From The date and time to start reading the data. Data older than this date and time is not read.
    Note:
    Setting this value to a past date might require the system to read large amounts of data, causing congestion.

    This field is required.

    		 Now -1 week
    Group Name(s) The log groups to search. If multiple log groups must be searched, specify the groups in a comma-separated list. To fetch log data from all groups, use an asterisk (*) as a wildcard character.

    This field is required.

    		 hla-cw-loggroup1,hla-cw-loggroup2
    Prefix Name prefix for the Amazon CloudWatch log streams to read from. The data input reads only from log streams with this name prefix.
    Note:
    Only a single log stream prefix per data item is supported. For multiple prefixes, create multiple data inputs.
    		 hla-cw
    Filter pattern Pattern by which to filter incoming events.
    Various types of filter patterns are supported. For example:
    • A pattern for fetching log events that contain a single term.
    • A pattern for fetching log events that contain multiple terms.
    • A pattern for fetching log events that include a term and exclude another.
    Note:
    Filter patterns are case sensitive.
    For more information, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html
    • Pattern for fetching log events that contain a single term, "STATUS_CODE":

      "STATUS_CODE"

    • Pattern for fetching log events that contain multiple terms, “STATUS_CODE” and “200”:

      “STATUS_CODE 200”

    • Pattern for fetching log events that include a term, “STATUS_CODE,” and exclude another term, “200”:

      “STATUS_CODE” – “200”
    Table 2. Transport tab
    Field Description
    AWS credentials Field that refers to the AWS Credentials list (aws_credentials.list). The list contains the AWS access and secret access keys.
    AWS region The AWS region where the Amazon CloudWatch cluster runs, for example, us-west-1.

    For a list of AWS regions, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions

    This field is required.

    Advanced configuration

    Table 3. Advanced configuration form
    Field Description Default value
    Connection timeout The number of milliseconds to wait before timing out the AWS connection attempt. 1000
    Batch size The maximum number of logs retrieved per query. 2500
    Socket timeout The number of milliseconds to wait before timing out a data transfer over an established connection. 10000
    Default timezone The default timezone if the log date and time doesn't include timezone information. GMT
    Sub sample drop ratio The number of logs to batch together, out of which one will be discarded. This setting is used to reduce the number of fetched logs. -1
    Sub sample receive ratio The number of logs to batch together, out of which all but one will be discarded. This setting is used to decrease the number of received logs. -1
    Max length in bytes The maximum length of log messages, in bytes. 32766
    Sleep interval The interval, in seconds, to wait before querying again after a query has returned no logs. 60
    Polling interval The interval, in seconds, to wait before polling for new logs. 0
    Drop if queue is full Option for selecting to discard logs if there is a load on the MID Server. False