Skip to content

Update Azure Cache for Redis with Azure metrics source compatibility (Part 3) #5385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 21, 2025
Merged

Update Azure Cache for Redis with Azure metrics source compatibility (Part 3) #5385

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef9e5c2
Update azure-cache-for-redis.md
amee-sumo May 19, 2025
ba89959
Update docs/integrations/microsoft-azure/azure-cache-for-redis.md
amee-sumo May 20, 2025
21daf76
Merge branch 'main' of https://github.com/SumoLogic/sumologic-documen…
sachin-sumologic May 20, 2025
23c704d
added dashboards and monitors
sachin-sumologic May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 55 additions & 115 deletions docs/integrations/microsoft-azure/azure-cache-for-redis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,119 +24,15 @@ Azure service sends monitoring data to Azure Monitor, which can then [stream dat

* 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.
* 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 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` 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**. <br/>[**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/(?<subscription_id>[^/]+)" nodrop
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" 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. 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). <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Tenant-Name.png')} alt="Azure Tag Tenant Name" style={{border: '1px solid gray'}} width="500" />
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).
3. [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).
4. [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 the steps below 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. <br/><img src={useBaseUrl('img/send-data/azureredis-cache-metrics.png')} alt="Azure redis cache metrics" style={{border: '1px solid gray'}} width="800" />
5. 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 Redis Cache Tag Location" style={{border: '1px solid gray'}} width="500" />
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).

### Configure logs collection

Expand Down Expand Up @@ -168,6 +64,18 @@ import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2

<AppInstallNoDataSourceV2/>

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 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 an Azure resource.
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions).

### 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.
Expand Down Expand Up @@ -206,23 +114,55 @@ The **Azure Cache for Redis - Policy and Recommendations** dashboard provides de

<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Policy-and-Recommendations.png')} alt="Azure Cache for Redis - Policy and Recommendations" style={{border: '1px solid gray'}} width="800" />

### Resource Operations
### Resource Operations (Enterprise)

The **Azure Cache for Redis - Resource Operations(Enterprise)** dashboard provides details like total operations, ops per second (max), gets, sets, evicted key count, and expired key count.

<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Operations-Enterprise.png')} alt="Azure Cache for Redis - Resource Operations(Enterprise)" style={{border: '1px solid gray'}} width="800" />

### Resource Operations (Non-Enterprise)

The **Azure Cache for Redis - Resource Operations(Non-Enterprise)** dashboard provides details like total operations, ops per second (max), gets, sets, evicted key count, and expired key count.

<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Operations-Non-Enterprise.png')} alt="Azure Cache for Redis - Resource Operations(Non-Enterprise)" style={{border: '1px solid gray'}} width="800" />


### Resource Overview (Enterprise)

The **Azure Cache for Redis - Resource Overview(Enterprise)** dashboard provides details like max server load %, max CPU %, max bytes used, max number of connected clients, and errors.

<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Overview-Enterprise.png')} alt="Azure Cache for Redis - Resource Overview(Enterprise)" style={{border: '1px solid gray'}} width="800" />

### Resource Overview (Non-Enterprise)

The **Azure Cache for Redis - Resource Overview(Non-Enterprise)** dashboard provides details like max server load %, max CPU %, max bytes used, max number of connected clients, and errors.

<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Overview-Non-Enterprise.png')} alt="Azure Cache for Redis - Resource Overview(Non-Enterprise)" style={{border: '1px solid gray'}} width="800" />


### Resource Performance (Enterprise)

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.
The **Azure Cache for Redis - Resource Performance(Enterprise)** dashboard provides details like cache hits, cache misses, cache write (max), cache read (max), cache latency microseconds, and 99th percentile latency (max).

<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Operations.png')} alt="Azure Cache for Redis - Resource Operations" style={{border: '1px solid gray'}} width="800" />
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Performance-Enterprise.png')} alt="Azure Cache for Redis - Resource Performance(Enterprise)" style={{border: '1px solid gray'}} width="800" />

### Resource Overview
### Resource Performance (Non-Enterprise)

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.
The **Azure Cache for Redis - Resource Performance(Non-Enterprise)** dashboard provides details like cache hits, cache misses, cache write (max), cache read (max), cache latency microseconds, and 99th percentile latency (max).

<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Overview.png')} alt="Azure Cache for Redis - Resource Overview" style={{border: '1px solid gray'}} width="800" />
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Performance-Non-Enterprise.png')} alt="Azure Cache for Redis - Resource Performance(Non-Enterprise)" style={{border: '1px solid gray'}} width="800" />

### 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 Application Gateway alerts
These alerts are metric based and will work for all Azure Application Gateways.

<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Resource-Performance.png')} alt="Azure Cache for Redis - Resource Performance" style={{border: '1px solid gray'}} width="800" />
| Alert Name | Alert Description and Conditions | Alert Condition | Recover Condition |
|:-------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:------------------|
| `Azure Cache For Redis - Cache Read` | This alert is triggered when Average Cache Read bytes are greater than 140625000. Also, a warning type alert will be triggered when Cache Read Units bytes are greater than 130625000. | bytes >= 140625000 | bytes < 140625000 |
| `Azure Cache For Redis - Connected Clients` | This alert is triggered when Connected Clients count is greater than 5625. Also, a warning type alert will be triggered when Connected Clients count is greater than 4625. | count >= 5625 | count < 5625 |
| `Azure Cache For Redis - CPU Utilization` | This alert is triggered when CPU Utilization percentage greater than 80. Also a warning type alert will be triggered when CPU Utilization percentage greater than 70. | percentage >= 80 | percentage < 80 |
| `Azure Cache For Redis - Server Load` | This alert is triggered when Server Load percentage greater than 80. Also a warning type alert will be triggered when Server Load percentage greater than 70. | percentage >= 80 | percentage < 80 |
| `Azure Cache For Redis - Used Memory Percentage` | This alert is triggered when Used Memory percentage greater than 80. Also a warning type alert will be triggered when Used Memory percentage greater than 70. | percentage >= 80 | percentage < 80 |

## Troubleshooting

Expand Down