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/azure-resource-manager/management/monitor-resource-manager-reference.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
@@ -31,8 +31,8 @@ The following table lists the metrics available for the microsoft.resources/subs
31
31
32
32
| Dimension name | Description |
33
33
|:-------------- |:----------- |
34
-
| IsCustomerOriginated |
35
-
| Microsoft.SubscriptionId |
34
+
| IsCustomerOriginated ||
35
+
| Microsoft.SubscriptionId ||
36
36
| Method | The HTTP method used in the request made to Azure Resource Manager. Possible values are: <br/>- GET<br/>- HEAD<br/>- PUT<br/>- POST<br/>- PATCH<br/>- DELETE |
37
37
| Namespace | The namespace for the Resource Provider, in all caps, like *MICROSOFT.COMPUTE*. |
38
38
| RequestRegion | The Azure Resource Manager region where your control plane requests land, like *EastUS2*. This region isn't the resource's location. |
Copy file name to clipboardExpand all lines: articles/azure-resource-manager/management/monitor-resource-manager.md
+18-35Lines changed: 18 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,48 +28,36 @@ For a list of available metrics for Resource Manager, see [Azure Resource Manage
28
28
29
29
When you create and manage resources in Azure, your requests are orchestrated through Azure's [control plane](./control-plane-and-data-plane.md), Azure Resource Manager. This article describes how to monitor the volume and latency of control plane requests made to Azure.
30
30
31
-
With these metrics, you can observe traffic and latency for control plane requests throughout your subscriptions. For example, you can now figure out when your requests have been throttled or failed by filtering for specific status codes by [examining throttled requests](#examining-throttled-requests) and [examining server errors](#examining-server-errors).
32
-
33
-
The metrics are available for up to three months (93 days) and only track synchronous requests. For a scenario like a VM creation, the metrics do not represent the performance or reliability of the long running asynchronous operation.
34
-
31
+
With these metrics, you can observe traffic and latency for control plane requests throughout your subscriptions. For example, you can now figure out when your requests have been throttled by [examining throttled requests](#examining-throttled-requests). Determine if they failed by filtering for specific status codes and [examining server errors](#examining-server-errors).
35
32
33
+
The metrics are available for up to three months (93 days) and only track synchronous requests. For a scenario like a virtual machine creation, the metrics don't represent the performance or reliability of the long running asynchronous operation.
36
34
37
35
## Accessing Azure Resource Manager metrics
38
36
39
-
You can access control plane metrics via the Azure Monitor REST APIs, SDKs, and the Azure portal (by selecting the "Azure Resource Manager" metric). For an overview on Azure Monitor, see [Azure Monitor Metrics](../../monitoring-and-diagnostics/monitoring-overview-metrics.md).
37
+
You can access control plane metrics by using the Azure Monitor REST APIs, SDKs, and the Azure portal by selecting the **Azure Resource Manager** metric. For an overview on Azure Monitor, see [Azure Monitor Metrics](../../azure-monitor/data-platform.md).
40
38
41
-
There is no opt-in or sign-up process to access control plane metrics.
39
+
There's no opt-in or sign-up process to access control plane metrics.
42
40
43
41
For guidance on how to retrieve a bearer token and make requests to Azure, see [Azure REST API reference](/rest/api/azure/#create-the-request).
44
42
45
43
## Metric definition
46
44
47
-
The definition for Azure Resource Manager metrics in Azure Monitor is only accessible through the 2017-12-01-preview API version. To retrieve the definition, you can run the following snippet, with your subscription ID replacing "00000000-0000-0000-0000-000000000000":
45
+
The definition for Azure Resource Manager metrics in Azure Monitor is only accessible through the 2017-12-01-preview API version. To retrieve the definition, you can run the following snippet. Replace `00000000-0000-0000-0000-000000000000` with your subscription ID.
48
46
49
47
```bash
50
48
curl --location --request GET 'https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.insights/metricDefinitions?api-version=2017-12-01-preview&metricnamespace=microsoft.resources/subscriptions' \
51
49
--header 'Authorization: bearer {{bearerToken}}'
52
50
```
53
51
54
-
This snippet returns the definition for the metrics schema. Notably, this schema includes the dimensions you can filter on with the Monitor API:
55
-
56
-
| Dimension Name | Description |
57
-
| ------------------- | ----------------- |
58
-
|**ResourceUri**| The full Resource ID for a particular resource. |
59
-
|**RequestRegion**| The Azure Resource Manager region where your control plane requests land, like "EastUS2". This region is not the resource's location. |
60
-
|**StatusCode**| Response type from Azure Resource Manager for your control plane request. Possible values are (but not limited to): <br/>- 0<br/>- 200<br/>- 201<br/>- 400<br/>- 404<br/>- 429<br/>- 500<br/>- 502|
61
-
|**StatusCodeClass**| The class for the status code returned from Azure Resource Manager. Possible values are: <br/>- 2xx<br/>- 4xx<br/>- 5xx|
62
-
|**Namespace**| The namespace for the Resource Provider, in all caps, like "MICROSOFT.COMPUTE"|
63
-
|**ResourceType**| Any resource type in Azure that you have created or sent a request to, in all caps, like "VIRTUALMACHINES" |
64
-
|**Method**| The HTTP method used in the request made to Azure Resource Manager. Possible values are: <br/>- GET<br/>- HEAD<br/>- PUT<br/>- POST<br/>- PATCH<br/>- DELETE|
52
+
This snippet returns the definition for the metrics schema. Notably, this schema includes [the dimensions you can filter on with the Monitor API](monitor-resrouce-manager-reference.md#metric-dimensions).
65
53
66
54
## Examples
67
55
68
-
Now, let's look at some scenarios that can help you exploring Azure Resource Manager metrics.
56
+
Here are some scenarios that can help you explore Azure Resource Manager metrics.
69
57
70
-
### Query traffic and latency control plane metrics via Azure portal
58
+
### Query traffic and latency control plane metrics with Azure portal
71
59
72
-
First, navigate to the Azure Monitor blade within the [portal](https://portal.azure.com):
60
+
First, navigate to the Azure Monitor page within the [portal](https://portal.azure.com):
73
61
74
62
:::image type="content" source="./media/view-arm-monitor-metrics/explore-metrics-portal.png" alt-text="Screenshot of navigating to the Azure portal's Monitor page with Explore Metrics highlighted.":::
75
63
@@ -81,16 +69,16 @@ Then, after selecting **Apply**, you can visualize your Traffic or Latency contr
81
69
82
70
:::image type="content" source="./media/view-arm-monitor-metrics/arm-metrics-view.png" alt-text="Screenshot of the metrics visualization in the Azure portal, showing options to filter and split by dimensions.":::
83
71
84
-
### Query traffic and latency control plane metrics via REST API
72
+
### Query traffic and latency control plane metrics with REST API
85
73
86
-
After you are authenticated with Azure, you can make a request to retrieve control plane metrics for your subscription. In the script, replace "00000000-0000-0000-0000-000000000000" with your subscription ID. The script will retrieve the average request latency (in seconds) and the total request count for the two day timespan, broken down by one day intervals:
74
+
After you authenticate with Azure, you can make a request to retrieve control plane metrics for your subscription. In the script, replace `00000000-0000-0000-0000-000000000000` with your subscription ID. The script retrieves the average request latency, in seconds, and the total request count for the two day timespan, broken down by one day intervals:
87
75
88
76
```bash
89
77
curl --location --request GET "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.insights/metrics?api-version=2021-05-01&interval=P1D&metricnames=Latency&metricnamespace=microsoft.resources/subscriptions®ion=global&aggregation=average,count×pan=2021-11-01T00:00:00Z/2021-11-03T00:00:00Z" \
90
78
--header "Authorization: bearer {{bearerToken}}"
91
79
```
92
80
93
-
In the case of Azure Resource Manager metrics, you can retrieve the traffic count by using the Latency metric and including the 'count' aggregation. You'll see a JSON response for the request:
81
+
For Azure Resource Manager metrics, you can retrieve the traffic count by using the Latency metric and including the 'count' aggregation. You see a JSON response for the request:
94
82
95
83
```Json
96
84
{
@@ -132,7 +120,7 @@ In the case of Azure Resource Manager metrics, you can retrieve the traffic coun
132
120
}
133
121
```
134
122
135
-
If you want to retrieve only the traffic count, then you can utilize the Traffic metric with the 'count' aggregation:
123
+
If you want to retrieve only the traffic count, then you can use the Traffic metric with the `count` aggregation:
136
124
137
125
```bash
138
126
curl --location --request GET 'https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.insights/metrics?api-version=2021-05-01&interval=P1D&metricnames=Traffic&metricnamespace=microsoft.resources/subscriptions®ion=global&aggregation=count×pan=2021-11-01T00:00:00Z/2021-11-03T00:00:00Z' \
@@ -179,13 +167,13 @@ The response for the request is:
179
167
}
180
168
```
181
169
182
-
For the metrics supporting dimensions, you need to specify the dimension value to see the corresponding metrics values. For example, if you want to focus on the **Latency** for successful requests to ARM, you need to filter the **StatusCodeClass** dimension with **2XX**.
170
+
For the metrics supporting dimensions, you need to specify the dimension value to see the corresponding metrics values. For example, if you want to focus on the **Latency** for successful requests to Resource Manager, you need to filter the **StatusCodeClass** dimension with **2XX**.
183
171
184
172
If you want to look at the number of requests made in your subscription for Networking resources, like Virtual Networks and Load Balancers, you would need to filter the **Namespace** dimension for **MICROSOFT.NETWORK**.
185
173
186
174
### Examining Throttled Requests
187
175
188
-
To view only your throttled requests, you need to filter for 429 status code responses only. For REST API calls, filtering is accomplished via the [$filter property](/rest/api/monitor/Metrics/List#uri-parameters) and the StatusCode dimension by appending: $filter=StatusCode eq '429' as seen at the end of the request in the following snippet:
176
+
To view only your throttled requests, you need to filter for 429 status code responses only. For REST API calls, filtering is accomplished by using the [$filter property](/rest/api/monitor/Metrics/List#uri-parameters) and the StatusCode dimension by appending: `$filter=StatusCode eq '429'` as seen at the end of the request in the following snippet:
189
177
190
178
```bash
191
179
curl --location --request GET 'https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.insights/metrics?api-version=2021-05-01&interval=P1D&metricnames=Latency&metricnamespace=microsoft.resources/subscriptions®ion=global&aggregation=count,average×pan=2021-11-01T00:00:00Z/2021-11-03T00:00:00Z&$filter=StatusCode%20eq%20%27429%27' \
@@ -198,14 +186,14 @@ You can also filter directly in portal:
198
186
199
187
### Examining Server Errors
200
188
201
-
Similar to looking at throttled requests, you view *all* requests that returned a server error response code by filtering 5xx responses only. For REST API calls, filtering is accomplished via the [$filter property](/rest/api/monitor/Metrics/List#uri-parameters) and the StatusCodeClass dimension by appending: $filter=StatusCodeClass eq '5xx' as seen at the end of the request in the following snippet:
189
+
Similar to looking at throttled requests, you view *all* requests that returned a server error response code by filtering 5xx responses only. For REST API calls, filtering is accomplished by using the [$filter property](/rest/api/monitor/Metrics/List#uri-parameters) and the StatusCodeClass dimension by appending: $filter=StatusCodeClass eq '5xx' as seen at the end of the request in the following snippet:
202
190
203
191
```bash
204
192
curl --location --request GET 'https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.insights/metrics?api-version=2021-05-01&interval=P1D&metricnames=Latency&metricnamespace=microsoft.resources/subscriptions®ion=global&aggregation=count,average×pan=2021-11-01T00:00:00Z/2021-11-03T00:00:00Z&$filter=StatusCodeClass%20eq%20%275xx%27' \
205
193
--header 'Authorization: bearer {{bearerToken}}'
206
194
```
207
195
208
-
You can also accomplish generic server errors filtering within portal by setting the filter property to 'StatusCodeClass' and the value to '5xx', similar to what was done in the throttling example.
196
+
You can also accomplish generic server errors filtering within portal by setting the filter property to `StatusCodeClass` and the value to `5xx`, similar to what was done in the throttling example.
@@ -236,12 +224,7 @@ If your service uses any non-Azure Monitor based metrics, add the following incl
236
224
237
225
### Resource Manager alert rules
238
226
239
-
The following table lists some suggested alert rules for Resource Manager. These alerts are just examples. You can set alerts for any metric, log entry, or activity log entry listed in the [Azure Resource Manager monitoring data reference](monitor-resource-manager-reference.md).
240
-
241
-
| Alert type | Condition | Description |
242
-
|:---|:---|:---|
243
-
||||
244
-
||||
227
+
You can set alerts for any metric, log entry, or activity log entry listed in the [Azure Resource Manager monitoring data reference](monitor-resource-manager-reference.md).
0 commit comments