AWS iot-sitewise documentation change
Summary
Added new section 'Troubleshooting open-source integrations at the Edge' with guidance for Node-RED, InfluxDB, and Grafana integration issues. Updated formatting and minor wording changes in existing content.
Security assessment
The changes primarily add troubleshooting guidance for third-party integrations and fix formatting/typos. While authentication token validation is mentioned, this is part of standard operational guidance rather than addressing a specific security vulnerability or introducing new security features.
Diff
diff --git a/iot-sitewise/latest/userguide/troubleshooting-gateway.md b/iot-sitewise/latest/userguide/troubleshooting-gateway.md index 46afd183f..2c2e7dc5a 100644 --- a//iot-sitewise/latest/userguide/troubleshooting-gateway.md +++ b//iot-sitewise/latest/userguide/troubleshooting-gateway.md @@ -5 +5 @@ -Configure and access SiteWise Edge gateway logsTroubleshooting SiteWise Edge gateway issuesTroubleshooting the AWS IoT SiteWise Edge application on Siemens Industrial EdgeTroubleshooting AWS IoT Greengrass issues +Configure and access SiteWise Edge gateway logsTroubleshooting SiteWise Edge gateway issuesTroubleshooting the AWS IoT SiteWise Edge application on Siemens Industrial EdgeTroubleshooting open-source integrations at the EdgeTroubleshooting AWS IoT Greengrass issues @@ -20,0 +21,2 @@ You can also view CloudWatch metrics reported by your SiteWise Edge gateways to + * Troubleshooting open-source integrations at the Edge + @@ -55 +57 @@ Use the following information to troubleshoot SiteWise Edge gateway issues. - * I see a ‘SYNC_FAILED’ status when attempting to configure the timestamp setting in a property group on an OPC UA data source + * I see a 'SYNC_FAILED' status when attempting to configure the timestamp setting in a property group on an OPC UA data source @@ -70 +72 @@ If the AWS IoT Greengrass nucleus component (`aws.greengrass.Nucleus`) is out of -###### Upgrade the AWS IoT Greengrass nucleus component (console) +###### To upgrade the AWS IoT Greengrass nucleus component (console) @@ -188 +190 @@ Follow the steps in [Create a gateway for Siemens Industrial Edge](./sa-create-c -### I see a ‘SYNC_FAILED’ status when attempting to configure the timestamp setting in a property group on an OPC UA data source +### I see a 'SYNC_FAILED' status when attempting to configure the timestamp setting in a property group on an OPC UA data source @@ -196 +198 @@ There are two ways to resolve a failing data source sync status. The recommended -There is no data interruption when a data source sync status fails. The source data continues to flow into AWS IoT SiteWise. The configuration simply isn’t syncing with the IoT SiteWise OPC UA collector component on your AWS IoT Greengrass V2 deployment. +There is no data interruption when a data source sync status fails. The source data continues to flow into AWS IoT SiteWise. The configuration simply isn't syncing with the IoT SiteWise OPC UA collector component on your AWS IoT Greengrass V2 deployment. @@ -279 +281 @@ To troubleshoot the AWS IoT SiteWise Edge application on your Siemens Industrial -### I see 'Config file missing AWS_REGION' in the logs. +### I see 'Config file missing AWS_REGION' in the logs @@ -303,0 +306,102 @@ If you see an `Out of sync` error message on your Siemens Industrial Edge gatewa +## Troubleshooting open-source integrations at the Edge + +This section provides solutions for common issues you might encounter when integrating open-source tools with SiteWise Edge. + +###### Note + +Node-RED®, InfluxDB®, and Grafana® are not vendors or suppliers for SiteWise Edge. + +### Connection issues + +Node-RED can't connect to MQTT broker + + +Verify that the MQTT broker is running and accessible on the specified port. Check your network configuration and ensure that the broker address is correct. + +To verify the MQTT broker status, run: + + + docker ps | grep emqx + +InfluxDB connection errors + + +Ensure that your authentication token is valid and that you've specified the correct organization and bucket names. Check that InfluxDB is running and accessible. + +To verify InfluxDB status, run: + + + curl -I http://localhost:8086 + +Grafana can't connect to InfluxDB + + +Verify that the InfluxDB data source configuration in Grafana is correct, including the URL, authentication token, organization, and bucket. + +### Data flow issues + +No data appearing in AWS IoT SiteWise + + +Check that your property alias in the Node-RED flow matches the expected format. Verify that the MQTT topic structure is correct and that the SiteWise Edge gateway is properly configured to receive data from the MQTT broker. + +No SiteWise Edge data stored in InfluxDB + + +Verify that the Node-RED retention flow is correctly configured and that the InfluxDB writer node has the proper bucket and measurement settings. Check the Node-RED debug output for any errors. + +Data format errors + + +Ensure that your data transformation functions correctly convert data between formats. Use the Node-RED debug nodes to inspect the data at each stage of the flow. + +### Performance issues + +High CPU or memory usage + + +Monitor resource usage and adjust the configuration of your components as needed. Consider reducing the data collection frequency or implementing data filtering to reduce the processing load. + +To monitor resource usage, run: + + + docker stats + +Slow Grafana dashboard loading + + +Optimize your InfluxDB queries and consider adding time range limitations to your dashboard panels. Reduce the number of data points displayed by using appropriate aggregation functions. + +### Logging and diagnostics + +To troubleshoot issues, check the logs for each component: + +Node-RED logs + + +View logs in the Node-RED console or run: + + + docker logs node-red + +InfluxDB logs + + +Access logs by running: + + + docker logs influxdb + +Grafana logs + + +View logs by running: + + + docker logs grafana + +SiteWise Edge logs + + +Check the SiteWise Edge gateway logs for MQTT connection and data processing issues. For more information, see [Troubleshooting a SiteWise Edge gateway](./troubleshooting-gateway.html). + @@ -314 +418 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Troubleshoot a portal +Troubleshooting @@ -316 +420 @@ Troubleshoot a portal -Troubleshoot an AWS IoT SiteWise rule action +Troubleshoot a portal