Troubleshooting

Edge Data Store (EDS (Edge Data Store)) includes both local and remote means of diagnosing issues encountered while using or developing against EDS (Edge Data Store).

EDS (Edge Data Store) supports a diagnostics namespace that stores streams containing diagnostic information from EDS (Edge Data Store) itself. Egress this data to either a PI Server or CONNECT data services to monitor the state of a system remotely. For details about egressing diagnostic data, see Diagnostics configuration.

In addition to diagnostics data, all components in EDS (Edge Data Store) support Open Message Format (OMF (Open Message Format)) health messages. Configure health messages to send health data to either PI Server or CONNECT data services endpoints for remote monitoring of devices. For more information, see Configure health endpoints.

OMF (Open Message Format) ingress

When a custom application fails to write stream data to EDS (Edge Data Store):

1. Verify the custom application is sending OMF (Open Message Format) messages in the correct order: 1) OMF (Open Message Format) type, 2) OMF (Open Message Format) container, 3) OMF (Open Message Format) data.

   Note: OMF (Open Message Format) messages must be sent in the correct order to be ingressed into EDS (Edge Data Store).

2. Refer to logging of warnings, errors, and messages for help with diagnosing these issues.

OMF (Open Message Format) ingress logging

Ingress logging messages provide a record of ingress events. To capture the most information for troubleshooting:

3. Refer to Configure logging to set logging parameters.

4. For maximum message logging information, set the log level to Trace.

OMF (Open Message Format) ingress message debugging

Every incoming OMF (Open Message Format) message logs a request and response log file. Log files are located in the following location and grouped by the associated OMF (Open Message Format) message type:

C:\ProgramData\OSIsoft\EdgeDataStore\Logs\IngressDebugLogs\

Each log file leverages the following filename format:

{ticks}-{operationId}-{Request/Response}.txt

Use debugging information to troubleshoot problems between an OMF (Open Message Format) application and Edge Data Store. To enable debugging:

5. Refer to Storage runtime configuration to enable debugging.

6. Set an appropriate time value for the IngressDebugExpiration property.

   Note: You can also disable debugging by setting the expiration value to null.

   Date and time strings should use the following formats:

   • UTC (Coordinated Universal Time): yyyy-mm-ddThh:mm:ssZ

   • Local: yyyy-mm-ddThh:mm:ss

Egress

EDS (Edge Data Store) egress extracts data from Sequential Data Store (SDS (Sequential Data Store)) streams and sends the appropriate sequences of type, container, and data OMF (Open Message Format) messages on startup.

If unexpected data appears in an CONNECT data services or PI Server, check if multiple devices are writing to the same SDS (Sequential Data Store) stream. To check egress configuration:

7. Check all egress configuration files in EDS (Edge Data Store) to verify whether any endpoints are duplicated. A duplicate endpoint means that more than one device is egressing data to it, resulting in unexpected data.

8. Assign stream prefixes in the periodic egress configuration to ensure that output data streams are logically separated in the systems of record. For instructions, see Configure periodic data egress.

   Note: Type prefixes may be helpful if you have changed a stream type definition on EDS (Edge Data Store). OMF (Open Message Format) types on both CONNECT data services and the PI Server are immutable once created. If the type of the data stream changes, it is best to either delete the old type definition (if nothing is still using it) or add a type prefix to create a new unique type that will be used by new streams egressing from EDS (Edge Data Store) to the systems of record.

Egress logging

Egress logging messages provide a record of egress events. To capture maximum information for troubleshooting:

9. Refer to Configure logging to set logging parameters.

10. For maximum message logging information, set the log level to Trace.

Egress debugging

Use debugging information to troubleshoot problems between EDS (Edge Data Store) and the egress destination. To enable debugging:

11. Refer to Data egress to enable debugging.

12. Set an appropriate time value for the DebugExpiration property.

    Note: Disable debugging by setting the expiration value to null.

    Date and time strings should use the following formats:

    • UTC (Coordinated Universal Time): yyyy-mm-ddThh:mm:ssZ

    • Local: yyyy-mm-ddThh:mm:ss

Debugging folder/file structure

Debug folders and files are created under the EDS (Edge Data Store) folder as follows:

• Windows: %programdata%\OSIsoft\EdgeDataStore\Logs\EgressDebugLogs\Data\{egressType}\{egressId}\{omfType}\{Ticks}-{Guid}-{Request/Response}.txt

  Definition:

  Linux: /usr/share/OSIsoft/EdgeDataStore/Logs/EgressDebugLogs/Data{egressType}/{egressId}/{omfType}/{Ticks}-{Guid}-{Request/Response}.txt

  Definition:

  The OMF (Open Message Format) specific elements of the file structure are defined in the following table.

  Element	Represents
  omfType	The OMF (Open Message Format) message type: Type, Container, or Data.
  Ticks	The time in milliseconds (tick count) for UTC (Coordinated Universal Time) DateTime when determined message would be written to disk.
  Guid	The unique GUID (Globally Unique Identifier) for each request/response pair.
  Req/Res	Whether the message was HTTP (Hypertext Transfer Protocol) request or response.

Additional resources

For information about specific log messages and possible resolutions, refer to the AVEVA Customer Portal.