Diagnostics configuration
- Last UpdatedSep 25, 2025
- 3 minute read
Edge Data Store () and its components produce performance and system data for diagnostic purposes and store that data locally in the storage component. You can query it locally or egress it to PI Web API endpoints, the CONNECT data services, or both. Diagnostic data is produced and saved by default, but can be disabled using the enableDiagnostics parameter in the System component.
All diagnostics streams will have an ID format of {prefix}{DeviceName}.{StreamId}; for example, APrefixLocalhost.Storage.default.default.Counts. stores diagnostic data within the diagnostics namespace. Local access to this data is available through Sequential Data Store (). For more information, see Read data.
Egress diagnostics data
To egress diagnostics related data, specify diagnostics as the NamespaceId in EgressConfigurations. For details and instructions, see Data egress.
Edge Data Store diagnostics
The Diagnostics.System dynamic type includes these values which are logged in a stream with the ID System.Diagnostics. This diagnostic stream contains system-level information related to the host platform that is running on.
|
Property |
Type |
Description |
|---|---|---|
|
timestamp |
string |
Timestamp of event |
|
ProcessIdentifier |
int |
Process id of the host process |
|
StartTime |
string |
When the host process started |
|
WorkingSet |
long |
Amount of physical memory, in bytes, allocated for the host process |
|
TotalProcessorTime (uom=s) |
double |
Total processor time for the host process expressed in seconds |
|
TotalUserProcessorTime (uom=s) |
double |
User processor time for the host process expressed in seconds |
|
TotalPrivilegedProcessorTime (uom=s) |
double |
Privileged processor time for the host process expressed in seconds |
|
ThreadCount |
int |
Number of threads in the host process |
|
HandleCount |
int |
Number of handles opened by the host process |
|
ManagedMemorySize (uom=MB) |
double |
Number of bytes currently thought to be allocated in managed memory |
|
PrivateMemorySize (uom=MB) |
double |
Amount of paged memory, in bytes, allocated for the host process |
|
PeakPagedMemorySize (uom=MB) |
double |
Maximum amount of memory in the virtual memory paging file, in bytes, used by the host process Note: On Linux platforms, this value is always reported as 0 |
|
StorageTotalSize (uom=MB) |
double |
Total size of the storage medium in use by the |
|
StorageFreeSpace (uom=MB) |
double |
Free space available |
adapter diagnostics
Each adapter of the produces its own diagnostics streams.
Stream count
The Diagnostics.StreamCountEvent dynamic type includes these values, which are logged in a stream with the id {DeviceName}.{componentid}.StreamCount. The stream count and type count include only types and streams created for sequential data received from a data source.
|
Property |
Type |
Description |
|---|---|---|
|
timestamp |
string |
Timestamp of event |
|
StreamCount |
int |
Number of streams created by the adapter instance |
|
TypeCount |
int |
Number of types created by the adapter instance |
IO rate
The Diagnostics.Adapter.IORate dynamic type includes these values, which are logged in a stream with the id {DeviceName}.{componentid}.IORate. IO rate includes only sequential data collected from a data source.
|
Property |
Type |
Description |
|---|---|---|
|
timestamp |
string |
Timestamp of event |
|
IORate |
double |
10-minute rolling average of data rate (event/s) |
Error rate
The Diagnostics.Adapter.ErrorRate dynamic type includes these values, and are logged in a stream with the Id {DeviceName}.{componentid}.ErrorRate.
|
Property |
Type |
Description |
|---|---|---|
|
timestamp |
string |
Timestamp of event |
|
ErrorRate |
double |
10-minute rolling average of error rate (event/s) |
Edge Storage diagnostics
The Storage component of produces the following diagnostics streams.
Storage.default.default.Counts
The Storage.default.default.Counts stream includes counts of the types, streams, and stream views of the default namespace.
|
Property |
Type |
Description |
|---|---|---|
|
timestamp |
string |
Timestamp of event |
|
TypeCount |
integer |
Count of types |
|
StreamCount |
integer |
Count of streams |
|
StreamViewCount |
integer |
Count of stream views |
Storage.default.diagnostics.Counts
The Storage.default.diagnostics.Counts stream includes counts of the types, streams, and stream views of the diagnostics namespace.
|
Property |
Type |
Description |
|---|---|---|
|
timestamp |
string |
Timestamp of event |
|
TypeCount |
integer |
Count of types |
|
StreamCount |
integer |
Count of streams |
|
StreamViewCount |
integer |
Count of stream views |
Storage.Total.Counts
The Storage.Totals.Counts stream includes counts of the types, streams, and stream views of all namespaces of the storage component.
|
Property |
Type |
Description |
|---|---|---|
|
timestamp |
string |
Timestamp of event |
|
TypeCount |
integer |
Count of types |
|
StreamCount |
integer |
Count of streams |
|
StreamViewCount |
integer |
Count of stream views |
IO rate
The Diagnostics.Storage.IORate dynamic type includes these values, which are logged in a stream with the id {DeviceName}.Storage.{EgressType}.{EgressID}.IORate, where {EgressType} can be Periodic or Manual. IO rate includes only sequential data successfully sent to an endpoint for the referenced egress configuration.
|
Property |
Type |
Description |
|---|---|---|
|
timestamp |
string |
Timestamp of event |
|
IORate |
double |
10-minute rolling average of data rate (event/s) |