TCP data input 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 data input configuration fields

    This document explains the configuration fields available on the TCP data input form used for streaming log data to a MID Server within ServiceNow. It covers both basic and advanced settings, enabling customers to set up and manage TCP-based log ingestion effectively.

    Show full answer Show less

    Basic configuration

    • Name: Required field to specify the name of the data input.
    • Description: Optional field to describe the data input.
    • Port: Required field to select a unique port for the MID Server. It is important to ensure this port is open by your organization’s security team.
    • MID Server: Required field to select a MID Server that supports log ingestion with basic authentication (mTLS-enabled MID Servers are not listed). The default limit is 10 streaming data inputs per MID Server, adjustable via MID Server properties.
    • Service instance: Required to bind the log data. If no appropriate service instance exists, create one, add configuration items (CIs), and set its status to Operational.

    Additional read-only fields provide status information about the data input, including the current status, transport protocol (TCP), number of log sources created, timestamps for last log and disablement, and any streaming error messages.

    Advanced configuration

    The advanced settings allow fine-tuning of the TCP data input behavior:

    • Use SSL/TLS: Option to enable secure communication.
    • Look up hostnames: Option to perform DNS lookups to resolve IP addresses to hostnames (default is false).
    • Boss thread count: Number of threads managing connections (default 1).
    • Worker thread count: Number of threads handling incoming data (default 4).
    • Read timeout seconds: Timeout duration after last read before closing the channel (default 30 seconds).
    • Default timezone: Time zone used when logs lack a specified time zone (default GMT).
    • Sub sample drop/receive ratios: Ratios to control event sampling (-1 indicates no sampling).
    • Max length in bytes: Maximum size of log messages, defaulting to 32,766 bytes.
    • Character encoding: Encoding format for the data input, default UTF-8.
    • Drop if queue is full: Option to drop logs if MID Server load is high.
    • Line breaker delimiters: Defines characters used to split raw log lines; multiple delimiters should be comma and space separated (e.g., "\r, \n, , splitHere, #").

    Practical considerations

    When configuring TCP data inputs for your MID Servers, select unique ports that are open and supported by your security policies. Choose MID Servers enabled for basic authentication log ingestion and monitor the streaming status and errors through the read-only fields. Utilize advanced options to optimize performance, security, and data parsing according to your environment’s needs.

    Description of the fields on the TCP 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.
    Port The port for the MID Server.

    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.

    This field is required.
    MID The MID Server to which the logs are streamed.
    Note:
    • 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.
    This field is required.
    Service instance The service instance to which to bind the log data. This field is required.
    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.

    The following fields show read-only information:

    Field Description
    Status Status of the data input.
    Transport Protocol used to send the log data.

    Rsyslog and Splunk send data using the TCP protocol.
    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.

    Advanced configuration

    Table 1. Advanced configuration form
    Field Description Default value
    Use SSL/TLS Option for selecting to use SSL/TLS.
    Look up hostnames Option for selecting to perform DNS lookup to resolve IPs to hostnames. false
    Boss thread count The number of threads that manage connections. 1
    Worker thread count The number of threads that handle incoming data. 4
    Read timeout seconds The timeout in seconds since the last read. When the timeout expires, the system closes the channel. 30
    Default timezone The default time zone of events. The system uses this default when the log does not specify a time zone. GMT
    Sub sample drop ratio The ratio of events to drop. -1
    Sub sample receive ratio The ratio of events to receive. -1
    Max length in bytes The maximum length of log messages in bytes. 32766
    Character encoding The character encoding for this data input. UTF-8
    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, #".