Azure Document DB Collection

Available Metrics

Possible metric types that can be tracked on a given resource.

Metric Type Data Type Description
AggregatedMetric
Object
Allows for aggregating existing metrics over a period of time. Useful for running sums or averages; also for extracting single data item from collection-based metrics
AzureAdvisorHealthMetric
AzureAdvisorHealth
AvailabilityState String
Summary String
ReasonType String
ReasonChronicity String
DetailedStatus String
OccuredTime DateTime
ReportedTime DateTime
Tracks Azure health using latest Azure Health API - more info @ https://docs.microsoft.com/en-us/rest/api/resourcehealth/availabilitystatuses/getbyresource/
AzureAdvisorRecommendationMetric
AzureAdvisorRecommendation[]
Category String
Impact String
LastUpdated Nullable`1
Risk String
Problem String
Solution String
Tracks Azure recommendations using latest Azure Advisor API - more info @ https://docs.microsoft.com/en-us/rest/api/advisor/
AzureDocumentDbAccountMetric
Double
Tracks various DocumentDB metrics on the DocumentDb account level.
AzureDocumentDbCollectionMetric
Double
Tracks various DocumentDB metrics on the documents collection level.
AzureDocumentDbDatabaseMetric
Double
Tracks various DocumentDB metrics on the database level.
AzureDocumentDbDocumentCount
Double
Tracks the document count on the current DocumentDb collection.
AzureDocumentDbOperations
AzureOperation
Name String
Category String
Description String
Caller String
EventName String
Level String
Status String
SubStatus String
ExtendedInfo String
EventTimestamp DateTime
Tracks the log of Azure management operations on the monitored resource.
AzureDocumentDbScript
Object[]
Tracks any value retrieved using custom Document DB SQL-like script. The query returns data in the JSON format. Query result must not exceed 64 KB when JSON serialized to be properly displayed in the dashboards.
AzureDocumentDbUtilization
Double
Tracks any value exposed by calling DocumentClient.ReadDocumentCollectionAsync method. Requires specifying Metric Definition, i.e. selecting field that will be tracked for this metric such as DatabaseUsage or StoredProceduresQuota.
AzureMonitorMetric
Double
Tracks Azure metrics using latest Azure Monitor API - more info @ https://docs.microsoft.com/en-us/rest/api/monitor/
DerivedMetric
Double
Allows for deriving new metrics from existing ones. Useful for combining existing metrics together or for multiplying metrics by a factor
LinkedMetric
Object
Allows for tracking of metrics from other resources. Useful when it is important to evaluate metrics from different resources side-by-side
ResourceInstanceCount
Int32
Tracks current number of compute instances
ResourceStatus
String
Tracks overall status of the resource. This is an important metric as it is used to drive Uptime reports. Possible values: Ready, Down, Unknown and in some cases Stopped
ResponseTime
Double
Measures time to connect to resource

Available Commands

Possible commands that can be executed on a given resource. Ultimate subscription is required.

Command Type Description
AzureDocumentDbResize Resizes Azure Documentation database
WebRequest Runs custom WebRequest to specified URL

Default Templates

CloudMonix provided default monitoring templates.

Pre-configured Metrics

Metric Name Metric Type Description
DocumentCount AzureDocumentDbDocumentCount
RecommendedActions AzureAdvisorRecommendationMetric Tracks recommended actions for specified resource.
ResponseTime ResponseTime Tracks resource's response time. Metric measures how many milliseconds it took to open an active connection to DocumentDb and perform a test R/W operation
Size AzureDocumentDbUtilization Current size of a collection in kilobytes
Status ResourceStatus Tracks the overall readiness status of the monitored resource. Possible values are: Ready, Down, and Unknown
TotalRequests AzureMonitorMetric

Pre-configured Alerts

Alert Name Expression Severity Description
Resource Outage Status == "Down" Error Raises an alert when connectivity cannot be established, after specified number of retries on the Advanced tab for sustained period of time