Skip to content

Commit 3204051

Browse files
denreadenrea
authored
Merge pull request #279509 from TimShererWithAquent/us248136g
Convert 20 services to new template: Azure IoT Hub Device Provisioning Service
2 parents 0fab3df + 09109c8 commit 3204051

File tree

4 files changed

+110
-125
lines changed

4 files changed

+110
-125
lines changed

‎articles/iot-dps/how-to-troubleshoot-dps.md

Lines changed: 2 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -7,52 +7,12 @@ author: kgremban
77
ms.author: kgremban
88
ms.service: iot-dps
99
ms.topic: troubleshooting
10-
ms.date: 05/25/2022
10+
ms.date: 06/28/2024
1111
---
1212

1313
# Troubleshooting with Azure IoT Hub Device Provisioning Service
1414

15-
Provisioning issues for IoT devices can be difficult to troubleshoot because there are many possible points of failures such as attestation failures, registration failures, etc. This article provides guidance on how to detect and troubleshoot device provisioning issues via Azure Monitor. To learn more about using Azure Monitor with DPS, see [Monitor Device Provisioning Service](monitor-iot-dps.md).
16-
17-
## Using Azure Monitor to view metrics and set up alerts
18-
19-
To view and set up alerts on IoT Hub Device Provisioning Service metrics:
20-
21-
1. Sign in to the [Azure portal](https://portal.azure.com).
22-
23-
2. Browse to your IoT Hub Device Provisioning Service.
24-
25-
3. Select **Metrics**.
26-
27-
4. Select the desired metric. For supported metrics, see [Metrics](monitor-iot-dps-reference.md#metrics).
28-
29-
5. Select desired aggregation method to create a visual view of the metric.
30-
31-
6. To set up an alert of a metric, select **New alert rules** from the top right of the metric blade, similarly you can go to **Alert** blade and select **New alert rules**.
32-
33-
7. Select **Add condition**, then select the desired metric and threshold by following prompts.
34-
35-
To learn more about viewing metrics and setting up alerts on your DPS instance, see [Analyzing metrics](monitor-iot-dps.md#analyzing-metrics) and [Alerts](monitor-iot-dps.md#alerts) in Monitor Device Provisioning Service.
36-
37-
## Using Log Analytics to view and resolve errors
38-
39-
1. Sign in to the [Azure portal](https://portal.azure.com).
40-
41-
2. Browse to your Device Provisioning Service.
42-
43-
3. Select **Diagnostics settings**.
44-
45-
4. Select **Add diagnostic setting**.
46-
47-
5. Configure the desired logs to be collected. For supported categories, see [Resource logs](monitor-iot-dps-reference.md#resource-logs).
48-
49-
6. Tick the box **Send to Log Analytics** ([see pricing](https://azure.microsoft.com/pricing/details/log-analytics/)) and save.
50-
51-
7. Go to **Logs** tab in the Azure portal under Device Provisioning Service resource.
52-
53-
8. Write **AzureDiagnostics** as a query and click **Run** to view recent events.
54-
55-
9. If there are results, look for `OperationName`, `ResultType`, `ResultSignature`, and `ResultDescription` (error message) to get more detail on the error.
15+
Provisioning issues for IoT devices can be difficult to troubleshoot because there are many possible points of failures such as attestation failures, registration failures, etc. To learn more about using Azure Monitor with DPS, see [Monitor Azure IoT Hub Device Provisioning Service](monitor-iot-dps.md).
5616

5717
## Common error codes
5818

‎articles/iot-dps/monitor-iot-dps-reference.md

Lines changed: 41 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,52 @@
11
---
2-
title: Monitoring DPS data reference
3-
titleSuffix: Azure IoT Hub Device Provisioning Service
4-
description: Important reference material needed when you monitor Azure IoT Hub Device Provisioning Service using Azure Monitor
5-
author: kgremban
6-
2+
title: Monitoring Device Provisioning Service data reference
3+
description: This article contains important reference material you need when you monitor Azure IoT Hub Device Provisioning Service.
4+
ms.date: 06/28/2024
5+
ms.custom: horz-monitor, subject-monitoring
76
ms.topic: reference
7+
author: kgremban
88
ms.author: kgremban
99
ms.service: iot-dps
10-
ms.custom: subject-monitoring
11-
ms.date: 04/15/2022
1210
---
1311

14-
# Monitoring Azure IoT Hub Device Provisioning Service data reference
12+
# Azure IoT Hub Device Provisioning Service monitoring data reference
1513

16-
See [Monitoring Iot Hub Device Provisioning Service](monitor-iot-dps.md) for details on collecting and analyzing monitoring data for Azure IoT Hub Device Provisioning Service (DPS).
14+
[!INCLUDE [horz-monitor-ref-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
1715

18-
## Metrics
16+
See [Monitor Azure IoT Hub Device Provisioning Service](monitor-iot-dps.md) for details on the data you can collect for IoT Hub Device Provisioning Service and how to use it.
1917

20-
This section lists all the automatically collected platform metrics collected for DPS.
18+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
2119

22-
Resource Provider and Type: [Microsoft.Devices/provisioningServices](/azure/azure-monitor/platform/metrics-supported#microsoftdevicesprovisioningservices).
20+
### Supported metrics for Microsoft.Devices/provisioningServices
2321

24-
|Metric|Exportable via Diagnostic Settings?|Metric Display Name|Unit|Aggregation Type|Description|Dimensions|
25-
|---|---|---|---|---|---|---|
26-
|AttestationAttempts|Yes|Attestation attempts|Count|Total|Number of device attestations attempted|ProvisioningServiceName, Status, Protocol|
27-
|DeviceAssignments|Yes|Devices assigned|Count|Total|Number of devices assigned to an IoT hub|ProvisioningServiceName, IotHubName|
28-
|RegistrationAttempts|Yes|Registration attempts|Count|Total|Number of device registrations attempted|ProvisioningServiceName, IotHubName, Status|
22+
The following table lists the metrics available for the Microsoft.Devices/provisioningServices resource type.
2923

30-
For more information, see a list of [all platform metrics supported in Azure Monitor](/azure/azure-monitor/platform/metrics-supported).
24+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
25+
[!INCLUDE [Microsoft.Devices/provisioningServices](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-devices-provisioningservices-metrics-include.md)]
3126

32-
## Metric dimensions
27+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
3328

34-
DPS has the following dimensions associated with its metrics.
29+
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
3530

36-
| Dimension Name | Description |
37-
| ------------------- | ----------------- |
38-
| IotHubName | The name of the target IoT hub. |
39-
| Protocol | The device or service protocol used. |
40-
| ProvisioningServiceName | The name of the DPS instance. |
41-
| Status | The status of the operation. |
31+
| Dimension Name | Description |
32+
|:------------------------|:-------------------------------------|
33+
| IotHubName | The name of the target IoT hub. |
34+
| Protocol | The device or service protocol used. |
35+
| ProvisioningServiceName | The name of the DPS instance. |
36+
| Status | The status of the operation. |
4237

4338
For more information on what metric dimensions are, see [Multi-dimensional metrics](/azure/azure-monitor/platform/data-platform-metrics#multi-dimensional-metrics).
4439

45-
## Resource logs
40+
[!INCLUDE [horz-monitor-ref-resource-logs](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
4641

47-
This section lists the types of resource logs you can collect for DPS.
42+
### Supported resource logs for Microsoft.Devices/provisioningServices
4843

49-
Resource Provider and Type: [Microsoft.Devices/provisioningServices](../azure-monitor/essentials/resource-logs-categories.md#microsoftdevicesprovisioningservices).
44+
[!INCLUDE [Microsoft.Devices/provisioningServices](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-devices-provisioningservices-logs-include.md)]
5045

51-
| Category | Description |
52-
|:---------|------------------|
53-
| DeviceOperations | Logs related to device attestation events. See device APIs listed in [Billable service operations and pricing](about-iot-dps.md#billable-service-operations-and-pricing). |
54-
| ServiceOperations | Logs related to DPS service events. See DPS service APIs listed in [Billable service operations and pricing](about-iot-dps.md#billable-service-operations-and-pricing). |
46+
The following list provides additional information about the preceding logs:
47+
48+
- DeviceOperations: Logs related to device attestation events. See device APIs listed in [Billable service operations and pricing](about-iot-dps.md#billable-service-operations-and-pricing).
49+
- ServiceOperations: Logs related to DPS service events. See DPS service APIs listed in [Billable service operations and pricing](about-iot-dps.md#billable-service-operations-and-pricing).
5550

5651
For reference, see a list of [all resource logs category types supported in Azure Monitor](/azure/azure-monitor/platform/resource-logs-schema).
5752

@@ -67,11 +62,11 @@ DPS uses the [AzureDiagnostics](/azure/azure-monitor/reference/tables/azurediagn
6762
| Level | Int | The logging severity of the event. For example, Information or Error. |
6863
| OperationName | String | The type of action performed during the event. For example: Query, Get, Upsert, and so on. |
6964
| OperationVersion | String | The API Version used during the event. |
70-
| Resource | String | The name forOF the resource where the event took place. For example, "MYEXAMPLEDPS". |
65+
| Resource | String | The name forOF the resource where the event took place. For example, `MYEXAMPLEDPS`. |
7166
| ResourceGroup | String | The name of the resource group where the resource is located. |
7267
| ResourceId | String | The Azure Resource Manager Resource ID for the resource where the event took place. |
73-
| ResourceProvider | String | The resource provider for the event. For example, "MICROSOFT.DEVICES". |
74-
| ResourceType | String | The resource type for the event. For example, "PROVISIONINGSERVICES". |
68+
| ResourceProvider | String | The resource provider for the event. For example, `MICROSOFT.DEVICES`. |
69+
| ResourceType | String | The resource type for the event. For example, `PROVISIONINGSERVICES`. |
7570
| ResultDescription | String | Error details for the event if unsuccessful. |
7671
| ResultSignature | String | HTTP status code for the event if unsuccessful. |
7772
| ResultType | String | Outcome of the event: Success, Failure, ClientError, and so on. |
@@ -146,18 +141,19 @@ The following JSON is an example of a successful add (`Upsert`) individual enrol
146141
}
147142
```
148143

149-
## Azure Monitor Logs tables
150-
151-
This section refers to all of the Azure Monitor Logs Kusto tables relevant to DPS and available for query by Log Analytics. For a list of these tables and links to more information for the DPS resource type, see [Device Provisioning Services](/azure/azure-monitor/reference/tables/tables-resourcetype#device-provisioning-services) in the Azure Monitor Logs table reference.
144+
[!INCLUDE [horz-monitor-ref-logs-tables](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
152145

153-
For a reference of all Azure Monitor Logs / Log Analytics tables, see the [Azure Monitor Log Table Reference](/azure/azure-monitor/reference/tables/tables-resourcetype).
146+
### IoT Hub Device Provisioning Service Microsoft.Devices/ProvisioningServices
154147

155-
## Activity log
148+
- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity#columns)
149+
- [AzureMetrics](/azure/azure-monitor/reference/tables/azuremetrics#columns)
150+
- [AzureDiagnostics](/azure/azure-monitor/reference/tables/azurediagnostics#columns)
156151

157-
For more information on the schema of Activity Log entries, see [Activity Log schema](../azure-monitor/essentials/activity-log-schema.md).
152+
[!INCLUDE [horz-monitor-ref-activity-log](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
158153

159-
## See Also
154+
- [Microsoft.Devices resource provider operations](/azure/role-based-access-control/resource-provider-operations#internet-of-things)
160155

161-
- See [Monitoring Azure IoT Hub Device Provisioning Service](monitor-iot-dps.md) for a description of monitoring Azure IoT Hub Device Provisioning Service.
156+
## Related content
162157

163-
- See [Monitoring Azure resources with Azure Monitor](../azure-monitor/essentials/monitor-azure-resource.md) for details on monitoring Azure resources.
158+
- See [Monitor Azure IoT Hub Device Provisioning Service](monitor-iot-dps.md) for a description of monitoring IoT Hub Device Provisioning Service.
159+
- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.

0 commit comments

Comments
 (0)