You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/iot-dps/how-to-troubleshoot-dps.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ manager: nberdy
6
6
ms.service: iot-dps
7
7
services: iot-dps
8
8
ms.topic: conceptual
9
-
ms.date: 04/13/2022
9
+
ms.date: 04/15/2022
10
10
ms.author: xujing
11
11
#Customer intent: As an operator for Azure IoT Hub DPS, I need to know how to find out when devices are disconnecting unexpectedly and troubleshoot resolve those issues right away.
12
12
---
@@ -17,7 +17,7 @@ Connectivity issues for IoT devices can be difficult to troubleshoot because the
17
17
18
18
## Using Azure Monitor to view metrics and set up alerts
19
19
20
-
To view and set up alerts on IoT Hub Device Provisioning Service metrics.
20
+
To view and set up alerts on IoT Hub Device Provisioning Service metrics:
21
21
22
22
1. Sign in to the [Azure portal](https://portal.azure.com).
Copy file name to clipboardExpand all lines: articles/iot-dps/monitor-iot-dps-reference.md
+1-25Lines changed: 1 addition & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,29 +6,15 @@ ms.topic: reference
6
6
ms.author: kgremban
7
7
ms.service: iot-dps
8
8
ms.custom: subject-monitoring
9
-
ms.date: 03/29/2022
9
+
ms.date: 04/15/2022
10
10
---
11
-
<!-- VERSION 2.3
12
-
Template for monitoring data reference article for Azure services. This article is support for the main "Monitoring [servicename]" article for the service. -->
13
-
14
-
<!-- IMPORTANT STEP 1. Do a search and replace of [TODO-replace-with-service-name] with the name of your service. That will make the template easier to read -->
15
11
16
12
# Monitoring Azure IoT Hub Device Provisioning Service data reference
17
13
18
14
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).
19
15
20
16
## Metrics
21
17
22
-
<!-- REQUIRED if you support Metrics. If you don't, keep the section but call that out. Some services are only onboarded to logs.
23
-
<!-- Please keep headings in this order -->
24
-
25
-
<!-- 2 options here depending on the level of extra content you have. -->
26
-
27
-
<!-- OPTION 1 - Minimum - Link to relevant bookmarks in https://docs.microsoft.com/azure/azure-monitor/platform/metrics-supported, which is auto generated from underlying systems. Not all metrics are published depending on whether your product group wants them to be. If the metric is published, but descriptions are wrong of missing, contact your PM and tell them to update them in the Azure Monitor "shoebox" manifest. If this article is missing metrics that you and the PM know are available, both of you contact [email protected].
28
-
-->
29
-
30
-
<!-- Example format. There should be AT LEAST one Resource Provider/Resource Type here. -->
31
-
32
18
This section lists all the automatically collected platform metrics collected for DPS.
33
19
34
20
Resource Provider and Type: [Microsoft.Devices/provisioningServices](/azure/azure-monitor/platform/metrics-supported#microsoftdevicesprovisioningservices).
@@ -39,16 +25,10 @@ Resource Provider and Type: [Microsoft.Devices/provisioningServices](/azure/azur
39
25
|DeviceAssignments|Yes|Devices assigned|Count|Total|Number of devices assigned to an IoT hub|ProvisioningServiceName, IotHubName|
40
26
|RegistrationAttempts|Yes|Registration attempts|Count|Total|Number of device registrations attempted|ProvisioningServiceName, IotHubName, Status|
41
27
42
-
<!-- Add additional explanation of reference information as needed here. Link to other articles such as your Monitor [servicename] article as appropriate. -->
43
-
44
-
<!-- Keep this text as-is -->
45
28
For more information, see a list of [all platform metrics supported in Azure Monitor](/azure/azure-monitor/platform/metrics-supported).
46
29
47
30
## Metric Dimensions
48
31
49
-
<!-- REQUIRED. Please keep headings in this order -->
50
-
<!-- If you have metrics with dimensions, outline it here. If you have no dimensions, say so. Questions email [email protected]-->
51
-
52
32
DPS has the following dimensions associated with its metrics.
53
33
54
34
| Dimension Name | Description |
@@ -61,7 +41,6 @@ DPS has the following dimensions associated with its metrics.
61
41
For more information on what metric dimensions are, see [Multi-dimensional metrics](/azure/azure-monitor/platform/data-platform-metrics#multi-dimensional-metrics).
62
42
63
43
## Resource logs
64
-
<!-- REQUIRED. Please keep headings in this order -->
65
44
66
45
This section lists the types of resource logs you can collect for DPS.
67
46
@@ -166,20 +145,17 @@ The following JSON is an example of a successful add (`Upsert`) individual enrol
166
145
```
167
146
168
147
## Azure Monitor Logs tables
169
-
<!-- REQUIRED. Please keep heading in this order -->
170
148
171
149
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.
172
150
173
151
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).
174
152
175
153
## Activity log
176
-
<!-- REQUIRED. Please keep heading in this order -->
177
154
178
155
For more information on the schema of Activity Log entries, see [Activity Log schema](/azure/azure-monitor/essentials/activity-log-schema).
179
156
180
157
## See Also
181
158
182
-
<!-- replace below with the proper link to your main monitoring service article -->
183
159
- See [Monitoring Azure IoT Hub Device Provisioning Service](monitor-iot-dps.md) for a description of monitoring Azure IoT Hub Device Provisioning Service.
184
160
185
161
- See [Monitoring Azure resources with Azure Monitor](/azure/azure-monitor/insights/monitor-azure-resources) for details on monitoring Azure resources.
Copy file name to clipboardExpand all lines: articles/iot-dps/monitor-iot-dps.md
+1-55Lines changed: 1 addition & 55 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,48 +6,27 @@ ms.author: kgremban
6
6
ms.topic: conceptual
7
7
ms.service: iot-dps
8
8
ms.custom: subject-monitoring
9
-
ms.date: 03/29/2022
9
+
ms.date: 04/15/2022
10
10
---
11
11
12
-
<!-- VERSION 2.2
13
-
Template for the main monitoring article for Azure services.
14
-
Keep the required sections and add/modify any content for any information specific to your service.
15
-
This article should be in your TOC with the name *monitor-[TODO-replace-with-service-name].md* and the TOC title "Monitor [TODO-replace-with-service-name]".
16
-
Put accompanying reference information into an article in the Reference section of your TOC with the name *monitor-[service-name]-reference.md* and the TOC title "Monitoring data".
17
-
Keep the headings in this order.
18
-
-->
19
-
20
-
<!-- IMPORTANT STEP 1. Do a search and replace of [TODO-replace-with-service-name] with the name of your service. That will make the template easier to read -->
21
-
22
12
# Monitoring Azure IoT Hub Device Provisioning Service
23
-
<!-- REQUIRED. Please keep headings in this order -->
24
-
<!-- Most services can use this section unchanged. Add to it if there are any unique charges if your service has significant monitoring beyond Azure Monitor. -->
25
13
26
14
When you have critical applications and business processes relying on Azure resources, you want to monitor those resources for their availability, performance, and operation.
27
15
28
16
This article describes the monitoring data generated by Azure IoT Hub Device Provisioning Service (DPS). DPS uses [Azure Monitor](/azure/azure-monitor/overview). If you are unfamiliar with the features of Azure Monitor common to all Azure services that use it, read [Monitoring Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource).
29
17
30
-
<!-- Optional diagram showing monitoring for your service. If you need help creating one, contact [email protected]-->
31
-
32
18
## Monitoring data
33
19
34
-
<!-- REQUIRED. Please keep headings in this order -->
35
20
DPS collects the same kinds of monitoring data as other Azure resources that are described in [Monitoring data from Azure resources](/azure/azure-monitor/essentials/monitor-azure-resource#monitoring-data-from-Azure-resources).
36
21
37
22
See [Monitoring Azure IoT Hub Device Provisioning Service data reference](monitor-iot-dps-reference.md) for detailed information on the metrics and logs created by DPS.
38
23
39
-
<!-- If your service has additional non-Azure Monitor monitoring data then outline and refer to that here. Also include that information in the data reference as appropriate. -->
40
-
41
24
## Collection and routing
42
25
43
-
<!-- REQUIRED. Please keep headings in this order -->
44
-
45
26
Platform metrics and the Activity log are collected and stored automatically, but can be routed to other locations by using a diagnostic setting.
46
27
47
28
Resource Logs are not collected and stored until you create a diagnostic setting and route them to one or more locations.
48
29
49
-
<!-- Include any additional information on collecting logs. The number of things that diagnostics settings control is expanding -->
50
-
51
30
In Azure portal, you can select **Diagnostic settings** under **Monitoring** on the left-pane of your DPS instance followed by **Add diagnostic setting** to create diagnostic settings scoped to the logs and platform metrics emitted by your instance.
52
31
53
32
The following screenshot shows a diagnostic setting for routing to a Log Analytics workspace.
@@ -56,33 +35,22 @@ The following screenshot shows a diagnostic setting for routing to a Log Analyti
56
35
57
36
See [Create diagnostic setting to collect platform logs and metrics in Azure](/azure/azure-monitor/platform/diagnostic-settings) for the detailed process for creating a diagnostic setting using the Azure portal, CLI, or PowerShell. When you create a diagnostic setting, you specify which categories of logs to collect. The categories for DPS are listed in [Resource logs in the Azure IoT Hub Device Provisioning Service monitoring data reference](monitor-iot-dps-reference.md#resource-logs).
58
37
59
-
<!-- OPTIONAL: Add specific examples of configuration for this service. For example, CLI and PowerShell commands for creating diagnostic setting. Ideally, customers should set up a policy to automatically turn on collection for services. Azure monitor has Resource Manager template examples you can point to. See https://docs.microsoft.com/azure/azure-monitor/samples/resource-manager-diagnostic-settings. Contact [email protected] if you have questions. -->
60
-
61
38
The metrics and logs you can collect are discussed in the following sections.
62
39
63
40
## Analyzing metrics
64
41
65
-
<!-- REQUIRED. Please keep headings in this order
66
-
If you don't support metrics, say so. Some services may be only onboarded to logs -->
67
-
68
42
You can analyze metrics for DPS with metrics from other Azure services using metrics explorer by opening **Metrics** from the **Azure Monitor** menu. See [Getting started with Azure Metrics Explorer](/azure/azure-monitor/essentials/metrics-getting-started) for details on using this tool.
69
43
70
44
In Azure portal, you can select **Metrics** under **Monitoring** on the left-pane of your DPS instance to open metrics explorer scoped, by default, to the platform metrics emitted by your instance:
71
45
72
46
:::image type="content" source="media/monitor-iot-dps/metrics-portal.png" alt-text="Screenshot showing the metrics explorer page for a DPS instance." border="true":::
73
47
74
-
<!-- Point to the list of metrics available in your monitor-service-reference article. -->
75
48
For a list of the platform metrics collected for DPS, see [Metrics in the Monitoring Azure IoT Hub Device Provisioning Service data reference](monitor-iot-dps-reference.md#metrics).
76
49
77
50
For reference, you can see a list of [all resource metrics supported in Azure Monitor](/azure/azure-monitor/essentials/metrics-supported).
78
51
79
-
<!-- Optional: Call out additional information to help your customers. For example, you can include additional information here about how to use metrics explorer specifically for your service. Remember that the UI is subject to change quite often so you will need to maintain these screenshots yourself if you add them in. -->
80
-
81
52
## Analyzing logs
82
53
83
-
<!-- REQUIRED. Please keep headings in this order
84
-
If you don't support resource logs, say so. Some services may be only onboarded to metrics and the activity log. -->
85
-
86
54
Data in Azure Monitor Logs is stored in tables where each table has its own set of unique properties.
87
55
88
56
To route data to Azure Monitor Logs, you must create a diagnostic setting to send resource logs or platform metrics to a Log Analytics workspace. To learn more, see [Collection and routing](#collection-and-routing).
@@ -96,7 +64,6 @@ In Azure portal, you can select **Logs** under **Monitoring** on the left-pane o
96
64
97
65
Run queries against the **AzureDiagnostics** table to see the resource logs collected for the diagnostic settings you've created for your DPS instance.
98
66
99
-
<!-- Put in a code section here. -->
100
67
```kusto
101
68
AzureDiagnostics
102
69
```
@@ -109,33 +76,12 @@ For a list of the types of resource logs collected for DPS, see [Resource logs i
109
76
110
77
For a list of the tables used by Azure Monitor Logs and queryable by Log Analytics, see [Azure Monitor Logs tables in the Monitoring Azure IoT Hub Device Provisioning Service data reference](monitor-iot-dps-reference.md#azure-monitor-logs-tables).
111
78
112
-
<!-- Optional: Call out additional information to help your customers. For example, you can include additional information here about log usage or what logs are most important. Remember that the UI is subject to change quite often so you will need to maintain these screenshots yourself if you add them in. -->
113
-
114
-
<!-- ### Sample Kusto queries -->
115
-
116
-
<!-- REQUIRED if you support logs. Please keep headings in this order -->
117
-
<!-- Add sample Log Analytics Kusto queries for your service. -->
118
-
119
-
<!--
120
-
> [!IMPORTANT]
121
-
> When you select **Logs** from the DPS menu, Log Analytics is opened with the query scope set to the current DPS instance. This means that log queries will only include data from that resource. If you want to run a query that includes data from other DPS instances or data from other Azure services, select **Logs** from the **Azure Monitor** menu. See [Log query scope and time range in Azure Monitor Log Analytics](/azure/azure-monitor/logs/scope) for details.
122
-
123
-
<!-- REQUIRED: Include queries that are helpful for figuring out the health and state of your service. Ideally, use some of these queries in the alerts section. It's possible that some of your queries may be in the Log Analytics UI (sample or example queries). Check if so. -->
124
-
<!-->
125
-
<!-- Put in a code section here. -->
126
-
127
79
## Alerts
128
80
129
-
<!-- SUGGESTED: Include useful alerts on metrics, logs, log conditions or activity log. Ask your PMs if you don't know.
130
-
This information is the BIGGEST request we get in Azure Monitor so do not avoid it long term. People don't know what to monitor for best results. Be prescriptive
131
-
-->
132
-
133
81
Azure Monitor alerts proactively notify you when important conditions are found in your monitoring data. They allow you to identify and address issues in your system before your customers notice them. You can set alerts on [metrics](/azure/azure-monitor/alerts/alerts-metric-overview), [logs](/azure/azure-monitor/alerts/alerts-unified-log), and the [activity log](/azure/azure-monitor/alerts/activity-log-alerts). Different types of alerts have benefits and drawbacks.
134
82
135
83
## Next steps
136
84
137
-
<!-- Add additional links. You can change the wording of these and add more if useful. -->
138
-
139
85
- See [Monitoring Azure IoT Hub Device Provisioning Service data reference](monitor-iot-dps-reference.md) for a reference of the metrics, logs, and other important values created by DPS.
140
86
141
87
- See [Monitoring Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.
0 commit comments