|
1 | 1 | ---
|
2 | 2 | title: Monitor Azure Cosmos DB with Azure Monitor Azure Cosmos DB insights| Microsoft Docs
|
3 | 3 | description: This article describes the Azure Cosmos DB insights feature of Azure Monitor that provides Azure Cosmos DB owners with a quick understanding of performance and utilization issues with their Azure Cosmos DB accounts.
|
4 |
| -author: SnehaGunda |
5 |
| -ms.author: sngun |
| 4 | +author: seesharprun |
| 5 | +ms.author: sidandrews |
6 | 6 | ms.topic: conceptual
|
7 | 7 | ms.service: cosmos-db
|
8 |
| -ms.date: 05/11/2020 |
9 |
| -ms.reviewer: shijain |
| 8 | +ms.date: 02/08/2023 |
| 9 | +ms.reviewer: markjbrown |
10 | 10 | ms.custom: subject-monitoring, ignite-2022
|
11 | 11 | ---
|
12 | 12 |
|
13 | 13 | # Explore Azure Monitor Azure Cosmos DB insights
|
14 | 14 |
|
15 |
| -Azure Cosmos DB insights provides a view of the overall performance, failures, capacity, and operational health of all your Azure Cosmos DB resources in a unified interactive experience. This article will help you understand the benefits of this new monitoring experience, and how you can modify and adapt the experience to fit the unique needs of your organization. |
| 15 | +Azure Cosmos DB insights provides a view of the overall performance, failures, capacity, and operational health of all your Azure Cosmos DB resources in a unified interactive experience. This article helps you understand the benefits of this new monitoring experience, and how you can modify and adapt the experience to fit the unique needs of your organization. |
16 | 16 |
|
17 | 17 | ## Introduction
|
18 | 18 |
|
19 |
| -Before diving into the experience, you should understand how it presents and visualizes information. |
| 19 | +Before you begin, you should understand how information is presented and visualized. |
20 | 20 |
|
21 | 21 | It delivers:
|
22 | 22 |
|
23 |
| -* **At scale perspective** of your Azure Cosmos DB resources across all your subscriptions in a single location, with the ability to selectively scope to only those subscriptions and resources you are interested in evaluating. |
| 23 | +* **At-scale perspective** of your Azure Cosmos DB resources across all your subscriptions in a single location. You can selectively scope to only the subscriptions and resources that you're interested in evaluating. |
| 24 | +* **Drill-down analysis** of a particular Azure Cosmos DB resource. You can diagnose issues or perform detailed analysis by using the categories of utilization, failures, capacity, and operations. Selecting any one of the options provides an in-depth view of the relevant Azure Cosmos DB metrics. |
| 25 | +* **Customizable** experience built on top of Azure Monitor workbook templates. You can change what metrics are displayed, modify or set thresholds that align with your limits, and then save into a custom workbook. Charts in the workbooks can then be pinned to Azure dashboards. |
24 | 26 |
|
25 |
| -* **Drill down analysis** of a particular Azure Cosmos DB resource to help diagnose issues or perform detailed analysis by category - utilization, failures, capacity, and operations. Selecting any one of those options provides an in-depth view of the relevant Azure Cosmos DB metrics. |
26 |
| - |
27 |
| -* **Customizable** - This experience is built on top of Azure Monitor workbook templates allowing you to change what metrics are displayed, modify or set thresholds that align with your limits, and then save into a custom workbook. Charts in the workbooks can then be pinned to Azure dashboards. |
28 |
| - |
29 |
| -This feature does not require you to enable or configure anything, these Azure Cosmos DB metrics are collected by default. |
| 27 | +This feature doesn't require you to enable or configure anything. These Azure Cosmos DB metrics are collected by default. |
30 | 28 |
|
31 | 29 | >[!NOTE]
|
32 |
| ->There is no charge to access this feature and you will 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. |
| 30 | +>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. |
33 | 31 |
|
34 | 32 | ## View utilization and performance metrics for Azure Cosmos DB
|
35 | 33 |
|
36 |
| -To view the utilization and performance of your storage accounts across all of your subscriptions, perform the following steps. |
| 34 | +To view the utilization and performance of your storage accounts across all your subscriptions: |
37 | 35 |
|
38 | 36 | 1. Sign in to the [Azure portal](https://portal.azure.com).
|
39 | 37 |
|
40 |
| -2. Search for **Monitor** and select **Monitor**. |
| 38 | +1. Search for **Monitor** and select **Monitor**. |
41 | 39 |
|
42 |
| -  |
| 40 | +  |
43 | 41 |
|
44 |
| -3. Select **Azure Cosmos DB**. |
| 42 | +1. Select **Azure Cosmos DB**. |
45 | 43 |
|
46 |
| -  |
| 44 | +  |
47 | 45 |
|
48 | 46 | ### Overview
|
49 | 47 |
|
50 |
| -On **Overview**, the table displays interactive Azure Cosmos DB metrics. You can filter the results based on the options you select from the following drop-down lists: |
51 |
| - |
52 |
| -* **Subscriptions** - only subscriptions that have an Azure Cosmos DB resource are listed. |
| 48 | +On the **Overview** page, the table displays interactive Azure Cosmos DB metrics. You can filter the results based on the options you select from the following dropdown lists: |
53 | 49 |
|
54 |
| -* **Azure Cosmos DB** - You can select all, a subset, or single Azure Cosmos DB resource. |
| 50 | +* **Subscriptions**: Only subscriptions that have an Azure Cosmos DB resource are listed. |
| 51 | +* **Azure Cosmos DB**: You can select all, a subset, or a single Azure Cosmos DB resource. |
| 52 | +* **Time Range**: By default, the last four hours of information are displayed based on the corresponding selections made. |
55 | 53 |
|
56 |
| -* **Time Range** - by default, displays the last 4 hours of information based on the corresponding selections made. |
| 54 | +The counter tile under the dropdown lists rolls up the total number of Azure Cosmos DB resources that are in the selected subscriptions. Conditional color-coding or heatmaps for columns in the workbook report transaction metrics. The deepest color has the highest value. A lighter color is based on the lowest values. |
57 | 55 |
|
58 |
| -The counter tile under the drop-down lists rolls-up the total number of Azure Cosmos DB resources are in the selected subscriptions. There is conditional color-coding or heatmaps for columns in the workbook that report transaction metrics. The deepest color has the highest value and a lighter color is based on the lowest values. |
| 56 | +Select a dropdown arrow next to one of the Azure Cosmos DB resources to reveal a breakdown of the performance metrics at the individual database container level. |
59 | 57 |
|
60 |
| -Selecting a drop-down arrow next to one of the Azure Cosmos DB resources will reveal a breakdown of the performance metrics at the individual database container level: |
| 58 | + |
61 | 59 |
|
62 |
| - |
63 |
| - |
64 |
| -Selecting the Azure Cosmos DB resource name highlighted in blue will take you to the default **Overview** for the associated Azure Cosmos DB account. |
| 60 | +Select the Azure Cosmos DB resource name highlighted in blue to go to the default **Overview** for the associated Azure Cosmos DB account. |
65 | 61 |
|
66 | 62 | ### Failures
|
67 | 63 |
|
68 |
| -Select **Failures** at the top of the page and the **Failures** portion of the workbook template opens. It shows you total requests with the distribution of responses that make up those requests: |
| 64 | +Select the **Failures** tab to open the **Failures** portion of the workbook template. It shows you the total requests with the distribution of responses that make up those requests: |
69 | 65 |
|
70 |
| - |
| 66 | + |
71 | 67 |
|
72 | 68 | | Code | Description |
|
73 | 69 | |-----------|:--------------------|
|
74 | 70 | | `200 OK` | One of the following REST operations were successful: </br>- GET on a resource. </br> - PUT on a resource. </br> - POST on a resource. </br> - POST on a stored procedure resource to execute the stored procedure.|
|
75 | 71 | | `201 Created` | A POST operation to create a resource is successful. |
|
76 |
| -| `404 Not Found` | The operation is attempting to act on a resource that no longer exists. For example, the resource may have already been deleted. | |
| 72 | +| `404 Not Found` | The operation is attempting to act on a resource that no longer exists. For example, the resource might have already been deleted. | |
77 | 73 |
|
78 |
| -For a full list of status codes, consult the [Azure Cosmos DB HTTP status code article](/rest/api/cosmos-db/http-status-codes-for-cosmosdb). |
| 74 | +For a full list of status codes, see [HTTP status codes for Azure Cosmos DB](/rest/api/cosmos-db/http-status-codes-for-cosmosdb). |
79 | 75 |
|
80 | 76 | ### Capacity
|
81 | 77 |
|
82 |
| -Select **Capacity** at the top of the page and the **Capacity** portion of the workbook template opens. It shows you how many documents you have, your document growth over time, data usage, and the total amount of available storage that you have left. This can be used to help identify potential storage and data utilization issues. |
| 78 | +Select the **Capacity** tab to open the **Capacity** portion of the workbook template. It shows you: |
| 79 | +- How many documents you have. |
| 80 | +- Your document growth over time. |
| 81 | +- Data usage. |
| 82 | +- Total amount of available storage that you have left. |
| 83 | + |
| 84 | +This information helps you to identify potential storage and data utilization issues. |
83 | 85 |
|
84 |
| - |
| 86 | + |
85 | 87 |
|
86 |
| -As with the overview workbook, selecting the drop-down next to an Azure Cosmos DB resource in the **Subscription** column will reveal a breakdown by the individual containers that make up the database. |
| 88 | +As with the Overview workbook, selecting the dropdown next to an Azure Cosmos DB resource in the **Subscription** column reveals a breakdown by the individual containers that make up the database. |
87 | 89 |
|
88 | 90 | ### Operations
|
89 | 91 |
|
90 |
| -Select **Operations** at the top of the page and the **Operations** portion of the workbook template opens. It gives you the ability to see your requests broken down by the type of requests made. |
| 92 | +Select the **Operations** tab to open the **Operations** portion of the workbook template. You can see your requests broken down by the type of requests made. |
91 | 93 |
|
92 |
| -So in the example below you see that `eastus-billingint` is predominantly receiving read requests, but with a small number of upsert and create requests. Whereas `westeurope-billingint` is read-only from a request perspective, at least over the past four hours that the workbook is currently scoped to via its time range parameter. |
| 94 | +In the following example, you see that `eastus-billingint` is predominantly receiving read requests, but with a few upsert and create requests. You can also see that `westeurope-billingint` is read-only from a request perspective, at least over the past four hours that the workbook is currently scoped to via its time range parameter. |
93 | 95 |
|
94 |
| - |
| 96 | + |
95 | 97 |
|
96 | 98 | ## View from an Azure Cosmos DB resource
|
97 | 99 |
|
98 | 100 | 1. Search for or select any of your existing Azure Cosmos DB accounts.
|
99 | 101 |
|
100 |
| -:::image type="content" source="./media/insights-overview/cosmosdb-search.png" alt-text="Search for Azure Cosmos DB." border="true"::: |
| 102 | + :::image type="content" source="./media/insights-overview/cosmosdb-search.png" alt-text="Screenshot that shows searching for Azure Cosmos DB." border="true"::: |
101 | 103 |
|
102 |
| -2. Once you've navigated to your Azure Cosmos DB account, in the Monitoring section select **Insights (preview)** or **Workbooks** to perform further analysis on throughput, requests, storage, availability, latency, system, and account management. |
| 104 | +1. After you've moved to your Azure Cosmos DB account, in the **Monitoring** section, select **Insights (preview)** or **Workbooks**. Now you can perform further analysis on throughput, requests, storage, availability, latency, system, and account management. |
103 | 105 |
|
104 |
| -:::image type="content" source="./media/insights-overview/cosmosdb-overview.png" alt-text="Azure Cosmos DB Insights Overview." border="true"::: |
| 106 | + :::image type="content" source="./media/insights-overview/cosmosdb-overview.png" alt-text="Screenshot that shows the Azure Cosmos DB Insights Overview page." border="true"::: |
105 | 107 |
|
106 | 108 | ### Time range
|
107 | 109 |
|
108 |
| -By default, the **Time Range** field displays data from the **Last 24 hours**. You can modify the time range to display data anywhere from the last 5 minutes to the last seven days. The time range selector also includes a **Custom** mode that allows you to type in the start/end dates to view a custom time frame based on available data for the selected account. |
| 110 | +By default, the **Time Range** field displays data from the last 24 hours. You can modify the time range to display data anywhere from the last 5 minutes to the last 7 days. The time range selector also includes a **Custom** mode. Enter the start/end dates to view a custom time frame based on available data for the selected account. |
109 | 111 |
|
110 |
| -:::image type="content" source="./media/insights-overview/cosmosdb-time-range.png" alt-text="Azure Cosmos DB Time Range." border="true"::: |
| 112 | +:::image type="content" source="./media/insights-overview/cosmosdb-time-range.png" alt-text="Screenshot that shows the Azure Cosmos DB Time Range." border="true"::: |
111 | 113 |
|
112 | 114 | ### Insights overview
|
113 | 115 |
|
114 |
| -The **Overview** tab provides the most common metrics for the selected Azure Cosmos DB account including: |
| 116 | +The **Overview** tab provides the most common metrics for the selected Azure Cosmos DB account, including: |
115 | 117 |
|
116 | 118 | * Total Requests
|
117 | 119 | * Failed Requests (429s)
|
118 | 120 | * Normalized RU Consumption (max)
|
119 | 121 | * Data & Index Usage
|
120 | 122 | * Azure Cosmos DB Account Metrics by Collection
|
121 | 123 |
|
122 |
| -**Total Requests:** This graph provides a view of the total requests for the account broken down by status code. The units at the bottom of the graph are a sum of the total requests for the period. |
| 124 | +**Total Requests**: This graph provides a view of the total requests for the account broken down by status code. The units at the bottom of the graph are a sum of the total requests for the period. |
123 | 125 |
|
124 |
| -:::image type="content" source="./media/insights-overview/cosmosdb-total-requests.png" alt-text="Azure Cosmos DB Total Requests Graph." border="true"::: |
| 126 | +:::image type="content" source="./media/insights-overview/cosmosdb-total-requests.png" alt-text="Screenshot that shows the Azure Cosmos DB Total Requests graph." border="true"::: |
125 | 127 |
|
126 | 128 | **Failed Requests (429s)**: This graph provides a view of failed requests with a status code of 429. The units at the bottom of the graph are a sum of the total failed requests for the period.
|
127 | 129 |
|
128 |
| -:::image type="content" source="./media/insights-overview/cosmosdb-429.png" alt-text="Azure Cosmos DB Failed Requests Graph." border="true"::: |
| 130 | +:::image type="content" source="./media/insights-overview/cosmosdb-429.png" alt-text="Screenshot that shows the Azure Cosmos DB Failed Requests graph." border="true"::: |
129 | 131 |
|
130 |
| -**Normalized RU Consumption (max)**: This graph provides the max percentage between 0-100% of Normalized RU Consumption units for the specified period. |
| 132 | +**Normalized RU Consumption (max)**: This graph provides the maximum percentage between 0% and 100% of Normalized RU Consumption units for the specified period. |
131 | 133 |
|
132 |
| -:::image type="content" source="./media/insights-overview/cosmosdb-normalized-ru.png" alt-text="Azure Cosmos DB Normalized RU Consumption." border="true"::: |
| 134 | +:::image type="content" source="./media/insights-overview/cosmosdb-normalized-ru.png" alt-text="Screenshot that shows the Azure Cosmos DB Normalized RU Consumption graph." border="true"::: |
133 | 135 |
|
134 | 136 | ## Pin, export, and expand
|
135 | 137 |
|
136 |
| -You can pin any one of the metric sections to an [Azure Dashboard](../azure-portal/azure-portal-dashboards.md) by selecting the pushpin icon at the top right of the section. |
| 138 | +You can pin any one of the metric sections to an [Azure dashboard](../azure-portal/azure-portal-dashboards.md) by selecting the pushpin in the upper-right corner of the section. |
137 | 139 |
|
138 |
| - |
| 140 | + |
139 | 141 |
|
140 |
| -To export your data into the Excel format, select the down arrow icon to the left of the pushpin icon. |
| 142 | +To export your data into the Excel format, select the down arrow to the left of the pushpin. |
141 | 143 |
|
142 |
| - |
| 144 | + |
143 | 145 |
|
144 |
| -To expand or collapse all drop-down views in the workbook, select the expand icon to the left of the export icon: |
| 146 | +To expand or collapse all dropdown views in the workbook, select the expand arrow to the left of the down arrow. |
145 | 147 |
|
146 |
| - |
| 148 | + |
147 | 149 |
|
148 | 150 | ## Customize Azure Cosmos DB insights
|
149 | 151 |
|
150 |
| -Since this experience is built on top of Azure Monitor workbook templates, you have the ability to **Customize** > **Edit** and **Save** a copy of your modified version into a custom workbook. |
| 152 | +This experience is built on top of Azure Monitor workbook templates. You can use **Customize** > **Edit** > **Save** to modify and save a copy of your modified version into a custom workbook. |
151 | 153 |
|
152 |
| - |
| 154 | + |
153 | 155 |
|
154 |
| -Workbooks are saved within a resource group, either in the **My Reports** section that's private to you or in the **Shared Reports** section that's accessible to everyone with access to the resource group. After you save the custom workbook, you need to go to the workbook gallery to launch it. |
| 156 | +Workbooks are saved within a resource group. The **My Reports** section is private to you. The **Shared Reports** section is accessible to everyone with access to the resource group. After you save the custom workbook, you must go to the workbook gallery to start it. |
155 | 157 |
|
156 |
| - |
| 158 | + |
157 | 159 |
|
158 | 160 | ## Troubleshooting
|
159 | 161 |
|
160 |
| -For troubleshooting guidance, refer to the dedicated workbook-based insights [troubleshooting article](../azure-monitor/insights/troubleshoot-workbooks.md). |
| 162 | +For troubleshooting guidance, see [Troubleshooting workbook-based insights](../azure-monitor/insights/troubleshoot-workbooks.md). |
161 | 163 |
|
162 | 164 | ## Next steps
|
163 | 165 |
|
164 |
| -* Configure [metric alerts](../azure-monitor/alerts/alerts-metric.md) and [service health notifications](../service-health/alerts-activity-log-service-notifications-portal.md) to set up automated alerting to aid in detecting issues. |
165 |
| - |
166 |
| -* Learn the scenarios workbooks are designed to support, how to author new and customize existing reports, and more by reviewing [Create interactive reports with Azure Monitor workbooks](../azure-monitor/visualize/workbooks-overview.md). |
| 166 | +* Configure [metric alerts](../azure-monitor/alerts/alerts-metric.md) and [Service Health notifications](../service-health/alerts-activity-log-service-notifications-portal.md) to set up automated alerting to aid in detecting issues. |
| 167 | +* For more information on how the scenario workbooks are designed and how to author new and customize existing reports, see [Create interactive reports with Azure Monitor workbooks](../azure-monitor/visualize/workbooks-overview.md). |
0 commit comments