Cloud - Azure - Internet of Things Opspack
Azure’s IoT Suite enables users to capture and analyze untapped data to improve organizational efficiency. With everything from remote monitoring to analysis and insights on untapped data, the Azure IoT Suite can help transform your business and easily connect all types of devices.
What You Can Monitor Copied
Opsview Monitor’s IoT Opspack provides all the metrics to track your IoT devices. Opsview Monitor empowers developers to monitor the full lifecycle of your IoT deployments by receiving cloud-to-device service metrics. These include:
- Cloud-to-Device (c2d) commands, methods and twin read details
- Device-to-Cloud (d2c) telemetry, endpoint and twin read details
- IoT Hub message quotas, job and twin query details, and total device counts
Service Checks Copied
| Service Check | Description |
|---|---|
| Azure - IOT - c2d Commands Egress Abandon Success | Number of cloud-to-device commands abandoned by the device. |
| Azure - IOT - c2d Commands Egress Complete Success | Number of cloud-to-device commands completed successfully by the device. |
| Azure - IOT - c2d Commands Egress Reject Success | Number of cloud-to-device commands rejected by the device. |
| Azure - IOT - c2d Methods Success | The count of all successful direct method calls. |
| Azure - IOT - c2d Methods Failure | The count of all failed direct method calls. |
| Azure - IOT - c2d Methods Request Size | The average, min, and max of all successful direct method requests. |
| Azure - IOT - c2d Methods Response Size | The average, min, and max of all successful direct method responses. |
| Azure - IOT - c2d Twin Read Success | The count of all successful back-end-initiated twin reads. |
| Azure - IOT - c2d Twin Read Failure | The count of all failed back-end-initiated twin reads. |
| Azure - IOT - c2d Twin Read Size | The average, min, and max of all successful back-end-initiated twin reads. |
| Azure - IOT - c2d Twin Update Success | The count of all successful back-end-initiated twin updates. |
| Azure - IOT - c2d Twin Update Failure | The count of all failed back-end-initiated twin updates. |
| Azure - IOT - c2d Twin Update Size | The average, min, and max size of all successful back-end-initiated twin updates. |
| Azure - IOT - d2c Telemetry Ingress AllProtocol | Number of device-to-cloud telemetry messages attempted to be sent to your IoT hub. |
| Azure - IOT - d2c Telemetry Ingress Success | Number of device-to-cloud telemetry messages sent successfully to your IoT hub. |
| Azure - IOT - d2c Telemetry Ingress Send Throttle | d2c Telemetry Ingress Send Throttle. |
| Azure - IOT - d2c Telemetry Egress Success | Number of times messages were successfully written to endpoints (total). |
| Azure - IOT - d2c Telemetry Egress Dropped | Number of messages dropped because they did not match any routes and the fallback route was disabled. |
| Azure - IOT - d2c Telemetry Egress Orphaned | The count of messages not matching any routes including the fallback route. |
| Azure - IOT - d2c Telemetry Egress Invalid | The count of messages not delivered due to incompatibility with the endpoint. |
| Azure - IOT - d2c Telemetry Egress Fallback | Number of messages written to the fallback endpoint. |
| Azure - IOT - d2c Endpoints Egress Event Hub | Number of times messages were successfully written to Event Hub endpoints. |
| Azure - IOT - d2c Endpoints Egress Service Bus Queue | Number of times messages were successfully written to Service Bus Queue endpoints. |
| Azure - IOT - d2c Endpoints Egress Service Bus Topics | Number of times messages were successfully written to Service Bus Topic endpoints. |
| Azure - IOT - d2c Endpoints Egress Built In Events | Number of times messages were successfully written to the built-in endpoint (messages/events). |
| Azure - IOT - d2c Endpoints Latency Event Hub | The average latency between message ingress to the IoT hub and message ingress into an Event Hub endpoint, in milliseconds. |
| Azure - IOT - d2c Endpoints Latency Service Bus Queue | The average latency between message ingress to the IoT hub and message ingress into a Service Bus Queue endpoint, in milliseconds. |
| Azure - IOT - d2c Endpoints Latency Service Bus Topics | The average latency between message ingress to the IoT hub and message ingress into a Service Bus Topic endpoint, in milliseconds. |
| Azure - IOT - d2c Endpoints Latency Built In Events | The average latency between message ingress to the IoT hub and message ingress into the built-in endpoint (messages/events), in milliseconds. |
| Azure - IOT - d2c Twin Read Failure | The count of all failed device-initiated twin reads. |
| Azure - IOT - d2c Twin Read Size | The average, min, and max of all successful device-initiated twin reads. |
| Azure - IOT - d2c Twin Update Success | The count of all successful device-initiated twin updates. |
| Azure - IOT - d2c Twin Update Failure | The count of all failed device-initiated twin updates. |
| Azure - IOT - d2c Twin Update Size | The average, min, and max size of all successful device-initiated twin updates. |
| Azure - IOT - Twin Queries Success | The count of all successful twin queries. |
| Azure - IOT - Twin Queries Failure | The count of all failed twin queries. |
| Azure - IOT - Twin Queries Result Size | The average, min, and max of the result size of all successful twin queries. |
| Azure - IOT - Job Create Twin Update Job Success | The count of all successful creation of twin update jobs. |
| Azure - IOT - Job Create Twin Update Job Failure | The count of all failed creation of twin update jobs. |
| Azure - IOT - Jobs Create Direct Method Job Success | The count of all successful creation of direct method invocation jobs. |
| Azure - IOT - Jobs Create Direct Method Job Failure | The count of all failed creation of direct method invocation jobs. |
| Azure - IOT - List Jobs Success | The count of all successful calls to list jobs. |
| Azure - IOT - List Jobs Failure | The count of all failed calls to list jobs. |
| Azure - IOT - Cancel Jobs Success | The count of all successful calls to cancel a job. |
| Azure - IOT - Cancel Jobs Failure | The count of all failed calls to cancel a job. |
| Azure - IOT - Query Jobs Success | The count of all successful calls to query jobs. |
| Azure - IOT - Query Jobs Failure | The count of all failed calls to query jobs. |
| Azure - IOT - Jobs Completed | The count of all completed jobs. |
| Azure - IOT - Jobs Failed | The count of all failed jobs. |
| Azure - IOT - Daily Message Quota Used | Daily Message Quota Used. |
| Azure - IOT - Total Devices | Number of devices registered to your IoT hub. |
| Azure - IOT - Total Connected Devices | Number of devices connected to your IoT hub. |
Setup Azure for Monitoring Copied
This Opspack requires Administrator access on Azure. You need to retrieve the following credentials:
- Subscription ID
- Tenant/Directory ID
- Client/Application ID
- Secret Key
Find Subscription ID Copied
The Subscription ID can be found in the Subscriptions section under the All services section from the Azure dashboard
Find the Tenant/Directory ID Copied
The Tenant/Directory ID can be found in the Azure Active Directory under the Properties section from the Azure dashboard
Find the Client/Application ID for your application Copied
You need to create and register your application if you haven’t already. Use the following documentation from Microsoft: Create an Azure Active Directory application
The Client/Application ID can be found in Azure Active Directory under the App registrations section from the Azure dashboard
Generate the Secret Key for your application Copied
You will need to create a Secret Key for your application, once this has been created its value will be hidden so save the value during creation
To create the Secret Key, select your application from the list, select the Settings within your application and then select the Keys option
There you can create a new key by adding the description and expiration period and the value will be generated
Provide access to the subscription you wish to monitor Copied
Navigate to the Subscriptions section and select the Subscription you selected before
In the Subscription to be monitored, click Access Control (IAM)
Then click the Add button, select Monitoring Contributor and select the application
If you are running more than one subscription these steps will need to be done for each one you wish to monitor
Setup and Configuration Copied
Add the Host Template Copied
Add the Cloud - Azure - Internet Of Things Host Template to your Opsview Monitor host.
Note
For more information, refer to the documentation on Adding Host Templates to Hosts.
Add and configure variables required for this host Copied
Add AZURE_CREDENTIALS to the host and set the Resource Group as its variable value, then override the Subscription ID, Client ID, Secret Key and Tenant ID to match the values retrieved earlier.
Note
For more information, refer to the documentation on Adding Variables to Hosts.
Apply Changes Copied
Apply Changes and the system will then be monitored:
Plugin help Copied
Secure Args
Thecheck_azure.pyplugin uses the Secure Args feature for argument passing.