Skip to content

Commit c850381

Browse files
author
Jill Grant
authored
Merge pull request #274957 from cdpark/horz-monitor-cosmosdb
User Story 246543: Q&M: Curate 27 SOX Azure Monitor horizontals articles to reduce duplication - Cosmos DB
2 parents 0cd60cf + 35bd9fa commit c850381

19 files changed

+141
-304
lines changed

articles/azure-monitor/toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1614,4 +1614,5 @@ items:
16141614
- name: Pricing calculator
16151615
href: https://azure.microsoft.com/pricing/calculator/
16161616
- name: Regional availability
1617-
href: https://azure.microsoft.com/global-infrastructure/services/?regions=all&products=monitor
1617+
href: https://azure.microsoft.com/global-infrastructure/services/?regions=all&products=monitor
1618+

articles/cosmos-db/audit-restore-continuous.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ ms.author: govindk
99
ms.reviewer: mjbrown
1010
---
1111

12-
# Audit the point in time restore action for continuous backup mode in Azure Cosmos DB
12+
# Audit the point-in-time restore action for continuous backup mode in Azure Cosmos DB
1313
[!INCLUDE[NoSQL, MongoDB, Gremlin, Table](includes/appliesto-nosql-mongodb-gremlin-table.md)]
1414

15-
Azure Cosmos DB provides you the list of all the point in time restores for continuous mode that were performed on an Azure Cosmos DB account using [Activity Logs](../azure-monitor/essentials/activity-log.md). Activity logs can be viewed for any Azure Cosmos DB account from the **Activity Logs** page in the Azure portal. The Activity Log shows all the operations that were triggered on the specific account. When a point in time restore is triggered, it shows up as `Restore Database Account` operation on the source account as well as the target account. The Activity Log for the source account can be used to audit restore events, and the activity logs on the target account can be used to get the updates about the progress of the restore.
15+
Azure Cosmos DB provides you with a list of all point-in-time restores for continuous mode that were performed on an Azure Cosmos DB account using [activity logs](monitor.md#activity-log). Activity logs can be viewed for any Azure Cosmos DB account from the **Activity Logs** page in the Azure portal. The activity log shows all the operations that were triggered on the specific account. When a point-in-time restore is triggered, it shows up as `Restore Database Account` operation on the source account as well as the target account. The activity log for the source account can be used to audit restore events, and the activity logs on the target account can be used to get the updates about the progress of the restore.
1616

1717
## Audit the restores that were triggered on a live database account
1818

articles/cosmos-db/autoscale-per-partition-region.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,12 @@ This feature is available for new Azure Cosmos DB accounts. To enable this featu
5454

5555
:::image type="content" source="media/autoscale-per-partition-region/enable-feature.png" lightbox="media/autoscale-per-partition-region/enable-feature.png" alt-text="Screenshot of the 'Per Region and Per Partition Autoscale' feature in the Azure portal.":::
5656

57-
> [!IMPORTANT]
58-
> The feature is enabled at the account level, so all containers within the account will automatically have this capability applied. The feature is available for both shared throughput databases and containers with dedicated throughput. Provisioned throughput accounts must switch over to autoscale and then enable this feature, if interested.
59-
60-
## Metrics
57+
> [!IMPORTANT]
58+
> The feature is enabled at the account level, so all containers within the account will automatically have this capability applied. The feature is available for both shared throughput databases and containers with dedicated throughput. Provisioned throughput accounts must switch over to autoscale and then enable this feature, if interested.
6159
62-
Use Azure Monitor to analyze how the new autoscaling is being applied across partitions and regions. Filter to your desired database account and container, then filter or split by the `PhysicalPartitionID` metric. This metric shows all partitions across their various regions.
60+
1. Use [Azure Monitor metrics](monitor-reference.md#supported-metrics-for-microsoftdocumentdbdatabaseaccounts) to analyze how the new autoscaling is applied across partitions and regions. Filter to your desired database account and container, then filter or split by the `PhysicalPartitionID` metric. This metric shows all partitions across their various regions.
6361

64-
Then, use `NormalizedRUConsumption' to see which partitions are scaling indpendently and which regions are scaling independently if applicable. You can use the 'ProvisionedThroughput' metric to see what throughput value is getting emmitted to our billing service.
62+
Then, use `NormalizedRUConsumption` to see which partitions and regions scale independently. You can use the `ProvisionedThroughput` metric to see what throughput value is emitted to our billing service.
6563

6664
## Requirements/Limitations
6765

articles/cosmos-db/cassandra/error-codes-solution.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ ms.custom: template-how-to
1313
# Server diagnostics for Azure Cosmos DB for Apache Cassandra
1414
[!INCLUDE[Cassandra](../includes/appliesto-cassandra.md)]
1515

16-
Log Analytics is a tool in the Azure portal that helps you run server diagnostics on your API for Cassandra account. Run log queries from data collected by Azure Monitor Logs and interactively analyze their results. Records retrieved from Log Analytics queries help provide various insights into your data.
16+
Log Analytics is a tool in the Azure portal that helps you run server diagnostics on your API for Cassandra account.
1717

1818
## Prerequisites
1919

20-
- Create a [Log Analytics Workspace](../../azure-monitor/logs/quick-create-workspace.md).
21-
- Create [Diagnostic Settings](../monitor-resource-logs.md).
20+
- Create a [Log Analytics workspace](../../azure-monitor/logs/quick-create-workspace.md).
21+
- Create [diagnostic settings](../monitor-resource-logs.md).
2222
- Start [log analytics](../../azure-monitor/logs/log-analytics-overview.md) on your API for Cassandra account.
2323

2424
## Use Log Analytics
2525
After you've completed the log analytics setup, you can begin to explore your logs to gain more insights.
2626

2727
### Explore Data Plane Operations
28-
Use the CDBCassandraRequests table to see data plane operations specifically for your API for Cassandra account. A sample query to see the topN(10) consuming request and get detailed information on each request made.
28+
Use the [CDBCassandraRequests table](/azure/azure-monitor/reference/tables/cdbcassandrarequests) to see data plane operations specifically for your API for Cassandra account. A sample query to see the topN(10) consuming request and get detailed information on each request made.
2929

3030
```Kusto
3131
CDBCassandraRequests
@@ -35,33 +35,10 @@ CDBCassandraRequests
3535
| take 10
3636
```
3737

38-
#### Error Codes and Possible Solutions
39-
|Status Code | Error Code | Description |
40-
|------------|----------------------|--------------|
41-
| 200 | -1 | Successful |
42-
| 400 | 8704 | The query is correct but an invalid syntax. |
43-
| 400 | 8192 | The submitted query has a syntax error. Review your query. |
44-
| 400 | 8960 | The query is invalid because of some configuration issue. |
45-
| 401 |8448 | The logged user does not have the right permissions to perform the query. |
46-
| 403 | 8448 | Forbidden response as the user may not have the necessary permissions to carry out the request. |
47-
| 404 | 5376 | A non-timeout exception during a write request as a result of response not found. |
48-
| 405 | 0 | Server-side Cassandra error. The error rarely occurs, open a support ticket. |
49-
| 408 | 4608 | Timeout during a read request. |
50-
| 408 | 4352 | Timeout exception during a write serviceRequest. |
51-
| 409 | 9216 | Attempting to create a keyspace or table that already exist. |
52-
| 412 | 5376 | Precondition failure. To ensure data integrity, we ensure that the write request based on the read response is true. A non-timeout write request exception is returned. |
53-
| 413 | 5376 | This non-timeout exception during a write request is because of payload maybe too large. Currently, there is a limit of 2MB per row. |
54-
| 417 | 9472 | The exception is thrown when a prepared statement is not cached on the server node. It should be transient/non-blocking. |
55-
| 423 | 5376 | There is a lock because a write request that is currently processing. |
56-
| 429 | 4097| Overload exception is as a result of RU shortage or high request rate. Probably need more RU to handle the higher volume request. In, native Cassandra this can be interpreted as one of the VMs not having enough CPU. We advise reviewing current data model to ensure that you do not have excessive skews that might be causing hot partitions. |
57-
| 449 | 5376 | Concurrent execution exception. This occurs to ensure only one write update at a time for a given row. |
58-
| 500 | 0 | Server cassandraError: something unexpected happened. This indicates a server-side bug. |
59-
| 503 | 4096 | Service unavailable. |
60-
| | 256 | This may be because of invalid connection credentials. Please check your connection credentials. |
61-
| | 10 | A client message triggered protocol violation. An example is query message sent before a startup one has been sent. |
38+
For a list of error codes and their possible solutions, see [Error codes](../monitor-reference.md#error-codes-for-cassandra).
6239

6340
### Troubleshoot Query Consumption
64-
The CDBPartitionKeyRUConsumption table contains details on request unit (RU) consumption for logical keys in each region within each of their physical partitions.
41+
The [CDBPartitionKeyRUConsumption table](/azure/azure-monitor/reference/tables/cdbpartitionkeyruconsumption) contains details on request unit (RU) consumption for logical keys in each region within each of their physical partitions.
6542

6643
```Kusto
6744
CDBPartitionKeyRUConsumption
@@ -70,7 +47,7 @@ CDBPartitionKeyRUConsumption
7047
```
7148

7249
### Explore Control Plane Operations
73-
The CBDControlPlaneRequests table contains details on control plane operations, specifically for API for Cassandra accounts.
50+
The [CBDControlPlaneRequests table](/azure/azure-monitor/reference/tables/cdbcontrolplanerequests) contains details on control plane operations, specifically for API for Cassandra accounts.
7451

7552
```Kusto
7653
CDBControlPlaneRequests

articles/cosmos-db/cassandra/monitor-insights.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,26 +49,26 @@ Exceeding provisioned throughput could be one of the reasons. Enable [Server Sid
4949

5050

5151
## System and management operations
52-
The system view helps show metadata requests count by primary partition. It also helps identify throttled requests. The management operation shows the account activities such as creation, deletion, key, network and replication settings. Request volume per status code over a time period.
52+
The system view helps show metadata requests count by primary partition. It also helps identify throttled requests. The management operation shows the account activities such as creation, deletion, key, network, and replication settings. Request volume per status code over a time period.
5353

5454
:::image type="content" source="./media/monitor-insights/metadata-requests-status-code.png" alt-text="Screenshot showing request status code based on metadata.":::
5555

5656
- Metric chart for account diagnostic, network and replication settings over a specified period and filtered based on a Keyspace.
5757

58-
:::image type="content" source="./media/monitor-insights/diagnostic-network-replication.png" alt-text="Screenshot of diagnostic network replication for a API for Cassandra account.":::
58+
:::image type="content" source="./media/monitor-insights/diagnostic-network-replication.png" alt-text="Screenshot of diagnostic network replication for a Cassandra account API.":::
5959

6060

6161
- Metric chart to view account key rotation.
6262

6363
You can view changes to primary or secondary password for your API for Cassandra account.
6464

65-
:::image type="content" source="./media/monitor-insights/cosmos-db-account-key.png" alt-text="Screenshot showing Azure Cosmos DB rotation key for a API for Cassandra account.":::
65+
:::image type="content" source="./media/monitor-insights/cosmos-db-account-key.png" alt-text="Screenshot showing Azure Cosmos DB rotation key for a Cassandra account API.":::
6666

6767

6868
## Storage
6969
Storage distribution for raw and index storage. Also a count of documents in the API for Cassandra account.
7070

71-
:::image type="content" source="./media/monitor-insights/data-index-usage.png" alt-text="Diagram showing the document count within a API for Cassandra account.":::
71+
:::image type="content" source="./media/monitor-insights/data-index-usage.png" alt-text="Diagram showing the document count within an API for Cassandra account.":::
7272

7373
Maximum request units consumption for an account over a defined time period.
7474

@@ -89,9 +89,9 @@ The chart below shows if your application’s high RU consumption is because of
8989

9090
:::image type="content" source="./media/monitor-insights/normalized-ru-pk-rangeid.png" alt-text="Screenshot showing normalized request unit consumption by partition key range ID.":::
9191

92-
The chart below shows a breakdown of requests by different status code. Understand the meaning of the different codes for your [API for Cassandra codes](./error-codes-solution.md).
92+
The chart below shows a breakdown of requests by different status code. Understand the meaning of the different codes for your [API for Cassandra codes](../monitor-reference.md#error-codes-for-cassandra).
9393

94-
:::image type="content" source="./media/monitor-insights/total-request-by-status-code.png" alt-text="Screenshot image of a graph showing the total request by status code for a cassandra api account.":::
94+
:::image type="content" source="./media/monitor-insights/total-request-by-status-code.png" alt-text="Screenshot image of a graph showing the total request by status code for a Cassandra API account.":::
9595

9696

9797
## Next steps

articles/cosmos-db/concepts-limits.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ An Azure Cosmos DB container (or shared throughput database) using manual throug
4646

4747
The current and minimum throughput of a container or a database can be retrieved from the Azure portal or the SDKs. For more information, see [Allocate throughput on containers and databases](set-throughput.md).
4848

49-
The actual minimum RU/s may vary depending on your account configuration. You can use [Azure Monitor metrics](monitor.md#view-operation-level-metrics-for-azure-cosmos-db) to view the history of provisioned throughput (RU/s) and storage on a resource.
49+
The actual minimum RU/s might vary depending on your account configuration. You can use [Azure Monitor metrics](monitor.md#analyze-azure-cosmos-db-metrics) to view the history of provisioned throughput (RU/s) and storage on a resource.
5050

5151
#### Minimum throughput on container
5252

@@ -290,9 +290,9 @@ The following table lists the limits specific to MongoDB feature support. Other
290290
| Maximum execution time for MongoDB operations (for 3.6 and 4.0 server version)| 60 seconds|
291291
| Maximum level of nesting for embedded objects / arrays on index definitions | 6 |
292292
| Idle connection timeout for server side connection closure ² | 30 minutes |
293-
| Time limit for MongoDB shell in the Azure Portal | 120 minutes in a 24hr period |
293+
| Time limit for MongoDB shell in the Azure portal | 120 minutes in a 24hr period |
294294

295-
¹ Large document sizes up to 16 MB require feature enablement in Azure portal. Read the [feature documentation](../cosmos-db/mongodb/feature-support-42.md#data-types) to learn more.
295+
¹ Large document sizes up to 16 MB require feature enablement in the Azure portal. Read the [feature documentation](../cosmos-db/mongodb/feature-support-42.md#data-types) to learn more.
296296

297297
² We recommend that client applications set the idle connection timeout in the driver settings to 2-3 minutes because the [default timeout for Azure LoadBalancer is 4 minutes](../load-balancer/load-balancer-tcp-idle-timeout.md). This timeout ensures that an intermediate load balancer idle doesn't close connections between the client machine and Azure Cosmos DB.
298298

articles/cosmos-db/gremlin/TOC.yml

Lines changed: 3 additions & 3 deletions
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

0 commit comments

Comments
 (0)