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 TCP Integration Configuration Fields

    This document details the configuration fields for setting up TCP integration with Health Log Analytics in ServiceNow. It covers essential parameters necessary for successful integration, ensuring efficient log data streaming to your ServiceNow instance.

    Show full answer Show less

    Key Features

    • Integration Name: A unique identifier for the integration, required for the setup.
    • MID Server Name: Specifies the MID Server for log streaming; only those with log ingestion capability and basic authentication are eligible.
    • Port: Designates a unique port for the MID Server to use, requiring prior security team approval for access.
    • Service Instance: Binds the log data to a specific service instance, which is mandatory.
    • Transport: Fixed as TCP, indicating the protocol for log message transmission.
    • Description: Allows for a brief context on the integration to aid identification.

    Advanced Settings

    • Use SSL/TLS: Option to secure log data transmission.
    • Lookup Hostnames: Enables DNS resolution for IP addresses.
    • Thread Counts: Configurable counts for boss and worker threads to manage connections and incoming data.
    • Read Timeout Seconds: Sets the timeout duration for reading logs.
    • Default Timezone: Establishes the default timezone for logs lacking specified time zones.
    • Subsample Ratios: Controls the event drop and receive ratios.
    • Max Length in Bytes: Defines the maximum size for log messages.
    • Character Encoding: Specifies the encoding format for the data input.
    • Drop if Queue is Full: Allows logs to be discarded under load conditions.
    • Line Breaker Delimiters: Customizes line separation for raw log lines using specified characters.

    Key Outcomes

    Implementing these configuration fields effectively allows ServiceNow customers to streamline the ingestion of log data, improve log management efficiency, and ensure secure and reliable data transmission. Proper setup leads to enhanced operational insights and better overall system performance.

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

    For the TCP integration setup procedure, see Set up a TCP integration for Health Log Analytics.

    Table 1. Provide details tab
    Field Description
    Integration Name Unique name of this integration. For example: My 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 The MID Server to which the logs are streamed. This field is required.
    • You can select only MID Servers with log ingestion capability 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.
    Port The port for the MID Server. This field is required.

    Select a unique port from the array. The placeholder shows the range of ports from which to choose. Make sure 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
    Use SSL/TLS Option to use SSL/TLS.
    Lookup hostnames Option to perform DNS lookup to resolve IPs to hostnames.
    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 time zone of events that the system will use if a log does not specify the time zone.

    By default, the system uses GMT in such cases, but you can specify a different time zone.
    Default timezone The default time zone of events. The system uses this default when the log does not specify a time zone.
    Sub sample drop ratio The ratio of events to drop.
    Sub sample receive ratio The ratio of events to receive.
    Max length in bytes The maximum length of log messages in bytes.
    Character encoding The character encoding for this data input.
    Drop if queue is full Option to discard logs if there is a load on the MID Server.
    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, #".