Storage runtime configuration
- Last UpdatedSep 25, 2025
- 3 minute read
The Edge Data Store () storage component is installed with default configurations that are sufficient for most scenarios; however, you can configure the runtime characteristics of the storage component.
Note: Consult with Technical Support before you modify the default configuration.
To update the storage runtime configuration:
-
Using any text editor, create a file that contains the storage runtime configuration.
-
Save the file with the name Storage_Runtime..json.
-
From the same directory where the file exists, run the following script or EdgeCmd utility:
curl -d "@Storage_Runtime..json" -H "Content-Type: application/json" -X PUT http://localhost:5590/api/v1/configuration/storage/Runtime
edgecmd set runtime -file Storage_Runtime..json
Note: The @ symbol is a required prefix for this command.
Parameters
The following table lists all available runtime parameters for storage configuration.
|
Parameter |
Required |
Type |
Description |
|---|---|---|---|
|
IngressDebugExpiration |
Required |
string |
Sets the date and time when debugging should be disabled. If you specify a future date and time, incoming messages are logged and the HTTP request and response content is stored to disk for review. The debug logging stops at the date and time specified. Set the value to null to disable logging. Every incoming message logs a request and response log file. Log files are located in C:\ProgramData\OSIsoft\EdgeDataStore\Logs\IngressDebugLogs\ and grouped by the associated message type. Each log file name is in the format: {ticks}-{operationId}-{Request/Response}.txt. Valid formats are : yyyy-mm-ddThh:mm:ssZ and Local: mm-dd-yyyy hh:mm:ss. When you activate logging, the content of an incoming message, including the headers, is written to multiple files in the Logs directory. Those files are written to the IngressDebugLogs directory in the usual logs directory for every incoming type, container, and data message. |
|
StreamStorageLimitMb |
Required |
integer |
The maximum size in megabytes that a stream can reach. When a stream exceeds the specified size, older data is deleted from the file until the stream is at or below the StreamStorageTargetMb value. The target value, set in the StreamStorageTargetMb property, needs to be smaller than the maximum specified in this property. Note: must be restarted for changes to this setting to take effect. Minimum value: 2. Maximum value: 2147483647. |
|
StreamStorageTargetMb |
Required |
integer |
The size in megabytes that a stream will be reduced to after StreamStorageLimitMb size is reached for a single stream. When a stream exceeds the size specified in the StreamStorageLimitMb property, older data is deleted from the file until the stream is at or below the StreamStorageTargetMb value. The target value needs to be smaller than the maximum specified in the StreamStorageLimitMb property. Note: must be restarted for changes to this setting to take effect. Minimum value: 1. Maximum value: 2147483647. |
|
TransactionLogLimitMB |
No |
integer |
Maximum size in megabytes for transaction log file. When a transaction log exceeds this size, it is deleted, which reduces the amount of data that you can recover if the host device loses power. Minimum value: 1. Maximum value: 2147483647. |
|
CheckpointRateInSec |
No |
integer |
Defines, in seconds, how often the storage component ensures recent data and configuration changes are flushed to storage. A setting of 0 disables checkpointing. Disabling checkpointing reduces the resiliency of the product, which can result in data loss if the host device loses power. Minimum value: 0. Maximum value: 86400. |
|
EnableMetrics |
No |
Boolean |
Enables to create a new stream in the diagnostics namespace to track some metrics about internal storage operations. These metrics have no value outside of troubleshooting specific issues with the help of Technical Support. This should be set to false unless directed by AVEVA support. |
|
SdsLogLevel |
No |
reference |
Restricts the logging generated by ’s internal Sequential Data Store () component to the provided level. Defaults to “Warning”. See log levels for valid levels. Note that this setting applies in conjunction with the overall Storage log level and only applies if it is more restrictive |
|
StreamCacheSize |
No |
integer |
The count of streams that will be cached in memory by the storage component. Creating more streams than this count will negatively impact performance. Note: must be restarted for changes to this setting to take effect. Default: 5000. |
Examples
The following is a valid runtime configuration example.
[
{
"streamStorageLimitMb": 2,
"streamStorageTargetMb": 1,
"ingressDebugExpiration": "0001-01-01T00:00:00",
"checkpointRateInSec": 30,
"transactionLogLimitMB": 250,
"enableMetrics": false,
"streamCacheSize": 5000,
"sdsLogLevel": "Warning"
}
]