diff --git a/docs/integrations/microsoft-azure/azure-cache-for-redis.md b/docs/integrations/microsoft-azure/azure-cache-for-redis.md index 05244b7894..f9ea663520 100644 --- a/docs/integrations/microsoft-azure/azure-cache-for-redis.md +++ b/docs/integrations/microsoft-azure/azure-cache-for-redis.md @@ -15,6 +15,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; For Azure Cache for Redis, you can collect the following logs and metrics: * **Connection logs**. These logs contains information about the connections to the cache for security and diagnostic purposes. To learn more about the [limitations of connection logging](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-monitor-diagnostic-settings?tabs=basic-standard-premium#prerequisiteslimitations-of-connection-logging) and [schemas](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-monitor-diagnostic-settings?tabs=basic-standard-premium#contents-of-the-connection-logs) collected for Azure Cache for Redis, refer to the Azure documentation. +* **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). * **Cache Metrics**. These metrics are available in [Microsoft.Cache/redis](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-cache-redis-metrics) and [Microsoft.Cache/redisEnterprise](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-cache-redisenterprise-metrics) namespace. For more information on supported metrics, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-how-to-monitor#list-of-metrics). ## Setup @@ -22,32 +23,205 @@ For Azure Cache for Redis, 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/). +* Activity 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/). It is recommended to create a separate source for activity logs. If you are already collecting these logs, you can skip this step. * 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. You must explicitly enable diagnostic settings for each Azure Cache for Redis 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/RedisCache/Logs`, `Azure/RedisCache/Metrics`. +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/RedisCache/Logs` and `Azure/RedisCache/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 in the [Microsoft Documentation](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, Azure SQL databases in Azure SQL Server). +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 Rules (FER) for Azure Storage by following the instructions in the [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 redis cache level + +```sql +Rule Name: AzureObservabilityMetadataExtractionRedisCacheLevel +``` + +```sql title="Metric match expression" +resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/REDIS/* tenant_name=* +``` + +| Fields extracted | Metric rule | +|:------------------|:---------------| +| subscription_id | $resourceId._1 | +| resource_group | $resourceId._2 | +| provider_name | $resourceId._3 | +| resource_type | REDIS | +| resource_name | $resourceId._4 | + +```sql +Rule Name: AzureObservabilityMetadataExtractionEnterpriseRedisCacheLevel +``` + +```sql title="Metric match expression" +resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/REDISENTERPRISE/* tenant_name=* +``` + +| Fields extracted | Metric rule | +|:------------------|:------------------------| +| subscription_id | $resourceId._1 | +| resource_group | $resourceId._2 | +| provider_name | $resourceId._3 | +| resource_type | REDISENTERPRISE | +| 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. -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. Create hosted collector and tag tenant_name field.
Azure Tag Tenant Name +2. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source). 2. [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). -3. [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 Cache for Redis that you want to monitor. +3. [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 Redis Cache resource that you want to monitor. * Choose `Stream to an event hub` as destination. * Select `AllMetrics`. - * 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. + * 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 redis cache metrics + ### Configure logs collection +#### Diagnostic logs + In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor 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/). -2. To create the Diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-monitor-diagnostic-settings?tabs=basic-standard-premium#enable-connection-logging-using-the-azure-portal). Perform below steps for each Azure Cache for Redis that you want to monitor. - * Choose `Stream to an event hub` as the destination. - * Select `ConnectedClientList` for Basic, Standard, and Premium tiers and `Connection events` for Enterprise and Enterprise Flash tiers. - * 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. +1. To set up the Azure Event Hubs source in Sumo Logic, refer to the [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 settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-gb/azure/data-factory/monitor-configure-diagnostics). Perform the steps below for each azure redis cache account that you want to monitor. + 1. Choose **Stream to an event hub** as the destination. + 1. Select `allLogs`. + 1. Use the Event Hub namespace and Event Hub name configured in the previous step in the destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name. +1. Tag the location field in the source with right location value.
Azure Redis Cache Tag Location
Azure Redis Cache logs + +#### Activity Logs + +To collect activity logs, follow the instructions [here](/docs/integrations/microsoft-azure/audit). Do not perform this step if you are already collecting activity logs for a subscription. + +:::note +Since this source contains logs from multiple regions, ensure that you do not tag this source with the location tag. +::: + +## Installing the Azure Redis Cache app + +Now that you have set up data collection, install the Azure Load Balancer 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'; + + + +### Administrative Operations + +The **Azure Cache for Redis - Administrative Operations** dashboard provides details like distribution by operation type, by operation, recent delete operations, top 10 operations that caused most errors, and users/applications by operation type. + +Azure Cache for Redis - Administrative Operations + +### Connections(Enterprise) + +The **Azure Cache for Redis - Connections(Enterprise)** provides details like connections by location, total unique connected clients, total connections, event types, disconnection events, failure by operations, connected clients, cache read vs write, and hit vs misses. + +Azure Cache for Redis - Connections(Enterprise + +### Connections(Non-Enterprise) + +The **Azure Cache for Redis - Connections(Non-Enterprise)** dashboard provides details like connections by location, total unique connected clients, total connections, top 10 ip's by connection count, connections by resource name, connected clients (instance based), connected clients, cache read vs write, and hit vs misses. + +Azure Cache for Redis - Connections(Non-Enterprise) + + +### Geo Replication + +The **Azure Cache for Redis - Geo Replication** dashboard provides details like geo-replication healthy - fetched from geo-secondary cache, geo-replication full sync events - fetched from geo-secondary cache, geo-replication data sync offset - fetched from geo-primary cache, and geo-replication connectivity lag - fetched from geo-secondary cache. + +Azure Cache for Redis - Geo Replication + + +### MSEntra Authentication Audit + +The **Azure Cache for Redis - MSEntra Authentication Audit** dashboard provides details like requests by location, requests by resource name, requests by username, and MSEntra authentication audit details. + +Azure Cache for Redis - MSEntra Authentication Audit + +### Policy and Recommendations + +The **Azure Cache for Redis - Policy and Recommendations** dashboard provides details like total success policy events, total failed policy events, total recommendation events, and recent recommendation events. + +Azure Cache for Redis - Policy and Recommendations + +### Resource Operations + +The **Azure Cache for Redis - Resource Operations** dashboard provides details like total operations, ops per second (max), gets, sets, evicted key count, and expired key count. + +Azure Cache for Redis - Resource Operations + +### Resource Overview + +The **Azure Cache for Redis - Resource Overview** dashboard provides details like max server load %, max CPU %, max bytes used, max number of connected clients, and errors. + +Azure Cache for Redis - Resource Overview + +### Resource Performance + +The **Azure Cache for Redis - Resource Performance** dashboard provides details like cache hits, cache misses, cache write (max), cache read (max), cache latency microseconds, and 99th percentile latency (max). + +Azure Cache for Redis - Resource Performance ## Troubleshooting diff --git a/static/img/send-data/azureredis-cache-logs.png b/static/img/send-data/azureredis-cache-logs.png new file mode 100644 index 0000000000..7e50bcebe0 Binary files /dev/null and b/static/img/send-data/azureredis-cache-logs.png differ diff --git a/static/img/send-data/azureredis-cache-metrics.png b/static/img/send-data/azureredis-cache-metrics.png new file mode 100644 index 0000000000..f4e111495a Binary files /dev/null and b/static/img/send-data/azureredis-cache-metrics.png differ