Skip to content

Commit 254210a

Browse files
ankurch627jpipkin1
andcommitted
Azure web app server farm doc changes (#4684)
* initial commit * resolved r comments * minor changes * Updates from review --------- Co-authored-by: John Pipkin <[email protected]>
1 parent 5740bb2 commit 254210a

File tree

2 files changed

+106
-4
lines changed

2 files changed

+106
-4
lines changed

docs/integrations/microsoft-azure/azure-app-service-plan.md

Lines changed: 106 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1414

1515
For Azure App Service Plan, you can collect the following metrics:
1616

17-
* **Platform Metrics for Azure App Service Plan**. These metrics are available in [Microsoft.Web/serverfarms](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-web-serverfarms-metrics) namespace. For more information on supported metrics, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/app-service/web-sites-monitor#understand-metrics). App Service plan metrics are available only for plans in Basic, Standard, and Premium tiers.
17+
- **Activity logs**, provides insight into any subscription-level or management group level events that have occurred in the Azure. To learn more, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/activity-log-schema).
18+
19+
- **Platform Metrics for Azure App Service Plan**. These metrics are available in the [Microsoft.Web/serverfarms](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-web-serverfarms-metrics) namespace. For more information on supported metrics, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/app-service/web-sites-monitor#understand-metrics). App Service Plan metrics are available only for plans in Basic, Standard, Premium and Isolated tiers.
1820

1921
## Setup
2022

@@ -27,6 +29,28 @@ You must explicitly enable diagnostic settings for each Azure App Service plan y
2729

2830
When you configure the event hubs source or HTTP source, plan your source category to ease the querying process. A hierarchical approach allows you to make use of wildcards. For example: `Azure/AppServicePlan/Logs`, `Azure/AppServicePlan/Metrics`.
2931

32+
### Configure metric rules
33+
34+
#### Azure Observability Metadata Extraction Service Level
35+
36+
If this rule already exists, there's no need to create it again.
37+
38+
```sql
39+
Rule Name: AzureObservabilityMetadataExtractionWebAppServerFarmLevel
40+
```
41+
42+
```sql title="Metric match expression"
43+
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/SERVERFARMS/* tenant_name=*
44+
```
45+
46+
| Fields extracted | Metric rule |
47+
|:-----------------|:---------------|
48+
| `subscription_id` | $resourceId._1 |
49+
| `resource_group` | $resourceId._2 |
50+
| `provider_name` | $resourceId._3 |
51+
| `resource_type` | SERVERFARMS |
52+
| `resource_name` | $resourceId._4 |
53+
3054
### Configure metrics collection
3155
3256
In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, on to an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
@@ -38,8 +62,86 @@ In this section, you will configure a pipeline for shipping metrics from Azure M
3862
1. Select `AllMetrics`.
3963
1. Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name.
4064
41-
## Troubleshooting
65+
### Configure logs collection
66+
67+
#### Diagnostic logs
68+
69+
In this section, you will configure a pipeline for shipping diagnostic logs from [Azure Monitor](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-get-started) to an Event Hub.
70+
71+
1. To set up the Azure Event Hubs source in Sumo Logic, refer to [Azure Event Hubs Source for Logs](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
72+
1. To create the **Diagnostic setting** in the Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-gb/azure/data-factory/monitor-configure-diagnostics). Perform the below steps for each Azure Functions that you want to monitor.
73+
1. Choose `Stream to an event hub` as the destination.
74+
1. Select `AllMetrics`.
75+
1. Use the Event Hub namespace and Event Hub name configured in previous step in destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-App-Service-Plan-Configure-Diagnostic-Metrics.png')} alt="Azure App Service Plan Tag Location" style={{border: '1px solid gray'}} width="800" />
76+
1. Tag the location field in the source with right location value.<br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Storage Tag Location" style={{border: '1px solid gray'}} width="400" />
77+
78+
#### Activity logs (optional)
79+
80+
To collect activity logs, follow the instructions [here](/docs/integrations/microsoft-azure/audit). If you are already collecting activity logs for a subscription, do not perform this step.
81+
82+
## Installing the Azure App Service Plan app
83+
84+
This section provides instructions on how to install the Azure App Service Plan app, and shows examples of each of the preconfigured dashboards you can use to analyze your data.
85+
86+
import AppInstall2 from '../../reuse/apps/app-install-v2.md';
87+
88+
<AppInstall2/>
89+
90+
## Viewing Azure App Service Plan dashboards
91+
92+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
93+
94+
<ViewDashboards/>
95+
96+
### Overview
97+
98+
The **Azure AppService - Overview** dashboard provides comprehensive information of all the service health incidents or resource health events associated with Azure AppService in your azure account.
99+
100+
Use this dashboard to:
101+
* View recent resource and service health incidents.
102+
* View distribution of service and resource health by incident type.
103+
104+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-AppService/Azure-App-Service-Plan-Overview.png')} alt="Azure AppService Overview dashboard" style={{border: '1px solid gray'}} width="800" />
105+
106+
### Network
107+
108+
The **Azure AppService - Network** dashboard offers comprehensive insights into the network performance and traffic for your Azure AppService.
109+
110+
Use this dashboard to:
111+
* Analyze network traffic patterns and performance metrics.
112+
* Identify potential network issues affecting your applications.
113+
114+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-AppService/Azure-App-Service-Plan-Network.png')} alt="Azure AppService Network dashboard" style={{border: '1px solid gray'}} width="800" />
115+
116+
### Resource Utilisation
117+
118+
The **Azure AppService - Resource Utilisation** dashboard provides a comprehensive view of the resource utilisation metrics and activities associated with your Azure AppService.
119+
120+
Use this dashboard to:
121+
* Monitor resource utilisation events and their impact on service availability.
122+
* Analyze trends in operational performance over time.
123+
124+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-AppService/Azure-App-Service-Plan-Resource-Utilisation.png')} alt="Azure AppService Resource Utilisation dashboard" style={{border: '1px solid gray'}} width="800" />
125+
126+
### Administrative Operations
127+
128+
The **Azure AppService - Administrative Operations** dashboard provides details on read/write/delete specific changes, different operations used, top 10 operations that caused most errors, and users performing admin operations.
129+
130+
Use this dashboard to:
131+
* Identify top users performing administrative operations.
132+
* View Top 10 operations that caused the most errors.
133+
* View recent read, write, and delete operations.
134+
135+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Azure-AppService/Azure-App-Service-Plan-Administrative-Operations.png')} alt="Azure AppService Administrative Operations dashboard" style={{border: '1px solid gray'}} width="800" />
136+
137+
## Upgrading the Azure App Service Plan app (Optional)
138+
139+
import AppUpdate from '../../reuse/apps/app-update.md';
140+
141+
<AppUpdate/>
142+
143+
## Uninstalling the Azure App Service Plan app (Optional)
42144
43-
### HTTP Logs and Metrics Source used by Azure Functions
145+
import AppUninstall from '../../reuse/apps/app-uninstall.md';
44146
45-
To troubleshoot metrics collection, follow the instructions in [Collect Metrics from Azure Monitor > Troubleshooting metrics collection](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#troubleshooting-metrics-collection).
147+
<AppUninstall/>
106 KB
Loading

0 commit comments

Comments
 (0)