diff --git a/docs/integrations/microsoft-azure/azure-app-service-plan.md b/docs/integrations/microsoft-azure/azure-app-service-plan.md index cb81f9a9a9..f49976cdb3 100644 --- a/docs/integrations/microsoft-azure/azure-app-service-plan.md +++ b/docs/integrations/microsoft-azure/azure-app-service-plan.md @@ -14,7 +14,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; For Azure App Service Plan, you can collect the following metrics: -* **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. +- **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). + +- **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. ## Setup @@ -27,6 +29,28 @@ You must explicitly enable diagnostic settings for each Azure App Service plan y 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`. +### Configure metric rules + +#### Azure Observability Metadata Extraction Service Level + +If this rule already exists, there's no need to create it again. + +```sql +Rule Name: AzureObservabilityMetadataExtractionWebAppServerFarmLevel +``` + +```sql title="Metric match expression" +resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/SERVERFARMS/* tenant_name=* +``` + +| Fields extracted | Metric rule | +|:-----------------|:---------------| +| `subscription_id` | $resourceId._1 | +| `resource_group` | $resourceId._2 | +| `provider_name` | $resourceId._3 | +| `resource_type` | SERVERFARMS | +| `resource_name` | $resourceId._4 | + ### Configure metrics collection 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 1. Select `AllMetrics`. 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. -## Troubleshooting +### Configure logs collection + +#### Diagnostic logs + +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. + +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/). +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. + 1. Choose `Stream to an event hub` as the destination. + 1. Select `AllMetrics`. + 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.
Azure App Service Plan Tag Location +1. Tag the location field in the source with right location value.
Azure Storage Tag Location + +#### Activity logs (optional) + +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. + +## Installing the Azure App Service Plan app + +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. + +import AppInstall2 from '../../reuse/apps/app-install-v2.md'; + + + +## Viewing Azure App Service Plan dashboards + +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + + +### Overview + +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. + +Use this dashboard to: +* View recent resource and service health incidents. +* View distribution of service and resource health by incident type. + +Azure AppService Overview dashboard + +### Network + +The **Azure AppService - Network** dashboard offers comprehensive insights into the network performance and traffic for your Azure AppService. + +Use this dashboard to: +* Analyze network traffic patterns and performance metrics. +* Identify potential network issues affecting your applications. + +Azure AppService Network dashboard + +### Resource Utilisation + +The **Azure AppService - Resource Utilisation** dashboard provides a comprehensive view of the resource utilisation metrics and activities associated with your Azure AppService. + +Use this dashboard to: +* Monitor resource utilisation events and their impact on service availability. +* Analyze trends in operational performance over time. + +Azure AppService Resource Utilisation dashboard + +### Administrative Operations + +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. + +Use this dashboard to: +* Identify top users performing administrative operations. +* View Top 10 operations that caused the most errors. +* View recent read, write, and delete operations. + +Azure AppService Administrative Operations dashboard + +## Upgrading the Azure App Service Plan app (Optional) + +import AppUpdate from '../../reuse/apps/app-update.md'; + + + +## Uninstalling the Azure App Service Plan app (Optional) -### HTTP Logs and Metrics Source used by Azure Functions +import AppUninstall from '../../reuse/apps/app-uninstall.md'; -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). + diff --git a/static/img/integrations/microsoft-azure/Azure-App-Service-Plan-Configure-Diagnostic-Metrics.png b/static/img/integrations/microsoft-azure/Azure-App-Service-Plan-Configure-Diagnostic-Metrics.png new file mode 100644 index 0000000000..94722b700d Binary files /dev/null and b/static/img/integrations/microsoft-azure/Azure-App-Service-Plan-Configure-Diagnostic-Metrics.png differ