Edge Delta TCP integration configuration fields
Summarize
Summary of Edge Delta TCP Integration Configuration Fields
The Edge Delta TCP integration configuration is essential for streaming logs into Health Log Analytics in ServiceNow. This guide outlines the required fields and advanced settings necessary for setting up the integration effectively.
Show less
Key Features
- Integration Name: Assign a unique name to identify your integration; this is a mandatory field.
- MID Server Name: Select the appropriate MID Server for log streaming, ensuring it supports basic authentication.
- Port: Specify a listening port, ensuring it is available and secured by your organization's security team.
- Service Instance: Indicate the service instance for binding log data, which is required.
- Transport: The protocol used is TCP and is read-only.
- Description: Provide an optional description for better identification of the integration.
Advanced Settings
- Lookup Hostnames: Enables DNS lookup for IP resolution; default is false.
- Sub Sample Drop Ratio: Defines the log drop ratio, with a default of -1 (no logs dropped).
- Sub Sample Receive Ratio: Sets the log receive ratio, defaulting to -1 (all logs received).
- Max Length in Bytes: Determines the maximum log message size, defaulting to 32,766 bytes.
- Character Encoding: Specifies the character encoding, default is UTF-8.
- Line Breaker Delimiters: Defines characters that separate raw log lines, formatted as ", ".
- Boss Thread Count: Manages connection threads.
- Worker Thread Count: Handles incoming data threads.
- Read Timeout Seconds: Sets the timeout duration for reads before closing the channel.
- Default Timezone: Specifies the timezone for events if not stated in logs, defaulting to GMT.
- Drop if Queue is Full: Option to discard logs under heavy load on the MID Server.
Key Outcomes
By configuring these fields correctly, ServiceNow customers can streamline log ingestion into Health Log Analytics, ensuring efficient data handling and analysis. This setup enhances operational monitoring and improves incident response capabilities through effective log management.
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.
| 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:
|
| 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. |
| 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. |