Edge Delta TCP integration configuration fields

  • Release version: Zurich
  • Updated July 31, 2025
  • 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 Edge Delta TCP Integration Configuration Fields

    This document outlines the configuration fields required for setting up the Edge Delta TCP integration for Health Log Analytics in ServiceNow. Understanding these fields is essential for a successful integration, enabling you to effectively stream logs for health monitoring and analytics.

    Show full answer Show less

    Key Features

    • Integration Name: A unique identifier for your integration (e.g., My Edge Delta TCP integration), which is required to adjust the generic name displayed on the form.
    • MID Server Name: Select a compatible MID Server for streaming Edge Delta logs. Only servers supporting basic authentication will be listed.
    • Port: Specify a listening port on the MID Server within the suggested range, ensuring it is not occupied and is opened by your security team.
    • Service Instance: Required field for binding the log data to a specific service instance.
    • Transport: The protocol used for streaming logs, which defaults to TCP and is read-only.
    • Description: Optional field for adding a brief description of the integration.

    Advanced Settings

    • Lookup Hostnames: Option to enable DNS lookup for resolving IPs; defaults to false.
    • Sub Sample Drop Ratio: Control the ratio of logs to drop; defaults to -1 (no logs dropped).
    • Sub Sample Receive Ratio: Control the ratio of logs to receive; also defaults to -1.
    • Max Length in Bytes: Sets maximum log message length, defaulting to 32766 bytes.
    • Character Encoding: Specifies character encoding, defaulting to UTF-8.
    • Line Breaker Delimiters: Defines characters to separate raw log lines, formatted with ", ".
    • Boss Thread Count: Number of threads managing connections.
    • Worker Thread Count: Number of threads handling incoming data.
    • Read Timeout Seconds: Timeout duration before closing the channel after inactivity.
    • Default Timezone: Sets the timezone for events without specified time zones, defaulting to GMT.
    • Drop if Queue is Full: Option to discard logs during high load on the MID Server.

    Key Outcomes

    By accurately configuring these fields, ServiceNow customers can ensure effective log streaming and management, facilitating improved health monitoring and analytics through the Edge Delta integration. Proper setup also minimizes potential disruptions and optimizes performance for log ingestion processes.

    Description of the fields on the Edge Delta TCP integration configuration forms for Health Log Analytics.

    For the Edge Delta TCP integration setup procedure, see Set up an Edge Delta TCP integration for Health Log Analytics.

    Table 1. Provide details
    Field Description
    Integration Name Unique name of this integration. For example: My Edge Delta TCP integration. This field is required.
    Note:
    When you fill in this field, the generic name displayed on the form adjusts automatically to match the name you entered.
    MID server name MID Server to which the Edge Delta logs are streamed. This field is required.
    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.
    Port The port on the MID Server used for listening on logs. This field is required.

    Choose a port within the suggested range from the array. The port must not be occupied by another process. Ensure that your organization's security team opens the selected port.
    Service instance The service instance to which to bind the log data. This field is required.
    Transport The protocol used for streaming log messages to your ServiceNow instance: TCP. This field is read-only.
    Description Option to add a brief description of the integration to help identify it.
    Table 2. Advanced settings
    Field Description
    Lookup hostnames Option to perform DNS lookup to resolve IPs to hostnames. The default value is false.
    Sub sample drop ratio The ratio of logs to drop. The default value is -1: no logs are dropped.

    For example: If you want one out of every five logs to be dropped, change the value to 5.
    Sub sample receive ratio The ratio of logs to receive. The default value is -1: no logs are received.

    For example: If you want one out of every five logs to be received, change the value to 5.
    Max length in bytes The maximum length of log messages in bytes. The default value is 32766.
    Character encoding The character encoding for this data input. Default is UTF-8.
    Line breaker delimiters The line break character separating the raw log lines.

    Splitting values must be separated by a comma followed by a space: ", ". For example: "\r, \n, , splitHere, #".
    Boss thread count The number of threads that manage connections.
    Worker thread count The number of threads that handle incoming data.
    Read timeout seconds The timeout in seconds since the last read. When the timeout expires, the system closes the channel.
    Default timezone The time zone of events that the system uses if a log does not specify the time zone.

    By default, the system uses GMT, but you can specify a different time zone.
    Drop if queue is full Option to discard logs if there is a load on the MID Server.