Documentation is now available for the Fall 2020 Update release!

Azure IOT Hub

Leave Feedback

Introduction

Azure IoT Hub is a managed service, hosted in the cloud, that acts as a central message hub for bi-directional communication between your IoT application and the devices it manages.

You can:

  • Use Azure IoT Hub to build IoT solutions with reliable and secure communications between millions of IoT devices and a cloud-hosted solution backend.
  • Connect virtually any device to IoT Hub.

Setup

To set up the OpsRamp Azure integration and discover the Azure service, go to Azure Integration Discovery Profile and select Device IOTHub.

Metrics

OpsRamp MetricMetric Display NameUnitAggregation TypeDescription
azure.d2c.telemetry.ingress.allProtocolTelemetry message send attemptsCountTotalNumber of device-to-cloud telemetry messages attempted to be sent to the IoT hub.
azure.d2c.telemetry.ingress.successTelemetry messages sentCountTotalNumber of device-to-cloud telemetry messages sent successfully to the IoT hub.
azure.c2d.commands.egress.complete.successCommands completedCountTotalNumber of cloud-to-device commands completed successfully by the device.
azure.c2d.commands.egress.abandon.successCommands abandonedCountTotalNumber of cloud-to-device commands abandoned by the device.
azure.c2d.commands.egress.reject.successCommands rejectedCountTotalNumber of cloud-to-device commands rejected by the device.
azure.devices.totalDevicesTotal DevicesCountAverageNumber of devices registered to your IoT hub.
azure.devices.connectedDevices.allProtocolConnected DevicesCountAverageNumber of devices connected to your IoT hub.
azure.d2c.telemetry.egress.successTelemetry messages deliveredCountTotalNumber of times messages were successfully written to endpoints (total).
azure.d2c.telemetry.egress.droppedDropped messagesCountTotalNumber of messages dropped because the delivery endpoint was dead.
azure.d2c.telemetry.egress.orphanedOrphaned messagesCountTotalCount of messages not matching any routes including the fallback route.
azure.d2c.telemetry.egress.invalidInvalid messagesCountTotalCount of messages not delivered due to incompatibility with the endpoint.
azure.d2c.telemetry.egress.fallbackMessages matching fallback conditionCountTotalNumber of messages written to the fallback endpoint.
azure.d2c.endpoints.egress.eventHubsMessages delivered to Event Hub endpointsCountTotalNumber of times messages were successfully written to Event Hub endpoints.
azure.d2c.endpoints.latency.eventHubsMessage latency for Event Hub endpointMillisecondsAverageAverage latency between message ingress to the IoT hub and message ingress into an Event Hub endpoint, in milliseconds.
azure.d2c.endpoints.egress.serviceBusQueuesMessages delivered to Service Bus Queue endpointsCountTotalNumber of times messages were successfully written to Service Bus Queue endpoints.
azure.d2c.endpoints.latency.serviceBusQueuesMessage latency for Service Bus Queue endpointsMillisecondsAverageAverage latency between message ingress to the IoT hub and message ingress into a Service Bus Queue endpoint, in milliseconds.
azure.d2c.endpoints.egress.serviceBusTopicsMessages delivered to Service Bus Topic endpointsCountTotalNumber of times messages were successfully written to Service Bus Topic endpoints.
azure.d2c.endpoints.latency.serviceBusTopicsMessage latency for Service Bus Topic endpointsMillisecondsAverageAverage latency between message ingress to the IoT hub and message ingress into a Service Bus Topic endpoint, in milliseconds.
azure.d2c.endpoints.egress.builtIn.eventsMessages delivered to the built-in endpoint (messages/events)CountTotalNumber of times messages were successfully written to the built-in endpoint (messages/events).
azure.d2c.endpoints.latency.builtIn.eventsMessage latency for the built-in endpoint (messages/events)MillisecondsAverageAverage latency between message ingress to the IoT hub and message ingress into the built-in endpoint (messages/events), in milliseconds.
azure.d2c.endpoints.egress.storageMessages delivered to storage endpointsCountTotalNumber of times messages were successfully written to storage endpoints.
azure.d2c.endpoints.latency.storageMessage latency for storage endpointsMillisecondsAverageAverage latency between message ingress to the IoT hub and message ingress into a storage endpoint, in milliseconds.
azure.d2c.endpoints.egress.storage.bytesData written to storageBytesTotalAmount of data, in bytes, written to storage endpoints.
azure.d2c.endpoints.egress.storage.blobsBlobs written to storageCountTotalNumber of blobs written to storage endpoints.
azure.d2c.twin.read.successSuccessful twin reads from devicesCountTotalCount of all successful device-initiated twin reads.
azure.d2c.twin.read.failureFailed twin reads from devicesCountTotalCount of all failed device-initiated twin reads.
azure.d2c.twin.read.sizeResponse size of twin reads from devicesBytesAverageAverage, min, and max of all successful device-initiated twin reads.
azure.d2c.twin.update.successSuccessful twin updates from devicesCountTotalCount of all successful device-initiated twin updates.
azure.d2c.twin.update.failureFailed twin updates from devicesCountTotalCount of all failed device-initiated twin updates.
azure.d2c.twin.update.sizeSize of twin updates from devicesBytesAverageAverage, min, and max size of all successful device-initiated twin updates.
azure.c2d.methods.successSuccessful direct method invocationsCountTotalCount of all successful direct method calls.
azure.c2d.methods.failureFailed direct method invocationsCountTotalCount of all failed direct method calls.
azure.c2d.methods.requestSizeRequest size of direct method invocationsBytesAverageAverage, min, and max of all successful direct method requests.
azure.c2d.methods.responseSizeResponse size of direct method invocationsBytesAverageAverage, min, and max of all successful direct method responses.
azure.c2d.twin.read.successSuccessful twin reads from back endCountTotalCount of all successful back-end-initiated twin reads.
azure.c2d.twin.read.failureFailed twin reads from back endCountTotalCount of all failed back-end-initiated twin reads.
azure.c2d.twin.read.sizeResponse size of twin reads from back endBytesAverageAverage, min, and max of all successful back-end-initiated twin reads.
azure.c2d.twin.update.successSuccessful twin updates from back endCountTotalCount of all successful back-end-initiated twin updates.
azure.c2d.twin.update.failureFailed twin updates from back endCountTotalCount of all failed back-end-initiated twin updates.
azure.c2d.twin.update.sizeSize of twin updates from back endBytesAverageAverage, min, and max size of all successful back-end-initiated twin updates.
azure.twinQueries.successSuccessful twin queriesCountTotalCount of all successful twin queries.
azure.twinQueries.failureFailed twin queriesCountTotalCount of all failed twin queries.
azure.twinQueries.resultSizeTwin Queries result sizeBytesAverageAverage, min, and max of the result size of all successful twin queries.
azure.jobs.createTwinUpdateJob.successSuccessful creations of twin update jobsCountTotalCount of all successful creation of twin update jobs.
azure.jobs.createTwinUpdateJob.failureFailed creations of twin update jobsCountTotalCount of all failed creation of twin update jobs.
azure.jobs.createDirectMethodJob.successSuccessful creations of method invocation jobsCountTotalCount of all successful creation of direct method invocation jobs.
azure.jobs.createDirectMethodJob.failureFailed creations of method invocation jobsCountTotalCount of all failed creation of direct method invocation jobs.
azure.jobs.listJobs.successSuccessful calls to list jobsCountTotalCount of all successful calls to list jobs.
azure.jobs.listJobs.failureFailed calls to list jobsCountTotalCount of all failed calls to list jobs.
azure.jobs.cancelJob.successSuccessful job cancellationsCountTotalCount of all successful calls to cancel a job.
azure.jobs.cancelJob.failureFailed job cancellationsCountTotalCount of all failed calls to cancel a job.
azure.jobs.queryJobs.successSuccessful job queriesCountTotalCount of all successful calls to query jobs.
azure.jobs.queryJobs.failureFailed job queriesCountTotalCount of all failed calls to query jobs. No Dimensions
azure.jobs.completedCompleted JobsCountTotalCount of all completed jobs.
azure.jobs.failedFailed JobsCountTotalCount of all failed jobs.
azure.d2c.telemetry.ingress.sendThrottleNumber of throttling errorsCountTotalNumber of throttling errors due to device throughput throttles.
azure.daily.message.quota.usedTotal number of messages usedCountTotalNumber of total messages used today.
azure.iothub.device.data.usageTotal device data usageBytesTotalBytes transferred to and from any devices connected to the IotHub.
azure.iothub.configurationsConfiguration metricsCountTotalMetrics for configuration operations.

Event support

  • Supported
  • Configurable in OpsRamp Azure Integration Discovery Profile.

External reference