Microsoft Azure IOT Hub API poller template
Use this SAM API poller template to monitor Microsoft Azure IOT Hub performance and statistic counters, including ingress and egress telemetry.
Links and screenshots herein are attributed to © 2021 Microsoft Corp., available at docs.microsoft.com.
Use the following parameters to specify the API endpoint in the request URL:
- Configure OAuth 2.0 Azure credentials with the following values:
- Access Token URL:
Although "(optional)" appears next to the Scope field in the UI, this value is required for API pollers based on this template.
- The IOT Hub has access control to the Application with at least the Reader role.
- Default thresholds are not set for this template.
- Here is a request example:
- For reference, see Microsoft.Devices/IotHubs (© 2020, Microsoft Corp., available at docs.microsoft.com).
- You can add the following metrics:
Telemetry message send attempts (total)
The number of device-to-cloud telemetry messages attempted to be sent to your IoT hub.
Telemetry messages sent (total)
The number of device-to-cloud telemetry messages sent successfully to your IoT hub.
C2D message deliveries completed (total)
The number of cloud-to-device message deliveries completed successfully by the device.
C2D messages abandoned (total)
The number of cloud-to-device messages abandoned by the device.
C2D messages rejected (total)
The number of cloud-to-device messages rejected by the device.
Routing: telemetry messages dropped (total)
The number of times messages were dropped by IoT Hub routing due to dead endpoints. This value does not count messages delivered to fallback route as dropped messages are not delivered there.
Routing: messages delivered to fallback (total)
The number of times IoT Hub routing delivered messages to the endpoint associated with the fallback route.
Routing: message latency for Event Hub (avg)
The average latency, in milliseconds (ms), between message ingress to IoT Hub and message ingress into an Event Hub endpoint.
Routing: message latency for Service Bus Queue (avg)
The average latency between message ingress to IoT Hub and telemetry message ingress into a Service Bus queue endpoint.
Routing: message latency for Service Bus Topic (avg)
The average latency between message ingress to IoT Hub and telemetry message ingress into a Service Bus topic endpoint.
Routing: message latency for messages/events (avg)
The average latency between message ingress to IoT Hub and telemetry message ingress into the built-in endpoint (messages/events).
Routing: message latency for storage (avg)
The average latency between message ingress to IoT Hub and telemetry message ingress into a storage endpoint.
Failed twin reads from devices (total)
The count of all failed device-initiated twin reads.
Failed twin updates from devices (total)
The count of all failed device-initiated twin updates.
Failed direct method invocations (total)
The count of all failed direct method calls.
Failed twin reads from back end (total)
The count of all failed back-end-initiated twin reads.
Failed twin updates from back end (total)
The count of all failed back-end-initiated twin updates.
Total device data usage (total)
Bytes transferred to and from any devices connected to an IOT hub.
Total devices (avg)
Number of devices registered to an IOT hub.
Connected devices (avg).
Number of devices connected to an IOT hub.