Splunk TCP integration configuration fields
Summarize
Summary of Splunk TCP Integration Configuration Fields
This document outlines the configuration fields for setting up the Splunk TCP integration within Health Log Analytics, providing essential details for ServiceNow customers to effectively manage log data ingestion from Splunk.
Show less
Key Features
- Integration Name: A unique identifier for the integration; required field.
- MID Server Name: Specifies the MID Server from which logs are pulled; must support basic authentication.
- Port: Required port for the MID Server; ensure it is opened by your security team.
- Description: Optional brief description to help identify the integration.
- Transport: Protocol for streaming logs, set to TCP (read-only).
- Use Cooked Data: Option to ingest log data in its preprocessed format for contextual integrity.
Advanced Settings
- Use SSL/TLS: Enhances data security; required for compressed log transfers.
- Lookup Hostnames: Enables DNS resolution for IPs; defaults to false.
- Use Forwarder TimeZone: Adjusts for the time zone of the Splunk forwarder when using cooked data.
- Enable Compression: Reduces data size for large log volumes when SSL/TLS and cooked data are selected.
- Sub Sample Drop Ratio: Configures the ratio of logs to drop; defaults to no logs dropped.
- Sub Sample Receive Ratio: Configures the ratio of logs to receive; defaults to no logs received.
- Max Length in Bytes: Sets the maximum byte length for log messages; default is 32,766 bytes.
- Character Encoding: Specifies character encoding, default is UTF-8.
- 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; configurable.
- Default Timezone: Time zone used if logs do not specify one; defaults to GMT.
- Drop if Queue is Full: Discards logs under high load on the MID Server.
Key Outcomes
By properly configuring these fields, ServiceNow customers can ensure efficient and secure ingestion of log data from Splunk, optimize data processing, and maintain the integrity of log information crucial for health analytics.
Description of the fields on the Splunk TCP integration configuration forms for Health Log Analytics.
For the Splunk TCP integration setup procedure, see Set up a Splunk TCP integration for Health Log Analytics.
| Field | Description |
|---|---|
| Integration Name | Unique name of this integration. For example: My Splunk 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 log data from Splunk is pulled. This field is required. Note:
|
| Port | The port for the MID Server. This field is required. Make sure that your organization’s security team opens the selected port on the MID Server. |
| Description | Option to add a brief description of the integration to help identify it. |
| Transport | The protocol used for streaming log messages to your ServiceNow instance: TCP. This field is read-only. |
| Use Cooked Data | Option to ingest log data from Splunk in the preprocessed ("cooked") format that Splunk uses on the forwarder. Ingesting data into HLA in this format ensures that each log line retains the relevant contextual information that Splunk embeds into it. |
| Field | Description |
|---|---|
| Use SSL/TLS | Option to use SSL/TLS, for enhanced data security and protection. Note: SSL/TLS must be enabled if you want to send logs in a compressed format. |
| Lookup hostnames | Option to perform DNS lookup to resolve IPs to hostnames. The default value is false. |
| Use Forwarder TimeZone | Option to pass information about the time zone in which the forwarder is located. The MID Server uses this information to adjust for the time zone from which the logs arrive. This option is displayed when Use Cooked Data is selected. It is relevant when using Splunk Universal Forwarders. |
| Enable Compression | Option to send logs in compressed format. Sending logs in a compressed format minimizes the size of the data being transferred, which is important when dealing with large volumes of log data. This option is displayed when Use Cooked Data and Use SSL/TLS are selected. It is relevant when using Splunk Universal Forwarders. |
| 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. |
| 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. |
| Drop if queue is full | Option to discard logs if there is a load on the MID Server. |