Monitoring Amazon IoT SiteWise with Amazon CloudWatch metrics - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Monitoring Amazon IoT SiteWise with Amazon CloudWatch metrics

You can monitor Amazon IoT SiteWise using CloudWatch, which collects raw data and processes it into readable, near real-time metrics. These statistics are kept for 15 months, so that you can access historical information and gain a better perspective on how your web application or service is performing. You can also set alarms that watch for certain thresholds, and send notifications or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide.

Amazon IoT SiteWise publishes the metrics and dimensions listed in the sections below to the AWS/IoTSiteWise namespace.

Tip

Amazon IoT SiteWise publishes metrics on a one minute interval. When you view these metrics in graphs in the CloudWatch console, we recommend that you choose a Period of 1 minute. This lets you see the highest available resolution of your metric data.

Gateway metrics

Amazon IoT SiteWise publishes the following gateway metrics. All gateway metrics are published on a one minute interval.

Important

To receive gateway metrics, you must use at least version 6 of the Amazon IoT SiteWise connector on your gateway. For more information, see Amazon IoT SiteWise connector in the Amazon IoT Greengrass Version 1 Developer Guide.

Gateway metrics
Metric Description
Gateway.Heartbeat

Generated every minute for each gateway (gatewayId) connected.

Gateway.PublishSuccessCount

The number of data points that a gateway (gatewayId) successfully published.

Gateway.PublishFailureCount

The number of data points that a gateway (gatewayId) failed to publish.

This metric counts errors that result from the gateway's calls to the BatchPutAssetPropertyValue operation. For more information about troubleshooting gateways, see Troubleshooting an Amazon IoT SiteWise gateway.

Gateway.ProcessFailureCount

The number of data points that a gateway (gatewayId) failed to process.

This metric count errors that occur between the gateway and the gateway's sources, including errors reported by sources. For more information about troubleshooting gateways, see Troubleshooting an Amazon IoT SiteWise gateway.

Gateway source metrics
Metric Description
OPCUACollector.Heartbeat

Generated every minute for each OPC-UA source (sourceName) connected to a gateway (gatewayId).

OPCUACollector.ActiveDataStreamCount

The number of data streams that a gateway (gatewayId) subscribed to for an OPC-UA source (sourceName).

OPCUACollector.IncomingValuesCount

The number of data points that a gateway (gatewayId) received for an OPC-UA source (sourceName).