Skip to content

Commit 528946c

Browse files
v-thepetv-thepet
committed
fixes
1 parent 9ac56d7 commit 528946c

File tree

2 files changed

+27
-22
lines changed

2 files changed

+27
-22
lines changed

‎articles/cosmos-db/monitor-reference.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,27 +46,29 @@ For a list of all Azure Monitor supported metrics, including Azure Cosmos DB, se
4646
### Supported metrics for Microsoft.DocumentDB/DatabaseAccounts
4747
The following table lists the metrics available for the Microsoft.DocumentDB/DatabaseAccounts resource type.
4848
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
49-
[Microsoft.DocumentDB/DatabaseAccounts](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-documentdb-databaseaccounts-metrics-include.md)]
49+
[!INCLUDE [Microsoft.DocumentDB/DatabaseAccounts](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-documentdb-databaseaccounts-metrics-include.md)]
5050

5151
### Supported metrics for Microsoft.DocumentDB/cassandraClusters
5252
The following table lists the metrics available for the Microsoft.DocumentDB/cassandraClusters resource type.
5353
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
54-
[Microsoft.DocumentDB/cassandraClusters](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-documentdb-cassandraclusters-metrics-include.md)]
54+
[!INCLUDE [Microsoft.DocumentDB/cassandraClusters](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-documentdb-cassandraclusters-metrics-include.md)]
5555

5656
### Supported metrics for Microsoft.DocumentDB/mongoClusters
5757
The following table lists the metrics available for the Microsoft.DocumentDB/mongoClusters resource type.
5858
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
59-
[Microsoft.DocumentDB/mongoClusters](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-documentdb-mongoclusters-metrics-include.md)]
59+
[!INCLUDE [Microsoft.DocumentDB/mongoClusters](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-documentdb-mongoclusters-metrics-include.md)]
6060

61-
### Request metrics
61+
### Metrics by category
62+
63+
#### Request metrics
6264

6365
|Metric (Metric Display Name)|Unit (Aggregation Type) |Description|Dimensions| Time granularities| Legacy metric mapping | Usage |
6466
|---|---|---|---| ---| ---| ---|
6567
| TotalRequests (Total Requests) | Count (Count) | Number of requests made| DatabaseName, CollectionName, Region, StatusCode| All | TotalRequests, Http 2xx, Http 3xx, Http 400, Http 401, Internal Server error, Service Unavailable, Throttled Requests, Average Requests per Second | Used to monitor requests per status code, container at a minute granularity. To get average requests per second, use Count aggregation at minute and divide by 60. |
6668
| MetadataRequests (Metadata Requests) |Count (Count) | Count of Azure Resource Manager metadata requests. Metadata has request limits. See [Control Plane Limits](concepts-limits.md#control-plane) for more information. | DatabaseName, CollectionName, Region, StatusCode| All | | Used to monitor metadata requests in scenarios where requests are being throttled. See [Monitor Control Plane Requests](use-metrics.md#monitor-control-plane-requests) for more information. |
6769
| MongoRequests (Mongo Requests) | Count (Count) | Number of Mongo Requests Made | DatabaseName, CollectionName, Region, CommandName, ErrorCode| All |Mongo Query Request Rate, Mongo Update Request Rate, Mongo Delete Request Rate, Mongo Insert Request Rate, Mongo Count Request Rate| Used to monitor Mongo request errors, usages per command type. |
6870

69-
### Request Unit metrics
71+
#### Request Unit metrics
7072

7173
|Metric (Metric Display Name)|Unit (Aggregation Type)|Description|Dimensions| Time granularities| Legacy metric mapping | Usage |
7274
|---|---|---|---| ---| ---| ---|
@@ -76,7 +78,7 @@ The following table lists the metrics available for the Microsoft.DocumentDB/mon
7678
| AutoscaleMaxThroughput (Autoscale Max Throughput)| Count (Maximum) |Autoscale max throughput at container granularity| DatabaseName, ContainerName| 5M| | Used to monitor autoscale max throughput per container.|
7779
| PhysicalPartitionThroughputInfo (Physical Partition Throughput Info)| Count (Maximum) |Provisioned throughput at physical partition granularity| DatabaseName, ContainerName, PhysicalPartitionId, Region| 5M| | Used to monitor provisioned throughput per physical partition. If resource is autoscale, represents autoscale max RU/s per physical partition. To see provisioned throughput for all physical partitions, split by dimension Physical Partition Id.|
7880

79-
### Storage metrics
81+
#### Storage metrics
8082

8183
|Metric (Metric Display Name)|Unit (Aggregation Type)|Description|Dimensions| Time granularities| Legacy metric mapping | Usage |
8284
|---|---|---|---| ---| ---| ---|
@@ -87,20 +89,20 @@ The following table lists the metrics available for the Microsoft.DocumentDB/mon
8789
| DocumentCount (Document Count) | Count (Total) |Total document count reported at 5-minutes granularity per region| DatabaseName, CollectionName, Region| 5M |Document Count|Used to monitor document count at container and region, minimum granularity should be 5 minutes.|
8890
| PhysicalPartitionSizeInfo (Physical Partition Size Info) | Count (Maximum) | Storage at physical partition granularity| DatabaseName, ContainerName, PhysicalPartitionId, Region| 5M | |Used to monitor physical partition size (bytes) at physical partition granularity. To see storage for all physical partitions, split by dimension Physical Partition Id.|
8991

90-
### Latency metrics
92+
#### Latency metrics
9193

9294
|Metric (Metric Display Name)|Unit (Aggregation Type)|Description|Dimensions| Time granularities| Usage |
9395
|---|---|---|---| ---| ---|
9496
| ReplicationLatency (Replication Latency)| MilliSeconds (Minimum, Maximum, Average) | P99 Replication Latency across source and target regions for geo-enabled account| SourceRegion, TargetRegion| All | Used to monitor P99 replication latency between any two regions for a geo-replicated account. |
9597
| Server Side Latency| MilliSeconds (Average) | Time taken by the server to process the request. | CollectionName, ConnectionMode, DatabaseName, OperationType, PublicAPIType, Region | All | Used to monitor the request latency on the Azure Cosmos DB server. |
9698

97-
### Availability metrics
99+
#### Availability metrics
98100

99101
|Metric (Metric Display Name) |Unit (Aggregation Type)|Description| Time granularities| Legacy metric mapping | Usage |
100102
|---|---|---|---| ---| ---|
101103
| ServiceAvailability (Service Availability)| Percent (Minimum, Maximum) | Account requests availability at one hour granularity| 1H | Service Availability | Represents the percent of total passed requests. A request is considered to be failed due to system error if the status code is 410, 500 or 503 Used to monitor availability of the account at hour granularity. |
102104

103-
### API for Cassandra metrics
105+
#### API for Cassandra metrics
104106

105107
|Metric (Metric Display Name)|Unit (Aggregation Type)|Description|Dimensions| Time granularities| Usage |
106108
|---|---|---|---| ---| ---|
@@ -129,7 +131,7 @@ The following table lists the metrics available for the Microsoft.DocumentDB/mon
129131
### Supported resource logs for Microsoft.DocumentDB/cassandraClusters
130132
[!INCLUDE [Microsoft.DocumentDB/cassandraClusters](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-documentdb-cassandraclusters-logs-include.md)]
131133

132-
### Supported resource logs for Microsoft.DocumentDB/DatabaseAccounts
134+
### Supported resource logs for Microsoft.DocumentDB/mongoClusters
133135
[!INCLUDE [Microsoft.DocumentDB/mongoClusters](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-documentdb-mongoclusters-logs-include.md)]
134136

135137
<!-- ## Azure Monitor Logs tables. Required section. -->
@@ -149,11 +151,12 @@ Microsoft.DocumentDb/databaseAccounts
149151
- [CDBControlPlaneRequests](/azure/azure-monitor/reference/tables/CDBControlPlaneRequests#columns)
150152
- [AzureMetrics](/azure/azure-monitor/reference/tables/AzureMetrics#columns)
151153
- [AzureDiagnostics](/azure/azure-monitor/reference/tables/AzureDiagnostics#columns)
154+
152155
Logs are collected in the **AzureDiagnostics** table under the resource provider name of `MICROSOFT.DOCUMENTDB`.
153-
154-
## Azure CosmosDB resource logs properties
155156

156-
The following table lists the properties of resource logs in Azure Cosmos DB. The resource logs are collected into Azure Monitor Logs or Azure Storage.
157+
### Azure CosmosDB resource logs properties
158+
159+
The following table lists properties of resource logs in Azure Cosmos DB. The resource logs are collected into Azure Monitor Logs or Azure Storage.
157160

158161
| Azure Storage field or property | Azure Monitor Logs property | Description |
159162
| --- | --- | --- |

‎articles/cosmos-db/monitor.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,10 @@ At a minimum your service should have the following two articles:
4444

4545
Azure Cosmos DB insights is a feature based on the [workbooks feature of Azure Monitor](/azure/azure-monitor/visualize/workbooks-overview). Use Azure Cosmos DB insights for a view of the overall performance, failures, capacity, and operational health of all your Azure Cosmos DB resources in a unified interactive experience.
4646

47-
For more information about Azure Cosmos DB insights, see [Azure Cosmos DB insights](insights-overview.md) and [Scenarios to monitor](use-metrics.md).
47+
For more information about Azure Cosmos DB insights, see the following articles:
48+
49+
- [Explore Azure Cosmos DB insights](insights-overview.md)
50+
- [Monitor and debug with insights in Azure Cosmos DB](use-metrics.md).
4851

4952
<!-- ## Resource types. Required section. -->
5053
[!INCLUDE [horz-monitor-resource-types](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-resource-types.md)]
@@ -78,9 +81,8 @@ Custom imported service-specific information. Add service-specific information a
7881

7982
<!-- ## Non-Azure Monitor metrics. Optional. If your service uses any non-Azure Monitor based metrics, add the following include and information.-->
8083
[!INCLUDE [horz-monitor-custom-metrics](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-non-monitor-metrics.md)]
81-
For information about partner solutions and tools that can help monitor Azure Cosmos DB, see [Monitor Azure Cosmos DB using third-party solutions](monitoring-solutions.md).
82-
83-
To implement Micrometer metrics in the Java SDK for Azure Cosmos DB by consuming Prometheus metrics, see [Use Micrometer client metrics for Java](nosql/client-metrics-java.md).
84+
- For information about partner solutions and tools that can help monitor Azure Cosmos DB, see [Monitor Azure Cosmos DB using third-party solutions](monitoring-solutions.md).
85+
- To implement Micrometer metrics in the Java SDK for Azure Cosmos DB by consuming Prometheus metrics, see [Use Micrometer client metrics for Java](nosql/client-metrics-java.md).
8486

8587
<!-- METRICS SECTION END ------------------------------------->
8688

@@ -165,14 +167,13 @@ For the types of resource logs collected for Azure Cosmos DB, see [Azure Cosmos
165167
See the following articles for more information about working with Azure Monitor Logs for Azure Cosmos DB:
166168

167169
- [Monitor data by using Azure Diagnostic settings](monitor-resource-logs.md)
168-
[Audit control plane logs](audit-control-plane-logs.md)
169-
[Add a transformation for workspace data](tutorial-log-transformation.md)
170-
[Use Micrometer client metrics for Java](client-metrics-java.md)
170+
- [Audit control plane logs](audit-control-plane-logs.md)
171+
- [Add a transformation for workspace data](tutorial-log-transformation.md)
171172

172173
<!-- ### Sample Kusto queries. Required section. If you have sample Kusto queries for your service, add them after the include. -->
173174
[!INCLUDE [horz-monitor-kusto-queries](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-kusto-queries.md)]
174175

175-
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 a [resource-specific tables](/azure/azure-monitor/essentials/resource-logs#resource-specific) or 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 selected when you enabled diagnostics logs.
176+
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 a [resource-specific tables](/azure/azure-monitor/essentials/resource-logs#resource-specific) or 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.
176177

177178
Here are some queries that you can enter into the **Log search** search bar to help you monitor your Azure Cosmos DB resources.
178179

@@ -297,7 +298,8 @@ The following table lists some common and recommended alert rules for Azure Cosm
297298
|Region failed over |Operator: *Greater than*, Aggregation type: *Count*, Threshold value: 1 | When a single region is failed over. This alert is helpful if you didn't enable service-managed failover. |
298299
|Rotate keys (activity log alert)| Event level: *Informational*, *Status*: started| Alerts when the account keys are rotated. You can update your application with the new keys. |
299300

300-
For more information and instructions on creating alerts for Azure Cosmos DB, see [Create alert on metrics](create-alerts.md). To create an alert to monitor if storage for a logical partition key is approaching 20 GB, see [Create alert on logical partition key size](how-to-alert-on-logical-partition-key-storage-size.md).
301+
- For more information and instructions on creating alerts for Azure Cosmos DB, see [Create alert on metrics](create-alerts.md).
302+
- To create an alert to monitor if storage for a logical partition key is approaching 20 GB, see [Create alert on logical partition key size](how-to-alert-on-logical-partition-key-storage-size.md).
301303

302304
<!-- ### Advisor recommendations. Required section. -->
303305
[!INCLUDE [horz-monitor-advisor-recommendations](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-advisor-recommendations.md)]

0 commit comments

Comments
 (0)