TCP integration configuration fields

  • Release version: Xanadu
  • Updated September 2, 2024
  • 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

    The TCP integration configuration fields for Health Log Analytics allow ServiceNow customers to set up and manage log ingestion effectively. This configuration includes essential fields required for defining the integration, as well as advanced settings that enhance log processing capabilities.

    Show full answer Show less

    Key Features

    • Integration Name: Unique identifier for the integration, which updates the form display name automatically.
    • MID Server Name: Selects the appropriate MID Server with log ingestion capability; limited to those supporting basic authentication.
    • Port: Requires a unique port choice from a specified range, ensuring compliance with organizational security protocols.
    • Service Instance: Designates the service instance to bind log data to.
    • Transport: Fixed to TCP for streaming log messages.
    • Advanced Settings: Options for SSL/TLS, DNS lookups, thread management, read timeouts, time zone specifications, event drop ratios, log message length, character encoding, and log handling under load conditions.

    Key Outcomes

    By utilizing these configuration fields, ServiceNow customers can ensure optimal log ingestion, manage performance under varying loads, and maintain flexibility in how log data is processed and stored. Configuring these settings correctly is crucial for effective monitoring and analysis of health logs within ServiceNow.

    Description of the fields on the TCP integration configuration forms 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 for selecting to use SSL/TLS.
    Lookup hostnames Option for selecting 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 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 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.
    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 for selecting 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, #".