Microsoft Azure IOT Hub

This template contains performance and statistics counters for monitoring Azure Azure IOT Hub.

Prerequisites

  • PowerShell module (Azure, AzureRM) is installed before using this template.

    To install the Azure module, execute these PowerShell commands:

    • Install-Module -Name Azure
    • Install-Module -Name AzureRM
  • To connect with the Azure account, you'll need the subcriptionID, ApplicationID, TenantID, and Secret Key.
    Any Azure App (with its name and ID) having minimum role as Read Only
  • IOT Hub name for which metrics are being calculated.
  • PowerShell 5.0 or later.

Credentials

  • Login credential to access the Azure Portal, passed as script arguments per prerequisites (<subscriptionID>, <TenantID>, <ApplicationID>, value=<Secret Key>, <IOT Hub Name>).
  • Optional parameters can be passed to script argument:
    • value=<Time Interval> - during which data must be fetched, in minutes. The default is 1 hour.
    • Number of retries as the second last argument; the default is 3.
    • WaitTime as the last argument; the default is 0.5 seconds

Notes

Monitored Components

Commands abandoned

This monitor provides the total count of Cloud to Device commands abandoned by the device via PowerShell cmd-let.

Unit: Count

Commands completed

This monitor provides the total count of Cloud to Device commands successfully by the device via PowerShell cmd-let.

Unit: Count

Commands rejected

This monitor provides the total count of Cloud to Device commands successfully by the device via PowerShell cmd-let.

Unit: Count

Failed direct method invocations

This monitor provides the total count of failed Cloud to Device method invocations by the device via PowerShell cmd-let.

Unit: Count

Request size of direct method invocations

This monitor provides the Average Request size of Cloud to Device method invocations via PowerShell cmd-let.

Unit: Bytes

Response size of direct method invocations

This monitor provides the Average Response size of Cloud to Device method invocations via PowerShell cmd-let.

Unit: Bytes

Successful direct method invocations

This monitor provides the total count of successful Cloud to Device method invocations by the device via PowerShell cmd-let.

Unit: Count

Failed twin reads from back end

This monitor provides the total count of failed backend-initiated twin reads.

Unit: Count

Response size of twin reads from back end

This monitor provides the average Response size of backend-initiated twin reads.

Unit: Bytes

Successful twin reads from back end

This monitor provides the total count of successful backend-initiated twin reads.

Unit: Count

Failed twin updates from devices

This monitor provides the total count of failed device-initiated twin updates.

Unit: Count

Size of twin updates from devices

This monitor provides the average Response size of device-initiated twin updates.

Unit: Bytes

Successful twin updates from devices

This monitor provides the total count of successful device-initiated twin updates.

Unit: Count

Messages delivered to the built-in endpoint

This monitor provides the total count of messages successfully written to the built-in endpoint.

Unit: Count

Messages delivered to Event Hub endpoints

This monitor provides the total count of messages successfully written to the Event Hub endpoints.

Unit: Count

Messages delivered to Service Bus Queue endpoints

This monitor provides the total count of messages successfully written to the Service Bus Queues endpoints.

Unit: Count

Messages delivered to Service Bus Topic endpoints

This monitor provides the total count of messages successfully written to the Service Bus Topics endpoints.

Unit: Count

Message latency for the built-in endpoint

This monitor provides the average latency between message ingress to the IoT hub and message ingress into the built-in endpoint.

Unit: Milliseconds

Message latency for Event Hub endpoints

This monitor provides the average latency between message ingress to the IoT hub and message ingress into the Event Hub endpoint.

Unit: Milliseconds

Message latency for Service Bus Queue endpoints

This monitor provides the average latency between message ingress to the IoT hub and message ingress into a Service Bus Queue endpoint.

Unit: Milliseconds

Message latency for Service Bus Topic endpoints

This monitor provides the average latency between message ingress to the IoT hub and message ingress into a Service Bus Topic endpoint.

Unit: Milliseconds

Dropped messages

This monitor provides the total count of messages dropped because they did not match any routes and the fallback route was disabled.

Unit: Count

Messages matching fallback condition

This monitor provides the total count of messages written to the fallback endpoint.

Unit: Count

Invalid messages

This monitor provides the total count of messages not delivered due to incompatibility with the endpoint.

Unit: Count

Orphaned messages

This monitor provides the total count of messages not matching any routes including the fallback route.

Unit: Count

Telemetry messages delivered

This monitor provides the count of times messages were successfully written to endpoints.

Unit: Count

Telemetry message send attempts

This monitor provides the total count of Device to Cloud telemetry messages attempted to be sent to IOT Hub.

Unit: Count

Telemetry messages sent

This monitor provides the total count of Device to Cloud telemetry messages successfully sent to IOT Hub.

Unit: Count

Failed twin reads from devices

This monitor provides the total count of failed device-initiated twin reads.

Unit: Count

Response size of twin reads from devices

This monitor provides the average Response size of device-initiated twin reads.

Unit: Bytes

Successful twin reads from devices

This monitor provides the total count of successful device-initiated twin reads.

Unit: Count

Failed twin updates from devices

This monitor provides the total count of failed device-initiated twin updates.

Unit: Count

Size of twin updates from devices

This monitor provides the average response size of device-initiated twin updates.

Unit: Bytes

Successful twin updates from devices

This monitor provides the total count of successful device-initiated twin updates.

Unit: Count

Connected devices

This monitor provides the total count of devices connected to your IoT hub.

Unit: Count

Total devices

This monitor provides the total count of devices registered to your IoT hub.

Unit: Count

Failed job cancellations

This monitor provides the count of failed calls to cancel a job.

Unit: Count

Successful job cancellations

This monitor provides the total count of successful calls to cancel a job.

Unit: Count

Completed jobs

This monitor provides the total count of completed jobs.

Unit: Count

Failed creations of method invocation jobs

This monitor provides the total count of failed creations of direct method invocation jobs.

Unit: Count

Successful creations of method invocation jobs

This monitor provides the total count of successful creations of direct method invocation jobs.

Unit: Count

Failed creations of twin update jobs

This monitor provides the total count of failed creations of twin update jobs.

Unit: Count

Successful creations of twin update jobs

This monitor provides the total count of successful creations of twin update jobs.

Unit: Count

Failed jobs

This monitor provides the total count of failed jobs.

Unit: Count

Failed calls to list jobs

This monitor provides the total count of failed calls to list jobs.

Unit: Count

Successful calls to list jobs

This monitor provides the total count of successful calls to list jobs.

Unit: Count

Failed job queries

This monitor provides the total count of failed calls to query jobs.

Unit: Count

Successful job queries

This monitor provides the total count of successful calls to query jobs.

Unit: Count

Failed twin queries

This monitor provides the total count of failed twin queries.

Unit: Count

Twin queries result size

This monitor provides the average result size of successful twin queries.

Unit: Bytes

Successful twin queries

This monitor provides the total count of successful twin queries.

Unit: Count