Skip to content

Commit ccf2c5f

Browse files
committed
change request
1 parent ac59a8a commit ccf2c5f

File tree

2 files changed

+63
-138
lines changed

2 files changed

+63
-138
lines changed

articles/app-service/monitor-app-service-reference.md

Lines changed: 62 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,24 @@
11
---
22
title: Azure App Service monitoring data reference
33
description: This article contains important reference material you need when you monitor Azure App Service.
4-
ms.date: 02/15/2024
4+
ms.date: 02/29/2024
55
ms.custom: horz-monitor
66
ms.topic: reference
77
author: msangapu-msft
88
ms.author: msangapu
99
ms.service: app-service
1010
---
1111

12-
<!--
13-
IMPORTANT
14-
To make this template easier to use, first:
15-
1. Search and replace App Service with the official name of your service.
16-
2. Search and replace app-service with the service name to use in GitHub filenames.-->
17-
18-
<!-- VERSION 3.0 2024_01_01
19-
For background about this template, see https://review.learn.microsoft.com/en-us/help/contribute/contribute-monitoring?branch=main -->
20-
21-
<!-- Most services can use the following sections unchanged. All headings are required unless otherwise noted.
22-
The sections use #included text you don't have to maintain, which changes when Azure Monitor functionality changes. Add info into the designated service-specific places if necessary. Remove #includes or template content that aren't relevant to your service.
23-
24-
At a minimum your service should have the following two articles:
25-
26-
1. The primary monitoring article (based on the template monitor-service-template.md)
27-
- Title: "Monitor App Service"
28-
- TOC title: "Monitor"
29-
- Filename: "monitor-app-service.md"
30-
31-
2. A reference article that lists all the metrics and logs for your service (based on this template).
32-
- Title: "App Service monitoring data reference"
33-
- TOC title: "Monitoring data reference"
34-
- Filename: "monitor-app-service-reference.md".
35-
-->
36-
3712
# Azure App Service monitoring data reference
3813

39-
<!-- Intro. Required. -->
4014
[!INCLUDE [horz-monitor-ref-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
4115

4216
See [Monitor Azure App Service](monitor-app-service.md) for details on the data you can collect for Azure App Service and how to use it.
4317

44-
<!-- ## Metrics. Required section. -->
4518
[!INCLUDE [horz-monitor-ref-metrics-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
4619

47-
<!-- Repeat the following section for each resource type/namespace in your service. -->
48-
### App Service metrics
20+
### Supported metrics for Microsoft.Web
4921

50-
<!-- Reviewers - I just linked here instead of including the tables, since linking was being done in the v2.3 template article. But looks like a few namespaces have been added, such as containerapps. I listed all namespaces under Midrosoft.Web and also corrected the links, which were broken -->
5122
This table lists all the automatically collected platform metrics for App Service.
5223

5324
|Metric Type | Resource Provider / Type Namespace<br/> and link to individual metrics |
@@ -61,44 +32,77 @@ This table lists all the automatically collected platform metrics for App Servic
6132
| App Service Environment Front-end | [Microsoft.Web/hostingEnvironments/multiRolePools](/azure/azure-monitor/reference/supported-metrics/microsoft-web-hostingenvironments-multirolepools-metrics)
6233
| App Service Environment Worker Pools | [Microsoft.Web/hostingEnvironments/workerPools](/azure/azure-monitor/reference/supported-metrics/microsoft-web-hostingenvironments-workerpools-metrics)
6334

64-
<!-- ### Supported metrics for Microsoft.Web/serverfarms
65-
The following table lists the metrics available for the Microsoft.Web/serverfarms resource type.
66-
<!-- For each ### section:
67-
1. Replace the <ResourceType/namespace> placeholder in the heading and introductory sentence. Example: ### Supported metrics for Microsoft.Storage/storageAccounts/blobServices
68-
2. Find the metrics for the resource type at https://learn.microsoft.com/azure/azure-monitor/reference/supported-metrics/metrics-index#supported-metrics-per-resource-type, which is autogenerated from underlying systems. Either link to the listed metrics page(s), OR #include the metrics table(s).
69-
3. Add any further information after each metric #include or link. -->
70-
71-
<!-- Use either the LINK or INCLUDE option and remove the other option.
72-
- LINK to metrics page. Example: - [Microsoft.Storage/storageAccounts/blobServices](/azure/azure-monitor/reference/supported-metrics/microsoft-storage-storageaccounts-blobservices-metrics)
73-
- OR INCLUDE metrics table, starting with the metrics tableheader:
74-
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
75-
<!-- Add the table. Select the link in the metrics index, and on the metric page, select Edit to see the #include link that pulls in the metrics table. Use that link to add the #include, with the following format:
76-
[!INCLUDE [<ResourceType>](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/<resource-type>-metrics-include.md)].
77-
Example #include: [!INCLUDE [Microsoft.Storage/storageAccounts/blobServices](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-storage-storageaccounts-blobservices-metrics-include.md)]
78-
79-
<!-- ## Metric dimensions. Required section. -->
35+
>[!NOTE]
36+
>Azure App Service, Functions, and Logic Apps share the [Microsoft.Web/sites](/azure/azure-monitor/reference/supported-metrics/microsoft-web-sites-metrics) namespace dating back to when they were a single service. Refer to the following lists or check the metric descriptions in the overall table to see which metrics apply to which services. The Azure portal **Metrics** interface shows only the metrics that apply to that service.
37+
38+
For an app, the available metrics are:
39+
40+
- Response Time
41+
- Average Response Time (deprecated)
42+
- Average memory working set
43+
- Connections
44+
- CPU Time
45+
- Current Assemblies
46+
- Data In
47+
- Data Out
48+
- File System Usage
49+
- Gen 0 Garbage Collections
50+
- Gen 1 Garbage Collections
51+
- Gen 2 Garbage Collections
52+
- Handle Count
53+
- Health Check Status
54+
- Http 2xx
55+
- Http 3xx
56+
- Http 401
57+
- Http 403
58+
- Http 404
59+
- Http 406
60+
- Http 4xx
61+
- Http Server Errors
62+
- IO Other Bytes Per Second
63+
- IO Other Operations Per Second
64+
- IO Read Bytes Per Second
65+
- IO Read Operations Per Second
66+
- IO Write Bytes Per Second
67+
- IO Write Operations Per Second
68+
- Memory working set
69+
- Private Bytes
70+
- Requests
71+
- Requests In Application Queue
72+
- Thread Count
73+
- Total App Domains
74+
- Total App Domains Unloaded
75+
76+
For an App Service plan, the available metrics are:
77+
78+
> [!NOTE]
79+
> App Service plan metrics are available only for plans in *Basic*, *Standard*, and *Premium* tiers.
80+
81+
- CPU Percentage
82+
- Memory Percentage
83+
- Data In
84+
- Data Out
85+
- Disk Queue Length
86+
- Http Queue Length
87+
88+
There are two metrics that reflect CPU usage:
89+
90+
- CPU Time
91+
- CPU percentage
92+
93+
Useful for apps hosted in Basic, Standard, and Premium plans, because they can be scaled out. CPU percentage is a good indication of the overall usage across all instances.
94+
8095
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
81-
<!-- Use one of the following includes, depending on whether you have metrics with dimensions.
82-
- If you have metrics with dimensions, use the following include and list the metrics with dimensions after the include. For an example, see https://learn.microsoft.com/azure/storage/common/monitor-storage-reference#metrics-dimensions. Questions: email [email protected].
83-
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
84-
<!-- If you DON'T have metrics with dimensions, use the following include: -->
8596
[!INCLUDE [horz-monitor-ref-no-metrics-dimensions](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-no-metrics-dimensions.md)]
8697

87-
<!-- ## Resource logs. Required section. -->
8898
[!INCLUDE [horz-monitor-ref-resource-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
8999

90-
<!-- Add at least one resource provider/resource type here. Example: ### Supported resource logs for Microsoft.Storage/storageAccounts/blobServices
91-
Repeat this section for each resource type/namespace in your service. -->
92100
### Supported resource logs for Microsoft.Web
93101

94102
- [Microsoft.Web/hostingEnvironments](/azure/azure-monitor/reference/supported-logs/microsoft-web-hostingenvironments-logs)
95103
- [Microsoft.Web/sites](/azure/azure-monitor/reference/supported-logs/microsoft-web-sites-logs)
96104
- [Microsoft.Web/sites/slots](/azure/azure-monitor/reference/supported-logs/microsoft-web-sites-slots-logs)
97105
- [Microsoft.Web/staticsites](/azure/azure-monitor/reference/supported-logs/microsoft-web-staticsites-logs)
98-
<!-- For each ### section, follow the same instructions as for the Metrics section, except find the resource logs for your service in the Log Categories column at https://learn.microsoft.com/azure/azure-monitor/reference/supported-logs/logs-index#supported-log-categories-per-resource-type, which is autogenerated from underlying systems.
99-
Link to or include the logs table. Example link:
100-
OR INCLUDE resource logs table using the following #include format: [!INCLUDE [<ResourceType>](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/<resource-type>-logs-include.md)].
101-
Example #include: [!INCLUDE [Microsoft.Storage/storageAccounts/blobServices](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-storage-storageaccounts-blobservices-logs-include.md)] -->
102106

103107
The following table lists more information about resource logs you can collect for App Service.
104108

@@ -116,16 +120,8 @@ The following table lists more information about resource logs you can collect f
116120

117121
<sup>1</sup> For Java SE apps, add "$WEBSITE_AZMON_PREVIEW_ENABLED" to the app settings and set it to 1 or to true.
118122

119-
<!-- ## Azure Monitor Logs tables. Required section. -->
120123
[!INCLUDE [horz-monitor-ref-logs-tables](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
121-
<!-- Find the table(s) for your service at https://learn.microsoft.com/azure/azure-monitor/reference/tables/tables-resourcetype. These files are auto generated from the REST API.
122-
NOTE: Also refer to https://learn.microsoft.com/azure/azure-monitor/reference/tables/azurediagnostics#azure-diagnostics-mode to see whether your service uses the AzureDiagnostics table in Azure Monitor Logs / Log Analytics.
123-
Link to the service-specific tables. If your service uses the AzureDiagnostics table, list the fields you use and what they're for. If your service uses both tables, list both types of information. Add any further information after each table link, such as descriptions and usage, or information not found in the tables. Example:
124-
### Storage Accounts
125-
Microsoft.Storage/storageAccounts
126-
- [StorageBlobLogs](/azure/azure-monitor/reference/tables/storagebloblogs) -->
127124
### App Services
128-
<!-- All up link: [Azure Monitor Logs table reference - App Service tables](/azure/azure-monitor/reference/tables/tables-resourcetype#app-services) -->
129125

130126
Microsoft.Web/sites
131127
- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity)
@@ -142,11 +138,7 @@ Microsoft.Web/sites
142138
- [AppServicePlatformLogs](/azure/azure-monitor/reference/tables/appserviceplatformlogs)
143139
- [AppServiceIPSecAuditLogs](/azure/azure-monitor/reference/tables/appserviceipsecauditlogs)
144140

145-
<!-- ## Activity log. Required section. -->
146141
[!INCLUDE [horz-monitor-ref-activity-log](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
147-
<!-- Refer to https://learn.microsoft.com/azure/role-based-access-control/resource-provider-operations and link to the possible operations for your service, using the format - [<Namespace> resource provider operations](https://learn.microsoft.com/azure/role-based-access-control/resource-provider-operations#<namespace>.
148-
Example: - [Microsoft.Storage resource provider operations](https://learn.microsoft.com/azure/role-based-access-control/resource-provider-operations#microsoftstorage.
149-
If there are other operations not in the link, list them here in table form. -->
150142

151143
The following table lists common activity log operations related to App Service. This list isn't exhaustive. For all Microsoft.Web resource provider operations, see [Microsoft.Web resource provider operations](/azure/role-based-access-control/resource-provider-operations#microsoftweb).
152144

@@ -170,10 +162,6 @@ The following table lists common activity log operations related to App Service.
170162
|Get Zipped Container Logs for Web App| Get container logs |
171163
|Restore Web App From Backup Blob| App restored from backup|
172164

173-
<!-- ## Other schemas. Optional section. Please keep heading in this order. If your service uses other schemas, add the following include and information.
174-
[!INCLUDE [horz-monitor-ref-other-schemas](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-other-schemas.md)]
175-
<!-- List other schemas and their usage here. These can be resource logs, alerts, event hub formats, etc. depending on what you think is important. You can put JSON messages, API responses not listed in the REST API docs, and other similar types of info here. -->
176-
177165
## Related content
178166

179167
- See [Monitor App Service](monitor-app-service.md) for a description of monitoring App Service.

articles/app-service/web-sites-monitor.md

Lines changed: 1 addition & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -64,70 +64,7 @@ You can increase or remove quotas from your app by upgrading your App Service pl
6464
6565
Metrics provide information about the app or the App Service plan's behavior.
6666

67-
For an app, the available metrics are:
68-
69-
| Metric | Description |
70-
| --- | --- |
71-
| **Response Time** | The time taken for the app to serve requests, in seconds. |
72-
| **Average Response Time (deprecated)** | The average time taken for the app to serve requests, in seconds. |
73-
| **Average memory working set** | The average amount of memory used by the app, in megabytes (MiB). |
74-
| **Connections** | The number of bound sockets existing in the sandbox (w3wp.exe and its child processes). A bound socket is created by calling bind()/connect() APIs and remains until said socket is closed with CloseHandle()/closesocket(). |
75-
| **CPU Time** | The amount of CPU consumed by the app, in seconds. For more information about this metric, see [CPU time vs CPU percentage](#cpu-time-vs-cpu-percentage). |
76-
| **Current Assemblies** | The current number of Assemblies loaded across all AppDomains in this application. |
77-
| **Data In** | The amount of incoming bandwidth consumed by the app, in MiB. |
78-
| **Data Out** | The amount of outgoing bandwidth consumed by the app, in MiB. |
79-
| **File System Usage** | The amount of usage in bytes by storage share. |
80-
| **Gen 0 Garbage Collections** | The number of times the generation 0 objects are garbage collected since the start of the app process. Higher generation GCs include all lower generation GCs.|
81-
| **Gen 1 Garbage Collections** | The number of times the generation 1 objects are garbage collected since the start of the app process. Higher generation GCs include all lower generation GCs.|
82-
| **Gen 2 Garbage Collections** | The number of times the generation 2 objects are garbage collected since the start of the app process.|
83-
| **Handle Count** | The total number of handles currently open by the app process.|
84-
| **Health Check Status** | The average health status across the application's instances in the App Service Plan.|
85-
| **Http 2xx** | The count of requests resulting in an HTTP status code ≥ 200 but < 300. |
86-
| **Http 3xx** | The count of requests resulting in an HTTP status code ≥ 300 but < 400. |
87-
| **Http 401** | The count of requests resulting in HTTP 401 status code. |
88-
| **Http 403** | The count of requests resulting in HTTP 403 status code. |
89-
| **Http 404** | The count of requests resulting in HTTP 404 status code. |
90-
| **Http 406** | The count of requests resulting in HTTP 406 status code. |
91-
| **Http 4xx** | The count of requests resulting in an HTTP status code ≥ 400 but < 500. |
92-
| **Http Server Errors** | The count of requests resulting in an HTTP status code ≥ 500 but < 600. |
93-
| **IO Other Bytes Per Second** | The rate at which the app process is issuing bytes to I/O operations that don't involve data, such as control operations.|
94-
| **IO Other Operations Per Second** | The rate at which the app process is issuing I/O operations that aren't read or write operations.|
95-
| **IO Read Bytes Per Second** | The rate at which the app process is reading bytes from I/O operations.|
96-
| **IO Read Operations Per Second** | The rate at which the app process is issuing read I/O operations.|
97-
| **IO Write Bytes Per Second** | The rate at which the app process is writing bytes to I/O operations.|
98-
| **IO Write Operations Per Second** | The rate at which the app process is issuing write I/O operations.|
99-
| **Memory working set** | The current amount of memory used by the app, in MiB. |
100-
| **Private Bytes** | Private Bytes is the current size, in bytes, of memory that the app process has allocated that can't be shared with other processes.|
101-
| **Requests** | The total number of requests regardless of their resulting HTTP status code. |
102-
| **Requests In Application Queue** | The number of requests in the application request queue.|
103-
| **Thread Count** | The number of threads currently active in the app process.|
104-
| **Total App Domains** | The current number of AppDomains loaded in this application.|
105-
| **Total App Domains Unloaded** | The total number of AppDomains unloaded since the start of the application.|
106-
107-
108-
For an App Service plan, the available metrics are:
109-
110-
> [!NOTE]
111-
> App Service plan metrics are available only for plans in *Basic*, *Standard*, and *Premium* tiers.
112-
>
113-
114-
| Metric | Description |
115-
| --- | --- |
116-
| **CPU Percentage** | The average CPU used across all instances of the plan. |
117-
| **Memory Percentage** | The average memory used across all instances of the plan. |
118-
| **Data In** | The average incoming bandwidth used across all instances of the plan. |
119-
| **Data Out** | The average outgoing bandwidth used across all instances of the plan. |
120-
| **Disk Queue Length** | The average number of both read and write requests that were queued on storage. A high disk queue length is an indication of an app that might be slowing down because of excessive disk I/O. |
121-
| **Http Queue Length** | The average number of HTTP requests that had to sit on the queue before being fulfilled. A high or increasing HTTP Queue length is a symptom of a plan under heavy load. |
122-
123-
### CPU time vs CPU percentage
124-
<!-- To do: Fix Anchor (#CPU-time-vs.-CPU-percentage) -->
125-
126-
There are two metrics that reflect CPU usage:
127-
128-
**CPU Time**: Useful for apps hosted in Free or Shared plans, because one of their quotas is defined in CPU minutes used by the app.
129-
130-
**CPU percentage**: Useful for apps hosted in Basic, Standard, and Premium plans, because they can be scaled out. CPU percentage is a good indication of the overall usage across all instances.
67+
For a list of the metrics that apply to apps and App Service plans, see [Supported metrics for Microsoft.Web](monitor-app-service-reference.md#supported-metrics-for-microsoft-web).
13168

13269
## Metrics granularity and retention policy
13370
Metrics for an app and app service plan are logged and aggregated by the service and [retained according to these rules](../azure-monitor/essentials/data-platform-metrics.md#retention-of-metrics).

0 commit comments

Comments
 (0)