diff --git a/docs/integrations/microsoft-azure/azure-api-management.md b/docs/integrations/microsoft-azure/azure-api-management.md index 9b2a927b48..5922bbc4c2 100644 --- a/docs/integrations/microsoft-azure/azure-api-management.md +++ b/docs/integrations/microsoft-azure/azure-api-management.md @@ -24,123 +24,16 @@ For Azure API Management, you can collect the following logs and metrics: Azure service sends monitoring data to Azure Monitor, which can then [stream data to Eventhub](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/stream-monitoring-data-event-hubs). Sumo Logic supports: * Logs collection from [Azure Monitor](https://docs.microsoft.com/en-us/azure/monitoring-and-diagnostics/monitoring-get-started) using our [Azure Event Hubs source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/). -* Metrics collection using our [HTTP Logs and Metrics source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/) via Azure Functions deployed using the ARM template. +* Metrics collection using our [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source). You must explicitly enable diagnostic settings for each Azure API Management service you want to monitor. You can forward logs to the same Event Hub provided they satisfy the limitations and permissions as described [here](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#destination-limitations). 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/APIManagement/Logs`, `Azure/APIManagement/Metrics`. -### Configure field in field schema - -1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**. -1. Search for the following fields: - - `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name). - - `location`. The region to which the resource name belongs to. - - `subscription_id`. ID associated with a subscription where the resource is present. - - `resource_group`. The resource group name where the Azure resource is present. - - `provider_name`. Azure resource provider name (for example, Microsoft.Network). - - `resource_type`. Azure resource type (for example, storage accounts). - - `resource_name`. The name of the resource (for example, storage account name). - - `service_type`. Type of the service that can be accessed with a Azure resource. - - `service_name`. Services that can be accessed with an Azure resource (for example, in Azure API Management service is Subscriptions). -1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields). - -### Configure field extraction rules - -Create the following Field Extraction Rule(s) (FER) for Azure Storage by following the instructions in [Create a Field Extraction Rule](/docs/manage/field-extractions/create-field-extraction-rule/). - -#### Azure location extraction FER - - ```sql - Rule Name: AzureLocationExtractionFER - Applied at: Ingest Time - Scope (Specific Data): tenant_name=* - ``` - - ```sql title="Parse Expression" - json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop - | replace(toLowerCase(resourceLocation), " ", "") as resourceLocation - | if (!isBlank(resourceLocation), resourceLocation, location) as location - | if (!isBlank(service_region), service_region, location) as location - | if (isBlank(location), "global", location) as location - | fields location - ``` - -#### Resource ID extraction FER - - ```sql - Rule Name: AzureResourceIdExtractionFER - Applied at: Ingest Time - Scope (Specific Data): tenant_name=* - ``` - - ```sql title="Parse Expression" - json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop - | if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId - | toUpperCase(resourceId) as resourceId - | parse regex field=resourceId "/SUBSCRIPTIONS/(?[^/]+)" nodrop - | parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop - | parse regex field=resourceId "/PROVIDERS/(?[^/]+)" nodrop - | parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?[^/]+)/(?.+)" nodrop - | parse regex field=resource_name "(?[^/]+)(?:/PROVIDERS/[^/]+)?/(?[^/]+)/?(?.+)" nodrop - | if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name - | fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name - ``` - -### Configure metric rules - -Create the following metrics rules by following the instructions in [Create a metrics rule](/docs/metrics/metric-rules-editor/#create-a-metrics-rule). - -#### Azure observability metadata extraction service level - -If this rule already exists, there is no need to create it again. - - ```sql - Rule Name: AzureObservabilityMetadataExtractionServiceLevel - ``` - - ```sql title="Metric match expression" - resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/*/*/*/* tenant_name=* - ``` - | Fields extracted | Metric rule | - |------------------|----------------| - | subscription_id | $resourceId._1 | - | resource_group | $resourceId._2 | - | provider_name | $resourceId._3 | - | resource_type | $resourceId._4 | - | resource_name | $resourceId._5 | - | service_type | $resourceId._6 | - | service_name | $resourceId._7 | - -#### Azure observability metadata extraction Azure API management level - - ```sql - Rule Name: AzureObservabilityMetadataExtractionAzureAPIManagementLevel - ``` - - ```sql title="Metric match expression" - resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.APIMANAGEMENT/SERVICE/* tenant_name=* - ``` - | Fields extracted | Metric rule | - |:------------------|:------------------------| - | subscription_id | $resourceId._1 | - | resource_group | $resourceId._2 | - | provider_name | MICROSOFT.APIMANAGEMENT | - | resource_type | SERVICE | - | resource_name | $resourceId._3 | - ### 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. +To set up the Azure Metrics source in Sumo Logic, refer to [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source). -1. Create a hosted collector and tag the `tenant_name` field. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name).
Azure Tag Tenant Name -1. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source). -1. [Configure and deploy the ARM Template](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-2-configure-azure-resources-using-arm-template). -1. [Export metrics to Event Hub](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-3-export-metrics-for-a-particular-resource-to-event-hub). Perform below steps for each Azure API Management that you want to monitor. - 1. Choose `Stream to an event hub` as destination. - 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.
Azure API management metrics -1. Tag the location field in the source with right location value.
Azure API Management Tag Location :::note In the v2 service tiers, API Management has replaced the capacity metric with separate CPU and memory utilization metrics @@ -179,15 +72,27 @@ For Security events, make sure you enable [Microsoft Defender for Cloud](https:/ Now that you have set up data collection, install the Azure API Management Sumo Logic app to use the pre-configured dashboards that provide visibility into your environment for real-time analysis of overall usage. -import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2.md'; +import AppInstallIndexV2 from '../../reuse/apps/app-install-index-option.md'; - + + +As part of the app installation process, the following fields will be created by default: + +- `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions [here](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name). +- `location`. The region the resource name belongs to. +- `subscription_id`. ID associated with a subscription where the resource is present. +- `resource_group`. The resource group name where the Azure resource is present. +- `provider_name`. Azure resource provider name (for example, Microsoft.Network). +- `resource_type`. Azure resource type (for example, storage accounts). +- `resource_name`. The name of the resource (for example, storage account name). +- `service_type`. The type of service that can be accessed with an Azure resource. +- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances, the service is Subscriptions). ## Viewing the Azure API Management dashboards -import ViewDashboards from '../../reuse/apps/view-dashboards.md'; +import ViewDashboardsIndex from '../../reuse/apps/view-dashboards-index.md'; - + ### Administrative Operations @@ -231,6 +136,26 @@ The **Azure API Management - Subscriptions** dashboard provides details like Tot Azure API Management - Overview + +## Create monitors for Azure API Management App + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + + +### Azure API Management Alerts + +These alerts are metrics-based and will work for all Azure API Management. + +| Name | Description | Alert Condition | Recover Condition | +|:--|:--|:--|:--| +| `Azure API Management - High Capacity Utilization` | This alert is triggered when average capacity utilization percentage greater than 80. Also, a warning type alert will be triggered when average capacity utilization percentage greater than 70. | Count > 80 | Count < = 80 | +| `Azure API Management - High Duration of Backend Requests` | This alert is triggered when average duration of backend requests greater than 2000ms. Also, a warning type alert will be triggered when average duration of backend requests greater than 1000ms. | Count > 2000 | Count < = 2000 | +| `Azure API Management - High Gateway Client Errors (4xx)` | This alert is triggered when count of gateway requests resulting in a 4xx client error greater than 10. | Count > 10 | Count < = 10 | +| `Azure API Management - High Gateway Server Errors (5xx)` | This alert is triggered when count of gateway requests resulting in a 5xx server error greater than 5. | Count > 5 | Count < = 5 | +| `Azure API Management - High Overall Duration of Gateway Requests` | This alert is triggered when average overall duration of gateway requests greater than 3000ms. Also, a warning type alert will be triggered when average overall duration of gateway requests greater than 1500ms. | Count > 3000 | Count < = 3000 | + + ## Upgrade/Downgrade the Azure API Management app (optional) import AppUpdate from '../../reuse/apps/app-update.md';