Skip to content

Commit 94021c1

Browse files
amee-sumojpipkin1sachin-sumologic
authored
Update Azure Cache for Redis with Azure metrics source compatibility (Part 3) (#5385)
* Update azure-cache-for-redis.md * Update docs/integrations/microsoft-azure/azure-cache-for-redis.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * added dashboards and monitors --------- Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> Co-authored-by: Sachin Magar <[email protected]>
1 parent ab6256f commit 94021c1

File tree

1 file changed

+55
-115
lines changed

1 file changed

+55
-115
lines changed

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

Lines changed: 55 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -24,119 +24,15 @@ Azure service sends monitoring data to Azure Monitor, which can then [stream dat
2424

2525
* 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/).
2626
* 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.
27-
* 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.
27+
* Metrics collection using our [Azure Metrics Source](/docs/send-data/hosted-collectors/microsoft-source/azure-metrics-source).
2828

2929
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).
3030

3131
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`.
3232

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 |
127-
12833
### Configure metrics collection
12934

130-
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.
131-
132-
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" />
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).
134-
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).
135-
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.
136-
* Choose `Stream to an event hub` as destination.
137-
* Select `AllMetrics`.
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-
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" />
35+
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).
14036

14137
### Configure logs collection
14238

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

16965
<AppInstallNoDataSourceV2/>
17066

67+
As part of the app installation process, the following fields will be created by default:
68+
69+
- `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).
70+
- `location`. The region to which the resource name belongs to.
71+
- `subscription_id`. ID associated with a subscription where the resource is present.
72+
- `resource_group`. The resource group name where the Azure resource is present.
73+
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
74+
- `resource_type`. Azure resource type (for example, storage accounts).
75+
- `resource_name`. The name of the resource (for example, storage account name).
76+
- `service_type`. Type of the service that can be accessed with an Azure resource.
77+
- `service_name`. Services that can be accessed with an Azure resource (for example, in Azure Container Instances the service is Subscriptions).
78+
17179
### Administrative Operations
17280

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

207115
<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" />
208116

209-
### Resource Operations
117+
### Resource Operations (Enterprise)
118+
119+
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.
120+
121+
<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" />
122+
123+
### Resource Operations (Non-Enterprise)
124+
125+
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.
126+
127+
<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" />
128+
129+
130+
### Resource Overview (Enterprise)
131+
132+
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.
133+
134+
<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" />
135+
136+
### Resource Overview (Non-Enterprise)
137+
138+
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.
139+
140+
<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" />
141+
142+
143+
### Resource Performance (Enterprise)
210144

211-
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.
145+
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).
212146

213-
<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" />
147+
<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" />
214148

215-
### Resource Overview
149+
### Resource Performance (Non-Enterprise)
216150

217-
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.
151+
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).
218152

219-
<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" />
153+
<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" />
220154

221-
### Resource Performance
222155

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

225-
<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" />
159+
| Alert Name | Alert Description and Conditions | Alert Condition | Recover Condition |
160+
|:-------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:------------------|
161+
| `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 |
162+
| `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 |
163+
| `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 |
164+
| `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 |
165+
| `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 |
226166

227167
## Troubleshooting
228168

0 commit comments

Comments
 (0)