If you configure a WebSocket source service with a WebSocket path, the source service accepts requests that uses the WebSocket protocol. The source service stores the paths in the EDS configuration.
You can configure the following properties for the WebSocket source service type:
Entity Name
Name of the WebSocket source service. Maximum length is 32 characters.
Description
Description of the source service. Maximum length is 256 characters.
Connection Type
You can select one of the following connection types:
WebSocket
WebSocket Secure
WebSocket Path or WebSocket Secure Path
Path of the WebSocket requests that you want the source service to receive.
Enter the path as the path appears in the POST requests. Enter the path in the following format:
myapp/path
KeyStore Path
The directory that contains the keystore file. Specify the absolute path to the file.
You must specify this property if you select the
WebSocket Secure
connection type.
KeyStore Password
Password for the keystore file.
You must specify this property if you select the
WebSocket Secure
connection type.
Select a secure parameter if you have already created it. To specify a key and value, click
Click to add secure parameters
.
Allow Prefix Path
Specify that the path is a prefix.
Status Check Path
Path to which an HTTP GET request is sent to verify if the server is running.
Port
Port on which the source service listens for incoming connections.
Idle State Timeout (seconds)
Time after which the connection is closed when there is no incoming data. Specify a value of 0 to disable timeout.
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
maxDataFiles
times
maxDataFileSize
. Default is unlimited size.
Statistics
You can collect and monitor the following statistics for the WebSocket 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.
Events to be Processed. Maximum number of messages that can be stored in the internal queue of the source.