Skip to content

Commit 92b498f

Browse files
More edits.
1 parent f2e89c9 commit 92b498f

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

articles/cosmos-db/monitor.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ ms.custom: subject-monitoring, ignite-2022
1313
# Monitor Azure Cosmos DB
1414
[!INCLUDE[NoSQL, MongoDB, Cassandra, Gremlin, Table](includes/appliesto-nosql-mongodb-cassandra-gremlin-table.md)]
1515

16-
When you have critical applications and business processes relying on Azure resources, you want to monitor those resources for their availability, performance, and operation. This article describes the monitoring data generated by Azure Cosmos DB databases and how you can use the features of Azure Monitor to analyze and alert on this data.
16+
When you have critical applications and business processes that rely on Azure resources, you want to monitor those resources for availability, performance, and operation. This article describes the monitoring data generated by Azure Cosmos DB databases and how you can use the features of Azure Monitor to analyze and alert on this data.
1717

1818
You can monitor your data with client-side and server-side metrics. When using server-side metrics, you can monitor the data stored in Azure Cosmos DB with the following options:
1919

2020
- **Monitor from Azure Cosmos DB portal:** You can monitor with the metrics available within the **Metrics** tab of the Azure Cosmos DB account. The metrics on this tab include throughput, storage, availability, latency, consistency, and system level metrics. By default, these metrics have a retention period of seven days. To learn more, see the [Monitoring data collected from Azure Cosmos DB](#monitoring-data) section of this article.
2121

2222
- **Monitor with metrics in Azure monitor:** You can monitor the metrics of your Azure Cosmos DB account and create dashboards from the Azure Monitor. Monitor collects the Azure Cosmos DB metrics by default. You don't need to explicitly configure anything. These metrics are collected with one-minute granularity. The granularity might vary based on the metric you choose. By default, these metrics have a retention period of 30 days.
2323

24-
Most of the metrics that are available from the previous options are also available in these metrics. The dimension values for the metrics such as container name are case-insensitive. Use case-insensitive comparison when doing string comparisons on these dimension values. To learn more, see the [Analyze metric data](#analyzing-metrics) section of this article.
24+
Most of the metrics that are available from the previous options are also available in these metrics. The dimension values for the metrics, such as container name, are case insensitive. Use case insensitive comparison when doing string comparisons on these dimension values. To learn more, see the [Analyze metric data](#analyzing-metrics) section of this article.
2525

2626
- **Monitor with diagnostic logs in Azure Monitor:** You can monitor the logs of your Azure Cosmos DB account and create dashboards from the Monitor. Data such as events and traces that occur at a second granularity are stored as logs. For example, if the throughput of a container changes, the properties of an Azure Cosmos DB account change. The logs capture these events. You can analyze these logs by running queries on the gathered data. To learn more, see the [Analyze log data](#analyzing-logs) section of this article.
2727

@@ -31,11 +31,11 @@ The following image shows different options available to monitor Azure Cosmos DB
3131

3232
:::image type="content" source="media/monitor/monitoring-options-portal.png" alt-text="Diagram shows monitoring options available in Azure portal." border="false":::
3333

34-
When you use Azure Cosmos DB, at the client-side, you can collect the details for request charge, activity ID, exception and stack trace information, HTTP status and sub-status code, and diagnostic string to debug issues that might occur. You need this information to reach out to the Azure Cosmos DB support team.
34+
On the client-side, you can collect the details for request charge, activity ID, exception and stack trace information, HTTP status and substatus code, and diagnostic string to debug issues that might occur. You need this information to reach out to the Azure Cosmos DB support team.
3535

3636
## Monitor overview
3737

38-
The **Overview** page in the Azure portal for each Azure Cosmos DB account includes a brief view of the resource usage, such as total requests, requests that resulted in a specific HTTP status code, and hourly billing. This information is helpful, however only a small amount of the monitoring data is available from this pane. Some of this data is collected automatically. It's available for analysis as soon as you create the resource. You can enable other types of data collection after some configuration.
38+
The **Overview** page in the Azure portal for each Azure Cosmos DB account includes a brief view of the resource usage, such as total requests, requests that resulted in a specific HTTP status code, and hourly billing. This information is helpful. It's only a small amount of the monitoring data is available from this pane. Some of this data is collected automatically. It's available for analysis as soon as you create the resource. You can enable other types of data collection after some configuration.
3939

4040
## What is Azure Monitor?
4141

@@ -56,13 +56,13 @@ The following sections build on this article. They describe the specific data ga
5656
Azure Cosmos DB insights is a feature based on the [workbooks feature of Azure Monitor](../azure-monitor/visualize/workbooks-overview.md) and uses the same monitoring data collected for Azure Cosmos DB described in the following sections. Use Monitor for a view of the overall performance, failures, capacity, and operational health of all your Azure Cosmos DB resources in a unified interactive experience. Use the other features of Monitor for detailed analysis and alerting. To learn more, see [Explore Azure Cosmos DB insights](insights-overview.md).
5757

5858
> [!NOTE]
59-
> When creating containers, make sure you don't create two containers with the same name but different casing. Some parts of the Azure platform are not case-sensitive. This situation can result in confusion or collision of telemetry and actions on containers with such names.
59+
> When creating containers, make sure you don't create two containers with the same name but different casing. Some parts of the Azure platform are not case sensitive. This situation can result in confusion or collision of telemetry and actions on containers with such names.
6060
6161
## Monitoring data
6262

6363
Azure Cosmos DB collects the same kinds of monitoring data as other Azure resources, which are described in [Monitoring data from Azure resources](../azure-monitor/essentials/monitor-azure-resource.md#monitoring-data). For a detailed reference of the logs and metrics created by Azure Cosmos DB, see [Azure Cosmos DB monitoring data reference](monitor-reference.md).
6464

65-
The **Overview** page in the Azure portal for each Azure Cosmos DB database includes a brief view of the database usage including its request and hourly billing usage. This information is useful. It is only a small amount of the monitoring data available. Some of this data is collected automatically and available for analysis as soon as you create the database. You can enable more data collection after some configuration.
65+
The **Overview** page in the Azure portal for each Azure Cosmos DB database includes a brief view of the database usage including its request and hourly billing usage. This information is useful. It's only a small amount of the monitoring data available. Some of this data is collected automatically and available for analysis as soon as you create the database. You can enable more data collection after some configuration.
6666

6767
:::image type="content" source="media/monitor/overview-page.png" alt-text="Screenshot shows the Cosmos DB Overview page.":::
6868

@@ -72,15 +72,15 @@ Platform metrics and the Activity log are collected and stored automatically. Us
7272

7373
Resource logs aren't collected and stored until you create a diagnostic setting and route them to one or more locations.
7474

75-
For the process to create a diagnostic setting using the Azure portal and diagnostic query examples, see [Create diagnostic setting to collect platform logs and metrics in Azure](monitor-resource-logs.md). When you create a diagnostic setting, you specify which categories of logs to collect.
75+
To learn about the process to create a diagnostic setting using the Azure portal and diagnostic query examples, see [Create diagnostic setting to collect platform logs and metrics in Azure](monitor-resource-logs.md). When you create a diagnostic setting, you specify which categories of logs to collect.
7676

7777
The following sections discuss the metrics and logs you can collect.
7878

7979
## Analyzing metrics
8080

8181
Azure Cosmos DB provides a custom experience for working with metrics. You can analyze metrics for Azure Cosmos DB with metrics from other Azure services using Metrics explorer by opening **Metrics** from the **Azure Monitor** menu. For more information about this tool, see [Getting started with Azure Metrics Explorer](../azure-monitor/essentials/metrics-getting-started.md).
8282

83-
You can also check out how to monitor [server-side latency](monitor-server-side-latency.md), [request unit usage](monitor-request-unit-usage.md), and [normalized request unit usage](monitor-normalized-request-units.md) for your Azure Cosmos DB resources.
83+
You can also monitor [server-side latency](monitor-server-side-latency.md), [request unit usage](monitor-request-unit-usage.md), and [normalized request unit usage](monitor-normalized-request-units.md) for your Azure Cosmos DB resources.
8484

8585
For a list of the platform metrics collected for Azure Cosmos DB, see [Monitoring Azure Cosmos DB data reference metrics](monitor-reference.md#metrics).
8686

@@ -98,7 +98,7 @@ You can see a list of [all resource metrics supported in Azure Monitor](../azure
9898

9999
1. Sign in to the [Azure portal](https://portal.azure.com/).
100100

101-
1. Select **Monitor** from the left-hand navigation bar, and select **Metrics**.
101+
1. Select **Monitor** from the left navigation bar, and select **Metrics**.
102102

103103
:::image type="content" source="./media/monitor/monitor-metrics-blade.png" alt-text="Screenshot shows the Metrics pane in Azure Monitor.":::
104104

@@ -112,7 +112,7 @@ You can see a list of [all resource metrics supported in Azure Monitor](../azure
112112

113113
:::image type="content" source="./media/monitor/metric-types.png" alt-text="Screenshot shows the option to choose a metric from the Azure portal.":::
114114

115-
In addition to these details, you can also select the **Time range** and **Time granularity** of the metrics. At the maximum, you can view metrics for the past 30 days.
115+
In addition to these details, you can also select the **Time range** and **Time granularity** of the metrics. At the most, you can view metrics for the past 30 days.
116116

117117
After you apply the filter, the Azure portal displays a chart based on your filter. You can see the average number of request units consumed per minute for the selected period.
118118

@@ -128,7 +128,7 @@ You can also filter metrics and the chart displayed by properties:
128128
- Status
129129
- StatusCode
130130

131-
To filter the metrics, select **Add filter** and choose the required property such as **OperationType**. Then select a value, such as **Query**.
131+
To filter the metrics, select **Add filter** and choose the required property, such as **OperationType**. Then select a value, such as **Query**.
132132

133133
The graph then displays the request units consumed for the query operation for the selected period. The operations run by using a stored procedure aren't logged. They aren't available under the OperationType metric.
134134

@@ -194,7 +194,7 @@ AzureDiagnostics
194194
```
195195

196196
> [!IMPORTANT]
197-
> In the **AzureDiagnostics** table, many fields are case-sensitive and uppercase including, but not limited to *ResourceId*, *ResourceGroup*, *ResourceProvider*, and *Resource*.
197+
> In the **AzureDiagnostics** table, many fields are case sensitive and uppercase including, but not limited to *ResourceId*, *ResourceGroup*, *ResourceProvider*, and *Resource*.
198198
199199
To get a count of data-plane logs, grouped by resource:
200200

@@ -275,7 +275,7 @@ The account level metrics available in the portal, such as account storage usage
275275

276276
- To use the .NET SDK, use the [DocumentClient.ReadDocumentCollectionAsync](/dotnet/api/microsoft.azure.documents.client.documentclient.readdocumentcollectionasync) method, which returns a [ResourceResponse](/dotnet/api/microsoft.azure.documents.client.resourceresponse-1) that contains many usage properties such as **CollectionSizeUsage**, **DatabaseUsage**, and **DocumentUsage**.
277277

278-
To access more metrics, use the [Azure Monitor SDK](https://www.nuget.org/packages/Microsoft.Azure.Insights). Available metric definitions can be retrieved by calling:
278+
To access more metrics, use the [Azure Monitor SDK](https://www.nuget.org/packages/Microsoft.Azure.Insights). Available metric definitions can be retrieved by using this format:
279279

280280
```http
281281
https://management.azure.com/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroup}/providers/Microsoft.DocumentDb/databaseAccounts/{DocumentDBAccountName}/providers/microsoft.insights/metricDefinitions?api-version=2018-01-01

0 commit comments

Comments
 (0)