Skip to content

Commit 4aa614c

Browse files
committed
edits
1 parent 50a5d83 commit 4aa614c

File tree

1 file changed

+30
-31
lines changed

1 file changed

+30
-31
lines changed

articles/azure-cache-for-redis/cache-monitor-diagnostic-settings.md

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ ms.devlang: azurecli
1515

1616
# Monitor Azure Cache for Redis using diagnostic settings
1717

18-
Two monitoring options are available in Azure Cache for Redis **Diagnostic settings**:
18+
Azure Cache for Redis offers two monitoring options in **Diagnostic settings**:
1919

20-
- Metrics logs Azure Monitor metrics about cache operations.
21-
- Resource logs log connections to the cache. Azure captures these logs, also called *data plane logs*, per request. The contents of the connection logs vary by resource type.
20+
- *Cache metrics* log Azure Monitor metrics about cache operations.
21+
- *Connection logs* log connections to the cache. Azure captures these logs, also called *data plane logs*, per request. The contents of the connection logs vary by resource type.
2222

2323
For an overview of Azure Monitor monitoring and logging functionality, see [Diagnostic settings in Azure Monitor](/azure/azure-monitor/essentials/diagnostic-settings).
2424

@@ -33,7 +33,7 @@ For an overview of Azure Monitor monitoring and logging functionality, see [Diag
3333

3434
Azure Redis emits many useful metrics, such as **Server Load** and **Connections per Second**. For a complete listing of Azure Redis metrics, see [Metrics](../redis/monitor-cache-reference.md#metrics).
3535

36-
To log cache metrics, enable the **AllMetrics** option in your cache **Diagnostic settings** according to the instructions for your tier. You can configure how long metrics are retained. For an example of exporting cache metrics to a storage account, see [View cache metrics](../redis/monitor-cache.md#view-cache-metrics).
36+
To log cache metrics, enable the **AllMetrics** option in your cache **Diagnostic settings** according to the instructions for your tier. You can configure how long metrics are retained. For more information about logging and exporting metrics, see [Azure Cache for Redis metrics](../redis/monitor-cache.md##azure-cache-for-redis-metrics).
3737

3838
## Connection logs
3939

@@ -45,8 +45,8 @@ Azure Cache for Redis uses Azure diagnostic settings to log client connection in
4545
The connection log implementation and the logs produced are similar among Azure Redis tiers, but Basic, Standard, and Premium tiers have some differences from Enterprise and Enterprise Flash tiers.
4646

4747
> [!IMPORTANT]
48-
> - Connection logging in the Basic, Standard, and Premium tiers *polls* the current client connections in the cache. The same client IP addresses can appear repeatedly as long as the connection lasts.
49-
> - Logging in the Enterprise and Enterprise Flash tiers focuses on connection *events*. Logging only occurs when the connection event or other connection-related event first happens.
48+
> - In the Basic, Standard, and Premium tiers, connection logging *polls* the current client connections in the cache. The same client IP addresses can appear repeatedly as long as the connection lasts.
49+
> - In the Enterprise and Enterprise Flash tiers, logging focuses on connection *events*. Logging only occurs when the connection event or other connection-related event first happens.
5050
5151
## Requirements and limitations
5252

@@ -56,7 +56,7 @@ Basic, Standard, and Premium-tier caches poll client connections by IP address,
5656

5757
Keep the following limitations in mind:
5858

59-
- Because connection logs in these tiers consist of point-in-time snapshots taken every 10 seconds, connections that are established and removed within the 10-second interval aren't logged.
59+
- Because connection logs in these tiers consist of point-in-time snapshots taken every 10 seconds, connections that are established and removed within a 10-second interval aren't logged.
6060
- Authentication and disconnection events aren't logged.
6161
- Diagnostic settings can take up to [90 minutes](/azure/azure-monitor/essentials/diagnostic-settings#time-before-telemetry-gets-to-destination) to start flowing to your selected destination.
6262
- Connection logging can cause a small performance degradation in your cache.
@@ -68,10 +68,10 @@ Enterprise and Enterprise Flash-tier caches use the [audit connection event](htt
6868

6969
Keep the following limitations in mind:
7070

71-
- When you use **OSS** cluster policy, logs are emitted from each data node. When you use **Enterprise** cluster policy, only the node being used as a proxy emits logs. This difference is just architectural. Both versions cover all connections to the cache.
71+
- When you use **OSS** cluster policy, logs are emitted from each data node. When you use **Enterprise** cluster policy, only the node being used as a proxy emits logs. This difference is only architectural. Both versions cover all connections to the cache.
7272
- Data loss, or missing a connection event, is rare but possible. Data loss is typically caused by networking issues.
7373
- Disconnection logs might not be fully stable, and events might be missed.
74-
- Because connection logs on the Enterprise tiers are event-based, consider your retention policies. If retention is set to 10 days, a connection that occurred 15 days ago might still exist, but the log for that connection event isn't retained.
74+
- Because connection logs on the Enterprise tiers are event-based, consider your retention policies. If retention is set to 10 days, a connection that started 15 days ago might still exist, but the log for that connection event isn't retained.
7575
- If you use [active geo-replication](cache-how-to-active-geo-replication.md), you must configure logging individually for each cache instance in the geo-replication group.
7676
- Diagnostic settings can take up to [90 minutes](/azure/azure-monitor/essentials/diagnostic-settings#time-before-telemetry-gets-to-destination) to start flowing to your selected destination.
7777
- Connection logging can cause a small performance degradation in your cache.
@@ -86,10 +86,11 @@ Keep the following limitations in mind:
8686
When you enable diagnostic settings for your Azure Redis instance, you can send resource logs to the following destinations:
8787

8888
- **Send to Log Analytics workspace**. The workspace doesn't need to be in the same region as the resource being monitored.
89-
- **Archive to a storage account** The storage account must be in the same region as the cache.
90-
<!--[Premium storage accounts are not supported](/azure/azure-monitor/essentials/diagnostic-settings#destination-limitations) as a destination, however.-->
91-
- **Stream to an event hub**. The event hub must be in the same region as the cache. Diagnostic settings can't access event hub resources if virtual networks are enabled. Enable the **Allow trusted Microsoft services to bypass this firewall** setting in Azure Event Hubs to grant access to event hub resources.
92-
- **Send to partner solution**. For a list of potential partner logging solutions, see [Extend Azure with Azure Native Integrations](/partner-solutions/partners#data-and-storage).
89+
- **Archive to a storage account** The storage account must be in the same region as the cache. <!--[Premium storage accounts are not supported](/azure/azure-monitor/essentials/diagnostic-settings#destination-limitations) as a destination, however.-->
90+
- **Stream to an event hub**. The event hub must be in the same region as the cache.
91+
92+
Diagnostic settings can't access event hub resources if virtual networks are enabled. Enable the **Allow trusted Microsoft services to bypass this firewall** setting in Azure Event Hubs to grant access to event hub resources.
93+
- **Send to partner solution**. For a list of potential partner logging solutions, see [Extend Azure with Azure Native Integrations](/azure/partner-solutions/partners#data-and-storage).
9394

9495
When you send diagnostic logs to a storage account or event hub, you're charged normal data rates for either destination. You're billed under Azure Monitor, not Azure Cache for Redis. When you send logs to Log Analytics, you're charged only for Log Analytics data ingestion. For more pricing information, see [Azure Monitor pricing](https://azure.microsoft.com/pricing/details/monitor/).
9596

@@ -117,7 +118,7 @@ When you send diagnostic logs to a storage account or event hub, you're charged
117118

118119
:::image type="content" source="media/cache-monitor-diagnostic-settings/cache-enterprise-auditing.png" alt-text="Screenshot that shows the Diagnostic Settings - Auditing page with Add diagnostic setting highlighted.":::
119120

120-
1. On the **Diagnostic setting** page for metrics or resource logs, enter a name for your diagnostic setting. Select the metrics or logging options you want, such as the **Connection events** category or **audit** or **allLogs** category groups. All three of these choices enable **Connection events** logging.
121+
1. On the **Diagnostic setting** page for metrics or resource logs, enter a name for your diagnostic setting and select the metrics or resource log options you want. On the logging page, you can select the **Connection events** category or **audit** or **allLogs** category groups. Any of these choices enable connection logging.
121122

122123
1. Select one or more destinations and your destination details, and then select **Save**.
123124

@@ -127,7 +128,7 @@ When you send diagnostic logs to a storage account or event hub, you're charged
127128

128129
## Enable connection logging using the REST API
129130

130-
Use the Azure Monitor REST API with an interactive console to create a diagnostic setting as follows. For more information, see [Create or update](/rest/api/monitor/diagnostic-settings/create-or-update?tabs=HTTP).
131+
To create a diagnostic setting, use the Azure Monitor REST API in an interactive console as follows. For more information, see [Diagnostic Settings - Create or update](/rest/api/monitor/diagnostic-settings/create-or-update?tabs=HTTP).
131132

132133
#### [Basic, Standard, and Premium](#tab/basic-standard-premium)
133134

@@ -137,14 +138,12 @@ Use the Azure Monitor REST API with an interactive console to create a diagnosti
137138
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2017-05-01-preview
138139
```
139140

140-
**Headers**
141+
**Parameters/headers**
141142

142-
| Parameters/headers | Value/description |
143-
|---------|---------|
144-
| `name` | The name of your diagnostic setting. |
145-
| `resourceUri` | subscriptions/{SUBSCRIPTION_ID}/resourceGroups/{RESOURCE_GROUP}/providers/Microsoft.Cache/Redis/{CACHE_NAME} |
146-
| `api-version` | 2017-05-01-preview |
147-
| `Content-Type` | application/json |
143+
- `Content-Type`: `application/json`
144+
- `name`: The name of your diagnostic setting
145+
- `resourceUri`: `subscriptions/<your subscription id>/resourceGroups/<cache resource group>/providers/Microsoft.Cache/Redis/<cache name>
146+
- `api-version`: `2017-05-01-preview`
148147

149148
**Example body**
150149

@@ -177,14 +176,12 @@ PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diag
177176
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2017-05-01-preview
178177
```
179178

180-
**Headers**
179+
**Parameters/headers**
181180

182-
| Parameters/headers | Value/description |
183-
|---------|---------|
184-
| `name` | The name of your diagnostic setting. |
185-
| `resourceUri` | subscriptions/{SUBSCRIPTION_ID}/resourceGroups/{RESOURCE_GROUP}/providers/Microsoft.Cache/RedisEnterprise/{CACHE_NAME}/databases/default |
186-
| `api-version` | 2017-05-01-preview |
187-
| `Content-Type` | application/json |
181+
- `Content-Type`: `application/json`
182+
- `name`: The name of your diagnostic setting
183+
- `resourceUri`: `subscriptions/<your subscription id>/resourceGroups/<cache resource group>/providers/Microsoft.Cache/RedisEnterprise/<cache name>
184+
- `api-version`: `2017-05-01-preview`
188185

189186
**Example body**
190187

@@ -215,7 +212,9 @@ PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diag
215212

216213
## Enable connection logging using Azure CLI
217214

218-
Use the Azure CLI `az monitor diagnostic-settings create` command to create a diagnostic setting. For more information on command and parameter descriptions, see [Create diagnostic settings to send platform logs and metrics to different destinations](/cli/azure/monitor/diagnostic-settings#az-monitor-diagnostic-settings-create). The following example shows how to use the Azure CLI to stream data to four different endpoints:
215+
Use the Azure CLI `az monitor diagnostic-settings create` command to create a diagnostic setting. For more information on command and parameter descriptions, see [Create diagnostic settings to send platform logs and metrics to different destinations](/cli/azure/monitor/diagnostic-settings#az-monitor-diagnostic-settings-create).
216+
217+
The following example shows how to use the Azure CLI to stream data to four different endpoints:
219218

220219
#### [Basic, Standard, and Premium](#tab/basic-standard-premium)
221220

@@ -299,7 +298,7 @@ The contents of a log sent to a storage account might look like the following ex
299298

300299
#### [Enterprise and Enterprise Flash](#tab/enterprise-enterprise-flash)
301300

302-
These fields and properties appear in the `ConnectionEvents` log category. In **Azure Monitor**, logs are collected in the `REDConnectionEvents` table under the resource provider name of `MICROSOFT.CACHE`.
301+
These fields and properties appear in the `ConnectionEvents` log category. In Azure Monitor, logs are collected in the `REDConnectionEvents` table under the resource provider name of `MICROSOFT.CACHE`.
303302

304303
| Azure Storage field or property | Azure Monitor Logs property | Description |
305304
| --- | --- | --- |

0 commit comments

Comments
 (0)