Use a TCP source service to consume data from an application that streams messages over the TCP protocol. To create a TCP source service, use the TCP source service type.
You can configure the following properties for the TCP source service type:
- Entity Name
- Name of the TCP source. Maximum length is 32 characters.
- Description of the source service. Maximum length is 256 characters.
- TCP port that the source application uses to connect to the source service.
- Character sequence that marks the end of a message in the TCP data stream. Choose a delimiter, or enter a different one.
You can choose one of the following built-in delimiters:
- LF. Line feed character sequence.
- CRLF. Carriage return line feed character sequence.
- STX-ETX. Start-of-text and end-of-text character sequences used in ISO/IEC 2022 systems.
- NUL. NULL character.
- Raw. The data stream consists of raw data without a delimiter.
- L1. One-byte integer that indicates the length of the message.
- L2. Two-byte integer that indicates the length of the message.
- L4. Four-byte integer that indicates the length of the message.
- Fixed Length. The data stream consists of records of the length that you specify in the
Length box. In a message, the TCP source service adds as many complete records as the message can accommodate. The source service does not add incomplete records.
- Custom. String of your choice.
Default is LF.
- Length of each record that is read, in bytes. Specify the length when the source data stream consists of records of a fixed length. The maximum value is 51200.
- Custom Delimiter
Custom character sequence that you want to specify as delimiter for the file source services.
Enter a custom character sequence if you select Custom as the delimiter.
- Maximum Event Size
- Maximum length of data that the source service can read at a time, in bytes. Default is 8192. Minimum value is 1. Maximum value is 51200.
- Retry on Failure
Indicates that the source service should try to open or read from the source if the operation fails the first time.
- Number of Retries
The number of times the source service should retry to open or read from the source.
- Delay between Retries
- Time in milliseconds between successive retries.
- Persist Data
- Persist the data from the source locally so that the source service can continue to process data even if the target is not available.
- Persistence Options
- You can configure the following persistence options:
- batchSizeInBytes. The batch size of the events in bytes after which the data is written to the persistent store. Specify a value of 0 if you want to write the data to the persistent store immediately. Default is 262144 bytes.
- flushInterval. The interval in milliseconds after which the source services writes data to the persistent store. Default is 5000 milliseconds.
- maxDataFiles. The maximum number of data files that the source service can keep in the persistent store. After the number of files exceed this number, a rollover occurs. Default is 10.
- maxDataFileSize. The maximum size of each data file in bytes. When the file reaches the specified size, a file rollover occurs. Default is 1073741824.
- maxQueueSizeInBytes. The maximum size of data that is unsent or has not received acknowledgment in bytes that can be stored in the persistent store. If the specified size is exceeded, the source service does not read data from the source. If you specify a value of 0, the unsent data can be as much as the value of
maxDataFileSize. Default is unlimited size.
- You can collect and monitor the following statistics for the TCP source service:
- Bytes Sent. Number of bytes sent by the source service.
- Events Sent. Number of events sent by the source service.
- Events to be Sent. Number of events that the source service is yet to send.
- Events not Delivered. Number of events that the source service did not deliver.
- Send Rate (Per Sec). Number of bytes sent every second.
- Events Dropped. The number of events dropped by the source service while processing the source data.
- Concurrent Connections. The number of TCP clients currently connected to the source service.
- Maximum Concurrent Clients. The maximum number of TCP clients connected to the source service since the time the source service is up.