Microsoft Azure DocumentDB is a document database service with multi-region replication.
This step-by-step guide explains how to setup and monitor Azure DocumentDB Collection using CloudMonix.
In this article
1. Monitoring setup
2. Collect, understand and use your data
2.1 Metrics
2.2 Alerts
2.3 Actions
3. Setup verification and troubleshooting
Did you know?
CloudMonix extends native Azure DocumentDB monitoring with advanced metrics and features. Noteworthy:
- CloudMonix connects to Azure DocumentDB directly from within own cloud premise thru user-defined IP address and port which need to be white-listed as described in this article
- CloudMonix receives data from the Azure Management API, Azure Monitor API and by directly querying databases
- pre-configured metrics: document count, recommended actions, response time, collection size, resource status and total requests
- alerts on resource outages
- ability to resize Azure DocumentDB resource based on conditions or schedule
Setup
a. Run the Setup Wizard in the portal (preferred way):
This article explains how to add resources to CloudMonix via the Setup Wizard.
b. Firewall configuration:
CloudMonix monitoring services are hosted in Azure and use static IP addresses to perform monitoring. In certain circumstances user-defined firewall rules may prevent CloudMonix from accessing the monitored resources. Given this scenario, it is necessary to white-list CloudMonix IP addresses as described in this article.
c. Tweak settings in the Definition tab (optional):
Definition tab for an existing resource can be accessed by clicking the resource's monitoring settings in the performance dashboard:
Definition tab provides optional settings for the resource name, credentials, Azure resource management token, Azure resource group, Azure resource name, database, document collection, scale-up / scale-down cooling periods, configuration template and categories:
Best Practices
Configuration Template setting provides pre-defined configuration templates available in CloudMonix by default as well as previously stored custom templates. See predefined templates for Azure DocumentDB for reference.
d. Manual setup (optional instead of the Setup Wizard route):
Click the Add New button in the top right corner of your dashboard:
Fill in required information in the Definition tab as described in the previous step.
e. Advanced configuration:
Advanced configuration tab provides additional monitoring settings, which are already set as default for most use-cases.
f. Scale Ranges and Scale Adjustments:
Auto-scaling and scale adjustments provide powerful reactive, proactive and scheduled auto-scaling rules. These settings can be accessed via the Scale Ranges and Scale Adjustments tabs:
Read the full article on how to use auto-scaling and scale adjustments features in CloudMonix.
Collect, understand and use your data
Specific Metrics, Templates, Alerts and Automation Actions for Azure DocumentDB:
a. Metrics:
Diagnostic data points retrieved from the monitored resource are referred to as metrics . CloudMonix provides default templates for the metrics recommended for common configurations. Metrics can be further added, removed or customized in the Metrics tab of the Azure DocumentDB resource configuration dialog:
b. Alerts:
CloudMonix features a sophisticated alert engine that allows alerts to be published for very particular conditions pre-defined by a template configuration or custom based on any of the available metrics. Alerts can be further added, removed or customized in the Alerts tab of the Azure DocumentDB resource configuration dialog:
c. Actions:
Actions are automation features that can be configured to fire based on specific conditions or schedule. Actions can be added and configured in the Actions tab of the Azure DocumentDB resource configuration dialog:
Available actions include the ability to resize Azure DocumentDB resource based on conditions or schedule.
Setup verification and troubleshooting
a. Setup verification:
Successful resource setup can be verified by clicking Test button in the resource configuration dialog and visiting the Test Results tab:
b. Troubleshooting monitoring issues:
CloudMonix provides deep insights into resource monitoring issues via the Status Dashboard screen. The screen allows to overview resources that have raised alerts and troubleshoot them by diving into the monitoring logs.
Read the full article on how to use Status Dashboard to diagnose resource monitoring issues.