Troubleshoot AVEVA Adapter for Azure Event Hubs
- Last UpdatedOct 08, 2024
- 3 minute read
Adapter for Azure Event Hubs provides troubleshooting features that enable you to verify adapter configuration, confirm connectivity, and view message logs. If you are unable to resolve issues with the adapter or need additional guidance, contact AVEVA Technical Support through the Technical support and feedback portal.
Check configurations
Incorrect configurations can interrupt data flow and cause errors in values and ranges. Perform the following steps to confirm correct configuration for your adapter.
If the adapter is failing to collect any data, navigate to Configure Data source and verify that the following parameter values are correct.
|
Parameter |
Description |
|---|---|
|
StreamIdPrefix |
If you have recently updated this prefix setting, you must Start and stop an adapter for the change to take effect. |
|
EventHubNamespaceConnectionString |
Verify that the string is entered correctly. If the string is entered incorrectly, the adapter cannot connect to the Azure Event Hubs namespace. |
|
ConsumerGroupName |
Verify that the group name is entered correctly. If the group name is entered incorrectly, the adapter cannot read the event stream. |
|
BlobStorageConnectionString |
Verify that the string is entered correctly. If the string is entered incorrectly, the adapter cannot perform check pointing, which disrupts data collection. |
|
CheckpointBlobContainerName |
Verify that the container name is entered correctly. If the name is entered incorrectly, the adapter cannot perform check pointing, which disrupts data collection. |
If specific data streams or sub-streams are not updating, navigate to Configure data selection and verify that the following data selection items are correct:
|
Parameter |
Description |
|---|---|
|
StreamId |
If you using a custom stream ID that is not being generated, verify that it follows the Configure data selection. If the custom stream ID does not follow the rules, the adapter generates a default stream ID based on the measurement configuration. |
|
EventHubName |
The event hub name is valid. If the name is invalid, the adapter cannot collect data. |
|
ValueField |
The JSONPath expression is valid. With an invalid JSONPath expression, the adapter cannot extract a data value from the Azure Event Hubs payload. |
|
IndexField |
The JSONPath expression is valid. With an invalid JSONPath expression, the adapter cannot extract a timestamp from the Azure Event Hubs payload. |
|
DataType |
The correct data type is referenced. An incorrect data type causes data conversion to fail. |
|
IndexFormat |
The correct time format is referenced. A time format that does not match the value from IndexField means that the adapter cannot convert timestamp from the Azure Event Hubs payload. |
-
If the adapter is performing suboptimal, navigate to Optional: Configure Client settings and review the configuration for any custom values that override default settings. Default client settings fit most use cases, so customized settings are more likely to cause issues.
-
Navigate to Egress endpoints. For each configured endpoint, verify that the Endpoint and authentication properties are correct.
-
For a AVEVA PI Server endpoint, verify UserName and Password.
-
For an CONNECT data services endpoint, verify ClientId and ClientSecret.
-
Check connectivity
Perform the following steps to verify active connections to the data source and egress endpoints.
-
Based on your egress endpoints, verify that data values are updating.
-
For AVEVA PI Server, send a request to the PI Web API to verify that PI point values are updating. Use Postman or a Web browser to send the request. For more information, see PI Web API Reference.
Alternatively, use any PI Client software to read point values from the PI Data Archive directly.
-
For CONNECT data services, view the CONNECT data services portal to verify that data streams are updating. For more information, see Getting started with trend data. Alternatively, you can use Postman to send an API request to verify data streams.
-
If configured, use a health endpoint to determine the status of the adapter.
For more information, see Health and Diagnostics.
Check logs
Perform the following steps to view the adapter and endpoint logs to isolate issues for resolution.
-
Navigate to the logs directory:
-
Windows: %ProgramData%\OSIsoft\Adapters\EventHubs\Logs
-
Linux: /usr/share/OSIsoft/Adapters/EventHubs/Logs
-
-
Optional: Change the log level of the adapter to receive more information and context.
For more information, see Optional: Configure Logging.