You can monitor AWS 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.
AWS IoT SiteWise publishes the metrics and dimensions listed in the sections below to the
AWS/IoTSiteWise namespace.
Tip
AWS 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.
AWS IoT Greengrass Version 2 gateway metrics
AWS IoT SiteWise publishes gateway metrics for Classic streams, V2 gateways and MQTT-enabled, V3 gateways. Unless otherwise indicated, each metric is applicable to both self-hosted gateway versions. All SiteWise Edge gateway metrics are published on a one minute interval.
| Metric | Description |
|---|---|
Gateway.AvailableMemory |
The available memory of a SiteWise Edge gateway. Unit: Bytes Dimension: None |
Gateway.AvailableDiskSpace |
The available disk space of a SiteWise Edge gateway. Unit: Bytes Dimension: None |
Gateway.CloudConnectivity |
The cloud connectivity status of a SiteWise Edge gateway. Unit: None Dimension: GatewayId |
Gateway.CpuUsage |
The CPU usage of a SiteWise Edge gateway. Unit: Percentage Dimension: None |
Gateway.TotalDiskSpace |
The total disk space of a SiteWise Edge gateway. Unit: Bytes Dimension: None |
Gateway.TotalMemory |
The total memory of a SiteWise Edge gateway. Unit: Bytes Dimension: None |
Gateway.UsedDiskSpace |
The used disk space of a SiteWise Edge gateway. Unit: Bytes Dimension: None |
Gateway.UsedMemory |
The used memory of a SiteWise Edge gateway. Unit: Bytes Dimension: None |
Gateway.UsedPercentageDiskSpace |
The used percentage of disk space of a SiteWise Edge gateway. Unit: Bytes Dimension: None |
Gateway.UsedPercentageMemory |
The used percentage memory of a SiteWise Edge gateway. Unit: Bytes Dimension: None |
| Metric | Description |
|---|---|
IoTSiteWisePublisher.ComponentBuildVersion |
This metric indicates the build version of the IoT SiteWise publisher component running on the gateway. A value of 1 signifies that the gateway is running a version of the publisher corresponding to the Unit: 1 Dimensions: GatewayId, ComponentBuildVersion |
IoTSiteWisePublisher.DroppedCount |
The number of data points that are dropped by a SiteWise Edge gateway
( Unit: Count Dimensions: GatewayId |
IoTSiteWisePublisher.Heartbeat |
Generated every minute by the Publisher in the SiteWise Edge gateway. Unit: 1 (1 representing the Publisher is running and missing the data point representing the Publisher is not running.) Dimensions: GatewayId |
IoTSiteWisePublisher.IsConnectedToMqttBroker |
Generated every minute by the Publisher in the SiteWise Edge gateway. Unit: 1 (1 representing the Publisher is connected to a MQTT broker.) Dimensions: GatewayId |
IoTSiteWisePublisher.MessageCheckpointPersistenceErrorCount |
The metric indicates that the gateway has detected an issue with the
checkpoint file used to track data processed by the publisher. A value of Unit: None Dimensions: AccountId, GatewayId |
IoTSiteWisePublisher.MqttMessageReceivedSuccessCount |
The number of messages successfully received by the Publisher from the MQTT broker, generated every minute. Unit: Count Dimensions: GatewayId |
IoTSiteWisePublisher.MqttReceivedSuccessBytes |
The number of bytes of message data successfully received by the Publisher from the MQTT broker, generated every minute. Unit: Count Dimensions: GatewayId |
IoTSiteWisePublisher.NumberOfSubscriptionsToMqttBroker |
The number of topics subscribed to the MQTT broker by the Publisher, generated every minute. A multilevel wild card topic is counted as 1. Unit: Count Dimensions: GatewayId |
IoTSiteWisePublisher.NumberOfUniqueMqttTopicsReceived |
The number of unique topics received by the Publisher from the MQTT broker, generated every minute. Unit: Count Dimensions: GatewayId |
IoTSiteWisePublisher.PublishFailureCount |
The number of data points that a SiteWise Edge gateway ( Unit: Count Dimensions: GatewayId |
IoTSiteWisePublisher.PublishRejectedCount |
The number of data points that a SiteWise Edge gateway ( Unit: Count Dimensions: GatewayId |
IoTSiteWisePublisher.PublishSuccessCount |
The number of data points that a SiteWise Edge gateway ( Unit: Count Dimensions: GatewayId |
IoTSiteWisePublisher.PublishToS3FailureCount |
The number of data points that a gateway ( Unit: Count Dimensions: GatewayId |
IoTSiteWisePublisher.PublishToS3SuccessCount |
The number of data points that a gateway ( Unit: Count Dimensions: GatewayId |
| Metric | Description |
|---|---|
OpcUaCollector.ActiveDataStreamCount |
The number of data streams that a SiteWise Edge gateway ( Unit: Count Dimensions: GatewayId, SourceName, PropertyGroup |
OpcUaCollector.ComponentBuildVersion (not available on Classic
streams, V2 gateways) |
This metric indicates the build version of the IoT SiteWise OPC UA collector component running on the gateway. A value of 1 signifies that the gateway is running a version of the collector corresponding to the Unit: 1 Dimensions: GatewayId, ComponentBuildVersion |
OpcUaCollector.ConversionErrors |
The number of data points that a SiteWise Edge gateway ( Unit: Count Dimensions: GatewayId, SourceName |
OpcUaCollector.Heartbeat |
Generated every minute for each OPC UA source ( Unit: Count (1 representing the source is connected and 0 representing the source is disconnected.) Dimensions: GatewayId, SourceName |
OpcUaCollector.IncomingValuesCount |
The number of data points that a SiteWise Edge gateway ( Unit: Count Dimensions: GatewayId, SourceName, PropertyGroup |
OpcUaCollector.IncomingValueErrors |
The number of data points that a SiteWise Edge gateway ( Unit: Count Dimensions: GatewayId, SourceName, PropertyGroup |
OpcUaCollector.IsConnectedToMqttBroker (not available on Classic
streams, V2 gateways) |
Generated every minute by the IoT SiteWise OPC UA collector component in the SiteWise Edge gateway. Unit: 1 (1 representing the IoT SiteWise OPC UA collector component is connected to an MQTT broker) Dimensions: GatewayId |
OpcUaCollector.MqttMessagesDroppedCount (not available on Classic
streams, V2 gateways) |
The number of MQTT messages dropped by the IoT SiteWise OPC UA collector component. Unit: Count Dimensions: GatewayId, SourceName |
OpcUaCollector.MqttMessagesPublishedBytes (not available on Classic
streams, V2 gateways) |
The number of bytes of MQTT message data successfully published by the IoT SiteWise OPC UA collector component to the MQTT broker. Unit: Count Dimensions: GatewayId, SourceName |
OpcUaCollector.MqttMessagesPublishedCount (not available on Classic
streams, V2 gateways) |
The number of MQTT messages successfully published by the IoT SiteWise OPC UA collector component to the MQTT broker. Unit: Count Dimensions: GatewayId, SourceName |
OpcUaCollector.NullValueCount (not available on Classic streams, V2
gateways) |
The number of null values received by the IoT SiteWise OPC UA collector component from the OPC UA server. Unit: Count Dimensions: GatewayId, SourceName, PropertyGroup |
OpcUaCollector.NumberOfUniqueMqttTopicsPublished (not available on
Classic streams, V2 gateways) |
The number of unique MQTT topics published by the IoT SiteWise OPC UA collector to the MQTT broker. Unit: Count Dimensions: GatewayId, SourceName |
| Metric | Description |
|---|---|
Gateway.DataProcessor.IngestionThrottled (not available on
MQTT-enabled, V3 gateways) |
The number of data points that were throttled, generated every minute. Unit: Count Dimensions: ThrottledAt |
Gateway.DataProcessor.MeasurementRejected (not available on
MQTT-enabled, V3 gateways) |
The number of measurements that were rejected, generated every minute. Unit: Count Dimensions: Reason |
Gateway.DataProcessor.MessagesRemaining (not available on
MQTT-enabled, V3 gateways) |
The number of messages remaining in a stream, generated every minute. Unit: Count Dimensions: StreamName |
Gateway.DataProcessor.ProcessingError (not available on
MQTT-enabled, V3 gateways) |
The number of processing errors, generated every minute. Unit: Count Dimensions: Reason |
