Buffering parameters
- Last UpdatedApr 19, 2024
- 2 minute read
You can configure the following buffering parameters:
|
Parameter |
Required |
Type |
Description |
|---|---|---|---|
|
EnablePersistentBuffering |
Optional |
boolean |
Enables or disables on- disk buffering. Allowed value: true or false Default value: true Note: If you disable persistent buffering, in- memory buffering is used. On-disk and in-memory buffering are limited by value in the MaxBufferSizeMB property. |
|
MaxBufferSizeMB |
Optional |
integer |
Defines the maximum size of the buffer that is persisted on disk1 or used in memory2. The unit is specified in MB (1 Megabyte = 1048576 bytes). Consider the capacity and the type of storage medium to determine a suitable value for this parameter. Minimum value: 1 Maximum value: 2147483647 Default value: 1024 Note: The MaxBufferSizeMB property is applied to each configured endpoint. For example, if you set the MaxBufferSizeMB to 1024 and you configured the agent to send data to two endpoints (for example, AVEVA Server and CONNECT data services), the total maximum resources used for buffering will be 2048. The health endpoint is an exception fixed at 20 MB. |
|
BufferLocation |
Required |
string |
Defines the location of the buffer files. Absolute paths are required. Consider the access- control list (ACL) when you set this parameter. BufferLocation is used to buffer files when EnablePersistentBuffering is true. Allowed value: Valid path to a folder location in the file system Windows: %ProgramData%\OSIsoft\Adapters\EventsToCONNECT\Buffers |
1Buffering to disk (disk is only used if required):
-
Data is only written to the disk buffer if queued in the memory buffer for more than 5 seconds.
-
The MaxBufferSizeMB is applied per configured endpoint except the health endpoint.
-
An agent creates 20 MB buffer files that are stored in BufferLocation.
-
When MaxBufferSizeMB is reached, the oldest buffer file is deleted and a new buffer file is created.
-
The health endpoint is fixed at 20 MB. When the health endpoint buffer file becomes full, a new buffer file is created and the previous buffer file is deleted.
Note: The following rules apply in case of an error when creating a new buffer file:
- Attempt to delete oldest buffer file and retry.
- If unable to buffer, errors are logged to indicate data loss.
- If a buffer file is corrupted, an attempt is made to recover individual records and any failure to recover records is logged.
2Buffering only to memory:
-
The MaxBufferSizeMB is applied per configured endpoint except the health endpoint.
-
When MaxBufferSizeMB is reached, the oldest messages in the memory buffer are removed. Depending on the size of a new message, several old messages may be removed.
-
The health endpoint is fixed at 20 MB. When the health endpoint buffer file becomes full, the oldest messages in the memory buffer are removed and new messages are added.