Manage the MongoDB Agent Functions
On this page
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
Manage Backup Function
Activate Backup
In MongoDB Cloud Manager, go to the Deployment page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Deployment page is not already displayed, click Deployment in the sidebar.
The Deployment page displays.
Go to the Servers page.
Click the Servers tab for your deployment.
The Servers page displays.
Activate the agent.
On the host where you want to activate Backup, click .
Click Activate Backup.
From the banner, click Review & Deploy.
If you want to activate Backup, click Confirm & Deploy. Otherwise click Cancel, then Discard Changes to cancel activating Backup.
Note
On the Server tab, the host that is tailing the oplog from each primary displays Backup - active. Any other host with Backup activated displays Backup - standby.
Deactivate Backup
In MongoDB Cloud Manager, go to the Deployment page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Deployment page is not already displayed, click Deployment in the sidebar.
The Deployment page displays.
Go to the Servers page.
Click the Servers tab for your deployment.
The Servers page displays.
Manage Monitoring Function
Activate Monitoring
In MongoDB Cloud Manager, go to the Deployment page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Deployment page is not already displayed, click Deployment in the sidebar.
The Deployment page displays.
Go to the Servers page.
Click the Servers tab for your deployment.
The Servers page displays.
Activate monitoring.
On the host where you want to activate Monitoring, click .
Click Activate Monitoring.
From the banner, click Review & Deploy.
If you want to activate Monitoring, click Confirm & Deploy. Otherwise click Cancel, then Discard Changes to cancel activating Monitoring.
Note
On the Server tab, the host that distributes monitoring work to each running monitoring agent displays Monitoring - active. Any other host with Monitoring activated displays Monitoring - standby.
You can activate Monitoring on multiple MongoDB Agents to distribute monitoring assignments and provide failover. Cloud Manager distributes monitoring assignments among up to 100 running MongoDB Agents. Each MongoDB Agent running active Monitoring monitors a different set of MongoDB processes. One MongoDB Agent running active Monitoring per project is the primary Monitor. The primary Monitor reports the cluster's status to Cloud Manager. As MongoDB Agents have Monitoring enabled or disabled, Cloud Manager redistributes assignments. If the primary Monitor fails, Cloud Manager assigns another MongoDB Agent running active Monitoring to be the primary Monitor.
If you run more than 100 MongoDB Agents with active Monitoring, the additional MongoDB Agents run as standby MongoDB Agents. A standby MongoDB Agent is idle, except to log its status as a standby and periodically ask Cloud Manager if it should begin monitoring.
If you install multiple Monitoring Agents, ensure that all the
MongoDB Agents with active Monitoring can reach all the mongod
processes in the deployment.
To activate Monitoring on multiple MongoDB Agents, repeat the activation process on multiple MongoDB Agents.
Deactivate Monitoring
In MongoDB Cloud Manager, go to the Deployment page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it's not already displayed, select your desired project from the Projects menu in the navigation bar.
If the Deployment page is not already displayed, click Deployment in the sidebar.
The Deployment page displays.
Go to the Servers page.
Click the Servers tab for your deployment.
The Servers page displays.
Manage Automation Function
Activate Automation
Automation is activated when you:
Deploy a standalone MongoDB instance
Deploy a replica set
Deploy a sharded cluster
Import an existing MongoDB deployment into Cloud Manager.