Skip to content

Commit 968c846

Browse files
Azure Cache for Redis v2 app documentation (#4595)
* Azure Cache for Redis v2 app documentation * Azure Cache for Redis v2 app documentation * Update azure-cache-for-redis.md * resolved feedback comments --------- Co-authored-by: Jagadisha V <[email protected]>
1 parent 927370d commit 968c846

File tree

3 files changed

+183
-9
lines changed

3 files changed

+183
-9
lines changed

docs/integrations/microsoft-azure/azure-cache-for-redis.md

Lines changed: 183 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,39 +15,213 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1515
For Azure Cache for Redis, you can collect the following logs and metrics:
1616

1717
* **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.
18+
* **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).
1819
* **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).
1920

2021
## Setup
2122

2223
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:
2324

2425
* 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/).
26+
* 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.
2527
* 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.
2628

2729
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).
2830

29-
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`.
31+
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`.
32+
33+
### Configure field in field schema
34+
35+
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**.
36+
1. Search for the following fields:
37+
- `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).
38+
- `location`. The region to which the resource name belongs to.
39+
- `subscription_id`. ID associated with a subscription where the resource is present.
40+
- `resource_group`. The resource group name where the Azure resource is present.
41+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
42+
- `resource_type`. Azure resource type (for example, storage accounts).
43+
- `resource_name`. The name of the resource (for example, storage account name).
44+
- `service_type`. Type of the service that can be accessed with a Azure resource.
45+
- `service_name`. Services that can be accessed with an Azure resource (for example, Azure SQL databases in Azure SQL Server).
46+
1. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
47+
48+
### Configure Field Extraction Rules
49+
50+
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/).
51+
52+
#### Azure location extraction FER
53+
54+
```sql
55+
Rule Name: AzureLocationExtractionFER
56+
Applied at: Ingest Time
57+
Scope (Specific Data): tenant_name=*
58+
```
59+
60+
```sql title="Parse Expression"
61+
json "location", "properties.resourceLocation", "properties.region" as location, resourceLocation, service_region nodrop
62+
| replace(toLowerCase(resourceLocation), " ", "") as resourceLocation
63+
| if (!isBlank(resourceLocation), resourceLocation, location) as location
64+
| if (!isBlank(service_region), service_region, location) as location
65+
| if (isBlank(location), "global", location) as location
66+
| fields location
67+
```
68+
69+
#### Resource ID extraction FER
70+
71+
```sql
72+
Rule Name: AzureResourceIdExtractionFER
73+
Applied at: Ingest Time
74+
Scope (Specific Data): tenant_name=*
75+
```
76+
77+
```sql title="Parse Expression"
78+
json "resourceId", "ResourceId" as resourceId1, resourceId2 nodrop
79+
| if (isBlank(resourceId1), resourceId2, resourceId1) as resourceId
80+
| toUpperCase(resourceId) as resourceId
81+
| parse regex field=resourceId "/SUBSCRIPTIONS/(?<subscription_id>[^/]+)" nodrop
82+
| parse field=resourceId "/RESOURCEGROUPS/*/" as resource_group nodrop
83+
| parse regex field=resourceId "/PROVIDERS/(?<provider_name>[^/]+)" nodrop
84+
| parse regex field=resourceId "/PROVIDERS/[^/]+(?:/LOCATIONS/[^/]+)?/(?<resource_type>[^/]+)/(?<resource_name>.+)" nodrop
85+
| parse regex field=resource_name "(?<parent_resource_name>[^/]+)(?:/PROVIDERS/[^/]+)?/(?<service_type>[^/]+)/?(?<service_name>.+)" nodrop
86+
| if (isBlank(parent_resource_name), resource_name, parent_resource_name) as resource_name
87+
| fields subscription_id, location, provider_name, resource_group, resource_type, resource_name, service_type, service_name
88+
```
89+
90+
### Configure metric rules
91+
92+
Create the following metrics rules by following the instructions in [Create a metrics rule](/docs/metrics/metric-rules-editor/#create-a-metrics-rule).
93+
94+
#### Azure observability metadata extraction redis cache level
95+
96+
```sql
97+
Rule Name: AzureObservabilityMetadataExtractionRedisCacheLevel
98+
```
99+
100+
```sql title="Metric match expression"
101+
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/REDIS/* tenant_name=*
102+
```
103+
104+
| Fields extracted | Metric rule |
105+
|:------------------|:---------------|
106+
| subscription_id | $resourceId._1 |
107+
| resource_group | $resourceId._2 |
108+
| provider_name | $resourceId._3 |
109+
| resource_type | REDIS |
110+
| resource_name | $resourceId._4 |
111+
112+
```sql
113+
Rule Name: AzureObservabilityMetadataExtractionEnterpriseRedisCacheLevel
114+
```
115+
116+
```sql title="Metric match expression"
117+
resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/*/REDISENTERPRISE/* tenant_name=*
118+
```
119+
120+
| Fields extracted | Metric rule |
121+
|:------------------|:------------------------|
122+
| subscription_id | $resourceId._1 |
123+
| resource_group | $resourceId._2 |
124+
| provider_name | $resourceId._3 |
125+
| resource_type | REDISENTERPRISE |
126+
| resource_name | $resourceId._4 |
30127
31128
### Configure metrics collection
32129
33130
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.
34131
35-
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).
132+
1. Create hosted collector and tag tenant_name field. <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" />
133+
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).
36134
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).
37-
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.
135+
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.
38136
* Choose `Stream to an event hub` as destination.
39137
* Select `AllMetrics`.
40-
* 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.
138+
* 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" />
139+
41140
42141
### Configure logs collection
43142
143+
#### Diagnostic logs
144+
44145
In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.
45146
46-
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/).
47-
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.
48-
* Choose `Stream to an event hub` as the destination.
49-
* Select `ConnectedClientList` for Basic, Standard, and Premium tiers and `Connection events` for Enterprise and Enterprise Flash tiers.
50-
* 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.
147+
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/).
148+
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.
149+
1. Choose **Stream to an event hub** as the destination.
150+
1. Select `allLogs`.
151+
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.
152+
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 Redis Cache Tag Location" style={{border: '1px solid gray'}} width="400" /> <br/><img src={useBaseUrl('img/send-data/azureredis-cache-logs.png')} alt="Azure Redis Cache logs" style={{border: '1px solid gray'}} width="800" />
153+
154+
#### Activity Logs
155+
156+
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.
157+
158+
:::note
159+
Since this source contains logs from multiple regions, ensure that you do not tag this source with the location tag.
160+
:::
161+
162+
## Installing the Azure Redis Cache app
163+
164+
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.
165+
166+
import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2.md';
167+
168+
<AppInstallNoDataSourceV2/>
169+
170+
### Administrative Operations
171+
172+
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.
173+
174+
<img src={useBaseUrl('https://sumologic-app-data.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Administrative-Operations.png')} alt="Azure Cache for Redis - Administrative Operations" style={{border: '1px solid gray'}} width="800" />
175+
176+
### Connections(Enterprise)
177+
178+
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.
179+
180+
<img src={useBaseUrl('https://sumologic-app-data.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Connections-Enterprise.png')} alt="Azure Cache for Redis - Connections(Enterprise" style={{border: '1px solid gray'}} width="800" />
181+
182+
### Connections(Non-Enterprise)
183+
184+
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.
185+
186+
<img src={useBaseUrl('https://sumologic-app-data.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Connections-Non-Enterprise.png')} alt="Azure Cache for Redis - Connections(Non-Enterprise)" style={{border: '1px solid gray'}} width="800" />
187+
188+
189+
### Geo Replication
190+
191+
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.
192+
193+
<img src={useBaseUrl('https://sumologic-app-data.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-Geo-Replication.png')} alt="Azure Cache for Redis - Geo Replication" style={{border: '1px solid gray'}} width="800" />
194+
195+
196+
### MSEntra Authentication Audit
197+
198+
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.
199+
200+
<img src={useBaseUrl('https://sumologic-app-data.s3.amazonaws.com/dashboards/AzureCacheForRedis/Azure-Cache-for-Redis-MSEntra-Authentication-Audit.png')} alt="Azure Cache for Redis - MSEntra Authentication Audit" style={{border: '1px solid gray'}} width="800" />
201+
202+
### Policy and Recommendations
203+
204+
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.
205+
206+
<img src={useBaseUrl('https://sumologic-app-data.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" />
207+
208+
### Resource Operations
209+
210+
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.
211+
212+
<img src={useBaseUrl('https://sumologic-app-data.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" />
213+
214+
### Resource Overview
215+
216+
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.
217+
218+
<img src={useBaseUrl('https://sumologic-app-data.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" />
219+
220+
### Resource Performance
221+
222+
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).
223+
224+
<img src={useBaseUrl('https://sumologic-app-data.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" />
51225
52226
## Troubleshooting
53227
228 KB
Loading
253 KB
Loading

0 commit comments

Comments
 (0)