Skip to content

Commit b17405b

Browse files
committed
Merge branch 'horizontals-cosmos-db' of https://github.com/AbbyMSFT/azure-docs-pr into horz-monitor-cosmosdb
2 parents cb0ef00 + 76047f4 commit b17405b

File tree

6 files changed

+41
-37
lines changed

6 files changed

+41
-37
lines changed

articles/cosmos-db/gremlin/TOC.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -347,13 +347,13 @@
347347
href: ../sql/create-support-request-quota-increase.md
348348
- name: Monitor
349349
items:
350-
- name: Monitor
350+
- name: Monitor Azure Cosmos DB
351351
href: ../monitor.md
352352
- name: Use Azure monitor metrics
353353
items:
354-
- name: Azure Monitor for Azure Cosmos DB
354+
- name: Azure Cosmos DB insights
355355
href: ../insights-overview.md
356-
- name: Scenarios to monitor
356+
- name: Monitor and debug using metrics
357357
href: ../use-metrics.md
358358
- name: Monitor server-side latency
359359
href: ../monitor-server-side-latency.md

articles/cosmos-db/insights-overview.md

+31
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,37 @@ This feature doesn't require you to enable or configure anything. These Azure Co
2929
>[!NOTE]
3030
>There's no charge to access this feature. You'll only be charged for the Azure Monitor essential features you configure or enable, as described on the [Azure Monitor pricing details](https://azure.microsoft.com/pricing/details/monitor/) page.
3131
32+
## View insights from Azure portal
33+
34+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Azure Cosmos DB account.
35+
36+
1. You can view your account metrics either from the **Metrics** pane or the **Insights** pane.
37+
38+
* **Metrics:** This pane provides numerical metrics that are collected at regular intervals and describes some aspect of a system at a particular time. For example, you can view and monitor the [server side latency metric](monitor-server-side-latency.md), [normalized request unit usage metric](monitor-normalized-request-units.md), etc.
39+
40+
* **Insights:** This pane provides a customized monitoring experience for Azure Cosmos DB. Insights use the same metrics and logs that are collected in Azure Monitor and show an aggregated view for your account.
41+
42+
1. Open the **Insights** pane. By default, the Insights pane shows the throughput, requests, storage, availability, latency, system, and management operations metrics for every container in your account. You can select the **Time Range**, **Database**, and **Container** for which you want to view insights. The **Overview** tab shows RU/s usage, data usage, index usage, throttled requests, and normalized RU/s consumption for the selected database and container.
43+
44+
:::image type="content" source="./media/use-metrics/performance-metrics.png" alt-text="Screenshot of Azure Cosmos DB performance metrics in the Azure portal." lightbox="./media/use-metrics/performance-metrics.png" :::
45+
46+
1. The following metrics are available from the **Insights** pane:
47+
48+
* **Throughput**. This tab shows the total number of request units consumed or failed (429 response code) because the throughput or storage capacity provisioned for the container has exceeded.
49+
50+
* **Requests**. This tab shows the total number of requests processed by status code, by operation type, and the count of failed requests (429 response code). Requests fail when the throughput or storage capacity provisioned for the container exceeds.
51+
52+
* **Storage**. This tab shows the size of data and index usage over the selected time period.
53+
54+
* **Availability**. This tab shows the percentage of successful requests over the total requests per hour. The Azure Cosmos DB SLAs defines the success rate.
55+
56+
* **Latency**. This tab shows the read and write latency observed by Azure Cosmos DB in the region where your account is operating. You can visualize latency across regions for a geo-replicated account. You can also view server-side latency by different operations. This metric doesn't represent the end-to-end request latency.
57+
58+
* **System**. This tab shows how many metadata requests that the primary partition serves. It also helps to identify the throttled requests.
59+
60+
* **Management Operations**. This tab shows the metrics for account management activities such as account creation, deletion, key updates, network and replication settings.
61+
62+
3263
## View utilization and performance metrics for Azure Cosmos DB
3364

3465
To view the utilization and performance of your storage accounts across all your subscriptions:

articles/cosmos-db/monitor.md

+3
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,9 @@ See the following articles for more information about working with Azure Monitor
118118

119119
Prior to using Log Analytics to issue Kusto queries, you must [enable diagnostic logs for control plane operations](audit-control-plane-logs.md#enable-diagnostic-logs-for-control-plane-operations). When you enable diagnostic logs, you select between storing your data in [resource-specific tables](/azure/azure-monitor/essentials/resource-logs#resource-specific) or the single [AzureDiagnostics table (legacy)](/azure/azure-monitor/essentials/resource-logs#azure-diagnostics-mode). The exact text of Kusto queries depends on the [collection mode](/azure/azure-monitor/essentials/resource-logs#select-the-collection-mode) you select.
120120

121+
- See [Troubleshoot issues with diagnostics queries](monitor-logs-basic-queries.md) for simple queries to help troubleshoot issues with your Azure Cosmos DB.
122+
- See [Troubleshoot issues with advanced diagnostics queries with Azure Cosmos DB for NoSQL](nosql/diagnostic-queries.md) for more advanced queries to help troubleshoot issues with your Azure Cosmos DB account by using diagnostics logs sent to Azure Diagnostics (legacy) and resource-specific (preview) tables.
123+
121124
Here are some queries that you can enter into the **Log search** search bar to help you monitor your Azure Cosmos DB resources.
122125

123126
### [Resource-specific table](#tab/resource-specific-diagnostics)

articles/cosmos-db/nosql/TOC.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -935,13 +935,13 @@
935935
href: ../store-credentials-key-vault.md
936936
- name: Monitor
937937
items:
938-
- name: Monitor Cosmos DB
938+
- name: Monitor Azure Cosmos DB
939939
href: ../monitor.md
940940
- name: Use Azure monitor metrics
941941
items:
942942
- name: Azure Cosmos DB insights
943943
href: ../insights-overview.md
944-
- name: Scenarios to monitor
944+
- name: Monitor and debug using metrics
945945
href: ../use-metrics.md
946946
- name: Monitor server-side latency
947947
href: ../monitor-server-side-latency.md

articles/cosmos-db/table/TOC.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -349,13 +349,13 @@
349349
href: ../access-previews.md
350350
- name: Monitor
351351
items:
352-
- name: Monitor
352+
- name: Monitor Azure Cosmos DB
353353
href: ../monitor.md
354354
- name: Use Azure monitor metrics
355355
items:
356356
- name: Azure Monitor for Azure Cosmos DB
357357
href: ../insights-overview.md
358-
- name: Scenarios to monitor
358+
- name: Monitor and debug using metrics
359359
href: ../use-metrics.md
360360
- name: Monitor server-side latency
361361
href: ../monitor-server-side-latency.md

articles/cosmos-db/use-metrics.md

-30
Original file line numberDiff line numberDiff line change
@@ -19,36 +19,6 @@ Azure Cosmos DB provides insights for throughput, storage, consistency, availabi
1919

2020
This article walks through common use cases and how Azure Cosmos DB insights can be used to analyze and debug these issues. By default, the metric insights are collected every five minutes and are kept for seven days.
2121

22-
## View insights from Azure portal
23-
24-
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your Azure Cosmos DB account.
25-
26-
1. You can view your account metrics either from the **Metrics** pane or the **Insights** pane.
27-
28-
* **Metrics:** This pane provides numerical metrics that are collected at regular intervals and describes some aspect of a system at a particular time. For example, you can view and monitor the [server side latency metric](monitor-server-side-latency.md), [normalized request unit usage metric](monitor-normalized-request-units.md), etc.
29-
30-
* **Insights:** This pane provides a customized monitoring experience for Azure Cosmos DB. Insights use the same metrics and logs that are collected in Azure Monitor and show an aggregated view for your account.
31-
32-
1. Open the **Insights** pane. By default, the Insights pane shows the throughput, requests, storage, availability, latency, system, and management operations metrics for every container in your account. You can select the **Time Range**, **Database**, and **Container** for which you want to view insights. The **Overview** tab shows RU/s usage, data usage, index usage, throttled requests, and normalized RU/s consumption for the selected database and container.
33-
34-
:::image type="content" source="./media/use-metrics/performance-metrics.png" alt-text="Screenshot of Azure Cosmos DB performance metrics in the Azure portal." lightbox="./media/use-metrics/performance-metrics.png" :::
35-
36-
1. The following metrics are available from the **Insights** pane:
37-
38-
* **Throughput**. This tab shows the total number of request units consumed or failed (429 response code) because the throughput or storage capacity provisioned for the container has exceeded.
39-
40-
* **Requests**. This tab shows the total number of requests processed by status code, by operation type, and the count of failed requests (429 response code). Requests fail when the throughput or storage capacity provisioned for the container exceeds.
41-
42-
* **Storage**. This tab shows the size of data and index usage over the selected time period.
43-
44-
* **Availability**. This tab shows the percentage of successful requests over the total requests per hour. The Azure Cosmos DB SLAs defines the success rate.
45-
46-
* **Latency**. This tab shows the read and write latency observed by Azure Cosmos DB in the region where your account is operating. You can visualize latency across regions for a geo-replicated account. You can also view server-side latency by different operations. This metric doesn't represent the end-to-end request latency.
47-
48-
* **System**. This tab shows how many metadata requests that the primary partition serves. It also helps to identify the throttled requests.
49-
50-
* **Management Operations**. This tab shows the metrics for account management activities such as account creation, deletion, key updates, network and replication settings.
51-
5222
The following sections explain common scenarios where you can use Azure Cosmos DB metrics.
5323

5424
## Understand how many requests are succeeding or causing errors

0 commit comments

Comments
 (0)