MongoDB Management Service MongoDB, Inc. Contents Release 1.7-pre

Document technical information

Format pdf
Size 894.0 kB
First found Jun 9, 2017

Document content analysis

Language
English
Type
not defined
Concepts
no text concepts found

Persons

Organizations

Places

Transcript

MongoDB Management Service
Release 1.7-pre
MongoDB, Inc.
March 23, 2015
Contents
1
2
Getting Started
1.1 Getting Started . . .
Introduction . . . . .
Get Started . . . . .
Next Steps . . . . . .
1.2 Functional Overview
Overview . . . . . .
Monitoring . . . . .
Automation . . . . .
Backup . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
8
8
8
9
9
9
9
9
9
10
Create a New MongoDB Deployment
2.1 Add Servers to MMS . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . .
Add Existing Servers to MMS . . . . . .
Configure AWS Integration . . . . . . . .
Add AWS Servers to MMS . . . . . . . .
2.2 Deploy a Replica Set . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . .
Consideration . . . . . . . . . . . . . . .
Prerequisites . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . .
2.3 Deploy a Sharded Cluster . . . . . . . . .
Overview . . . . . . . . . . . . . . . . .
Prerequisites . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . .
2.4 Deploy a Standalone MongoDB Instance .
Overview . . . . . . . . . . . . . . . . .
Prerequisites . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . .
2.5 Connect to a MongoDB Process . . . . .
Overview . . . . . . . . . . . . . . . . .
Firewall Rules . . . . . . . . . . . . . . .
Procedures . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
11
11
11
12
13
15
16
16
16
16
16
17
17
17
17
18
18
18
18
19
19
19
19
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
3
4
2
Import an Existing MongoDB Deployment
3.1 Add Existing MongoDB Processes to Monitoring
Overview . . . . . . . . . . . . . . . . . . . . .
Prerequisite . . . . . . . . . . . . . . . . . . . .
Add MongoDB Processes . . . . . . . . . . . . .
3.2 Add Monitored Processes to Automation . . . . .
Overview . . . . . . . . . . . . . . . . . . . . .
Prerequisites . . . . . . . . . . . . . . . . . . . .
Procedures . . . . . . . . . . . . . . . . . . . . .
3.3 Reactivate Monitoring for a Process . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . . . . . .
3.4 Remove Hosts . . . . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . . . . . .
3.5 Edit Authentication Credentials . . . . . . . . . .
Procedures . . . . . . . . . . . . . . . . . . . . .
3.6 Edit SSL Use Setting . . . . . . . . . . . . . . .
Procedures . . . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
20
21
21
21
21
22
22
22
22
23
23
23
24
24
24
24
25
26
26
Manage Deployments
4.1 Edit a Replica Set . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . .
Procedures . . . . . . . . . . . . . . . . . . . .
Additional Information . . . . . . . . . . . . .
4.2 Migrate a Replica Set Member to a New Server
Overview . . . . . . . . . . . . . . . . . . . .
Considerations . . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . . . . .
4.3 Move or Add a Monitoring or Backup Agent . .
Overview . . . . . . . . . . . . . . . . . . . .
Procedures . . . . . . . . . . . . . . . . . . . .
4.4 Change the Version of MongoDB . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . .
Considerations . . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . . . . .
4.5 Restart a MongoDB Process . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . .
Considerations . . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . . . . .
4.6 Shut Down MongoDB Processes . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . . . . .
Additional Information . . . . . . . . . . . . .
4.7 Remove Processes from Monitoring . . . . . .
Overview . . . . . . . . . . . . . . . . . . . .
Consideration . . . . . . . . . . . . . . . . . .
Prerequisite . . . . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . . . . .
4.8 Connect to an AWS Server through SSH . . . .
Overview . . . . . . . . . . . . . . . . . . . .
Prerequisites . . . . . . . . . . . . . . . . . . .
Procedures . . . . . . . . . . . . . . . . . . . .
4.9 Alerts . . . . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
27
27
27
28
30
30
30
31
31
32
32
33
34
34
34
34
35
35
35
35
36
36
36
36
36
36
37
37
37
37
37
37
38
38
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Manage Host Alerts . . . . . .
Create an Alert Configuration .
Manage Alert Configuration .
Manage Alerts . . . . . . . . .
Alert Conditions . . . . . . . .
4.10 Monitoring Metrics . . . . . .
Deployment . . . . . . . . . .
Host Statistics . . . . . . . . .
Aggregated Cluster Statistics .
Replica Set Statistics . . . . .
Profile Databases . . . . . . .
4.11 View Logs . . . . . . . . . . .
Overview . . . . . . . . . . .
MongoDB Real-Time Logs . .
MongoDB On-Disk Logs . . .
Agent Logs . . . . . . . . . .
5
6
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
38
38
40
42
43
49
49
51
52
53
54
55
55
55
56
57
Back Up MongoDB Deployments
5.1 Backup Preparations . . . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . . . . .
Snapshot Frequency and Retention Policy . . . . . . .
Excluded Namespaces . . . . . . . . . . . . . . . . .
Storage Engine . . . . . . . . . . . . . . . . . . . . .
Resyncing Production Deployments . . . . . . . . . .
Checkpoints . . . . . . . . . . . . . . . . . . . . . . .
Snapshots when Agent Cannot Stop Balancer . . . . .
Snapshots when Agent Cannot Contact a mongod . .
5.2 Activate Backup . . . . . . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . . . . .
Prerequisites . . . . . . . . . . . . . . . . . . . . . . .
Procedure . . . . . . . . . . . . . . . . . . . . . . . .
5.3 Restore MongoDB Deployments . . . . . . . . . . . .
Restore a Sharded Cluster from a Backup . . . . . . .
Restore a Replica Set from a Backup . . . . . . . . . .
5.4 Restore MongoDB Instances with Backup . . . . . . .
Restore from a Stored Snapshot . . . . . . . . . . . .
Restore from a Point in the Last 24 Hours . . . . . . .
Restore a Single Database . . . . . . . . . . . . . . .
Seed a New Secondary from Backup Restore . . . . .
5.5 Backup Maintenance . . . . . . . . . . . . . . . . . .
Select Backup File Delivery Method and Format . . . .
Delete Snapshots for Replica Sets and Sharded Clusters
Stop, Start, or Disable the MMS Backup Service . . .
Resync Backup . . . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
57
58
58
58
58
58
58
59
59
59
59
59
59
59
60
61
65
69
69
70
71
72
73
73
74
75
76
Administration
6.1 Manage Your Account . . .
Account Page . . . . . . . .
Personalization Page . . . .
API Keys & Whitelists Page
My Groups Page . . . . . .
Group Settings Page . . . .
Users Page . . . . . . . . .
Agents Page . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
77
77
77
78
78
78
78
78
78
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
3
6.2
6.3
6.4
6.5
6.6
7
4
AWS Settings Page . . . . . . . . . . . . . . . . .
Billing/Subscriptions . . . . . . . . . . . . . . . .
Payment History . . . . . . . . . . . . . . . . . .
Manage Your Two-Factor Authentication Options .
Overview . . . . . . . . . . . . . . . . . . . . . .
Procedures . . . . . . . . . . . . . . . . . . . . . .
Security . . . . . . . . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . . .
SSL Encryption . . . . . . . . . . . . . . . . . . .
Access Control and Authentication . . . . . . . . .
MONGODB-CR . . . . . . . . . . . . . . . . . .
LDAP . . . . . . . . . . . . . . . . . . . . . . . .
Kerberos . . . . . . . . . . . . . . . . . . . . . . .
Two-Factor Authentication . . . . . . . . . . . . .
Required Ports and IP Addresses . . . . . . . . . .
Manage Groups . . . . . . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . . .
Working with Multiple Environments . . . . . . .
Procedures . . . . . . . . . . . . . . . . . . . . . .
Manage MMS Users and Roles . . . . . . . . . . .
Manage MMS Users . . . . . . . . . . . . . . . .
MMS Roles . . . . . . . . . . . . . . . . . . . . .
Manage MongoDB Users and Roles . . . . . . . .
Enable Access Control on MongoDB Deployments
Manage MongoDB Users and Roles . . . . . . . .
Manage Custom Roles . . . . . . . . . . . . . . .
API
7.1 Public API Principles .
Overview . . . . . . .
HTTP Methods . . . .
JSON . . . . . . . . .
Linking . . . . . . . .
Lists . . . . . . . . . .
Envelopes . . . . . . .
Pretty Printing . . . . .
Response Codes . . . .
Errors . . . . . . . . .
Authentication . . . . .
Automation . . . . . .
Rate Limiting . . . . .
Additional Information
7.2 Public API Resources .
Root . . . . . . . . . .
Hosts . . . . . . . . .
Metrics . . . . . . . .
Clusters . . . . . . . .
Groups . . . . . . . . .
Users . . . . . . . . .
Alerts . . . . . . . . .
Alert Configurations .
Backup Configurations
Snapshot Schedule . .
Snapshots . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
79
79
79
79
79
80
82
82
82
82
82
83
83
83
83
84
84
84
85
86
86
88
89
89
90
92
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
94
95
95
95
95
96
96
97
97
98
98
98
99
99
99
99
100
101
107
112
115
119
123
128
137
142
144
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
149
154
156
162
164
164
165
172
Troubleshooting
8.1 Getting Started Checklist . . . . . . . . . . . . . . . . . .
Authentication Errors . . . . . . . . . . . . . . . . . . . .
Check Agent Output or Log . . . . . . . . . . . . . . . .
Confirm Only One Agent is Actively Monitoring . . . . .
Ensure Connectivity Between Agent and Monitored Hosts
Ensure Connectivity Between Agent and MMS Server . .
Allow Agent to Discover Hosts and Collect Initial Data . .
8.2 Monitoring . . . . . . . . . . . . . . . . . . . . . . . . .
Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deployments . . . . . . . . . . . . . . . . . . . . . . . .
Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Munin . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8.3 Authentication . . . . . . . . . . . . . . . . . . . . . . . .
Two-Factor Authentication . . . . . . . . . . . . . . . . .
Using MMS Provisioning (Amazon Web Services) . . . .
All Deployments . . . . . . . . . . . . . . . . . . . . . .
8.4 Automation Checklist . . . . . . . . . . . . . . . . . . . .
Using Own Hardware . . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
174
174
175
175
175
175
175
175
175
175
176
177
177
178
178
178
179
180
180
Frequently Asked Questions
9.1 Management FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Can MMS Manage an Existing MongoDB Deployment? . . . . . . . . . . . . . . . . . . . . .
How does MMS Manage MongoDB deployments? . . . . . . . . . . . . . . . . . . . . . . . .
What versions of MongoDB can MMS Manage? . . . . . . . . . . . . . . . . . . . . . . . . .
How many Automation Agents do I need? . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Is any MongoDB data transferred by the Automation Agent? . . . . . . . . . . . . . . . . . . .
Will MMS handle failures during an upgrade, such as MMS going down or a network partition?
What types of deployment can I create in MMS? . . . . . . . . . . . . . . . . . . . . . . . . .
Can I deploy MongoDB to a cloud provider with MMS? . . . . . . . . . . . . . . . . . . . . .
How does an AWS security group affect access to MongoDB instances? . . . . . . . . . . . . .
9.2 Monitoring FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Host Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MMS Monitoring Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data Retention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
9.3 Backup FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Restoration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How much does it cost to use MMS Backup? . . . . . . . . . . . . . . . . . . . . . . . . . . .
9.4 Administration FAQs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User and Group Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
180
180
180
180
181
181
181
181
181
181
181
181
181
182
184
184
185
185
186
186
188
189
191
191
191
7.3
8
9
Restore Jobs . . . . . . . . . . . . . . . . . . .
Whitelist . . . . . . . . . . . . . . . . . . . . .
Automation Configuration . . . . . . . . . . .
Automation Status . . . . . . . . . . . . . . .
Public API Tutorials . . . . . . . . . . . . . .
Enable the Public API . . . . . . . . . . . . . .
Deploy a Cluster through the API . . . . . . .
Update the MongoDB Version of a Deployment
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
5
Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
About MMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
10 Reference
10.1 Automation Agent . . . . . . . . . . . . . . . . . .
Install the Automation Agent with rpm Packages . .
Install the Automation Agent with deb Packages . .
Install the Automation Agent from an Archive . . . .
Install the Automation Agent on OS X . . . . . . . .
10.2 Monitoring Agent . . . . . . . . . . . . . . . . . . .
Install Monitoring Agent . . . . . . . . . . . . . . .
Monitoring Agent Configuration . . . . . . . . . . .
Required Access for Monitoring Agent . . . . . . . .
Configure Monitoring Agent for Access Control . . .
Configure Monitoring Agent for SSL . . . . . . . . .
Configure Hardware Monitoring with munin-node
Start or Stop the Monitoring Agent . . . . . . . . . .
Remove Monitoring Agents from MMS . . . . . . .
10.3 Backup Agent . . . . . . . . . . . . . . . . . . . . .
Install Backup Agent . . . . . . . . . . . . . . . . .
Backup Agent Configuration . . . . . . . . . . . . .
Required Access for Backup Agent . . . . . . . . . .
Configure Backup Agent for Access Control . . . . .
Configure Backup Agent for SSL . . . . . . . . . . .
Start or Stop the Backup Agent . . . . . . . . . . . .
Remove the Backup Agent from MMS . . . . . . . .
10.4 Monitoring Reference . . . . . . . . . . . . . . . . .
Host Types . . . . . . . . . . . . . . . . . . . . . .
Host Process Types . . . . . . . . . . . . . . . . . .
Event Types . . . . . . . . . . . . . . . . . . . . . .
Alert Types . . . . . . . . . . . . . . . . . . . . . .
Chart Colors . . . . . . . . . . . . . . . . . . . . . .
Database Commands Used by the Monitoring Agent
10.5 Supported Browsers . . . . . . . . . . . . . . . . . .
10.6 Advanced Options for MongoDB Deployments . . .
Overview . . . . . . . . . . . . . . . . . . . . . . .
Advanced Options . . . . . . . . . . . . . . . . . . .
10.7 Automation Configuration . . . . . . . . . . . . . .
Overview . . . . . . . . . . . . . . . . . . . . . . .
Fields . . . . . . . . . . . . . . . . . . . . . . . . .
10.8 Supported MongoDB Options for Automation . . . .
Overview . . . . . . . . . . . . . . . . . . . . . . .
MongoDB 2.6 and Later Configuration Options . . .
MongoDB 2.4 and Earlier Configuration Options . .
10.9 AWS IAM Policy . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
193
194
194
196
197
199
200
201
212
214
216
220
221
223
224
224
224
237
239
240
245
246
247
247
247
248
248
248
248
249
250
250
250
250
251
251
251
261
261
262
263
264
11 Release Notes
11.1 Automation Agent Changelog .
Automation Agent 1.7.0.992
Automation Agent 1.6.2.960
Automation Agent 1.3.0.718
Automation Agent 0.4.0 . . .
11.2 Monitoring Agent Changelog . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
265
265
265
266
266
266
266
6
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Monitoring Agent 3.1.0.173 .
Monitoring Agent 3.0.0.167 .
Monitoring Agent 2.9.0.164 .
Monitoring Agent 2.8.0.143 .
Monitoring Agent 2.7.0.136 .
Monitoring Agent 2.6.0.123 .
Monitoring Agent 2.5.0 . . . .
Monitoring Agent 2.4.1.108 .
Monitoring Agent 2.4.0.101 .
Monitoring Agent 2.3.1.89-1
Monitoring Agent 2.2.0.70-1
Monitoring Agent 2.1.4.51-1
Monitoring Agent 2.1.2.43-1
Monitoring Agent 2.1.0 . . . .
Monitoring Agent 2.0.1 . . . .
Monitoring Agent 2.0.0 . . . .
Monitoring Agent 1.6.8 . . . .
Monitoring Agent 1.6.7 . . . .
Monitoring Agent 1.6.6 . . . .
Monitoring Agent 1.6.5 . . . .
Monitoring Agent 1.6.4 . . . .
Monitoring Agent 1.6.3 . . . .
Monitoring Agent 1.6.2 . . . .
Monitoring Agent 1.6.1 . . . .
Monitoring Agent 1.6.0 . . . .
Monitoring Agent 1.5.9 . . . .
Monitoring Agent 1.5.8 . . . .
Monitoring Agent 1.5.7 . . . .
Monitoring Agent 1.5.6 . . . .
11.3 Backup Agent Changelog . . . . .
Backup Agent 3.3.0.261 . . .
Backup Agent 3.2.0.262 . . .
Backup Agent 3.1.0.250 . . .
Backup Agent 3.0.0.246 . . .
Backup Agent 2.9.1.235-1 . .
Backup Agent 2.9.0.223 . . .
Backup Agent 2.8.0.204 . . .
Backup Agent 2.7.1.206 . . .
Backup Agent 2.7.0.193 . . .
Backup Agent 2.6.0.176 . . .
Backup Agent 2.5.0 . . . . . .
Backup Agent 2.4.0.156 . . .
Backup Agent 2.3.0.149 . . .
Backup Agent 2.2.2.125 . . .
Backup Agent 2.2.1.122 . . .
Backup Agent 2.1.0.106-1 . .
Backup Agent 2.0.0.90-1 . .
Backup Agent 1.6.1.87-1 . .
Backup Agent 1.6.0.55-1 . .
Backup Agent 1.4.6.43-1 . .
Backup Agent 1.4.4.34-1 . .
Backup Agent 1.4.3.28-1 . .
Backup Agent 1.4.2.23-1 . .
Backup Agent 1.4.0.17 . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
266
266
266
267
267
267
267
267
267
268
268
268
268
268
268
268
269
269
269
269
269
269
269
269
270
270
270
270
270
270
270
270
271
271
271
271
271
271
271
271
272
272
272
272
272
272
272
273
273
273
273
273
273
273
7
Backup Agent v20131216.1
Backup Agent v20131118.0
Backup Agent v20130923.0
Backup Agent v20130826.0
Backup Agent v20130812.1
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
274
274
274
274
274
Welcome to the documentation for MongoDB Management Service (MMS). Engineered by the team who develops
MongoDB, MMS provides a complete package for managing MongoDB deployments.
You can also download a PDF edition of the MMS Manual.
Getting Started Register for MMS and install your first MongoDB deployment.
Create New Deployments Set up servers and create MongoDB deployments.
Import Existing Deployments Import your existing MongoDB deployments to MMS.
Manage Deployments Monitor, update, and manage your deployments.
Back Up Deployments Initiate and restore backups.
Administration Configure and manage MMS.
API Manage MMS through the API.
Troubleshooting Troubleshooting advice for common issues.
Frequently Asked Questions Common questions about the operation and use of MMS.
Reference Reference material for MMS components and operations.
Release Notes Changelogs and notes on MMS releases.
1 Getting Started
Getting Started Register for MMS and install your first MongoDB deployment.
Functional Overview Describes MMS services and operations.
1.1 Getting Started
Introduction
MMS is a service that creates, manages, monitors, and backs up MongoDB deployments. You can get started with
MMS in minutes by going to https://mms.mongodb.com and selecting Start for Free. MMS Onboarding walks you
through registration and the setup of your first deployment.
During the onboarding process, MMS provides several options for where to deploy MongoDB and what kind of configuration to deploy. The choices you make for your first deployment do not limit your choices for future deployments.
At any time, you can click Advanced Setup in the upper right corner if you are already familiar with MMS and wish
to deploy an advanced configuration, such as a replica set with an arbiter. If you choose Advanced Setup, MMS takes
you to the Deployment page from which you use the usual procedures to Create a New MongoDB Deployment.
8
Get Started
Step 1: Visit MMS.
Go to https://mms.mongodb.com and select Start for Free.
Step 2: Register for an account.
Follow the prompts to create your account and configure your user, group, and MMS plan.
Group names are permanent. You cannot change the name of a group later.
Step 3: Set up your first MongoDB deployment in MMS.
Follow the prompts to either build a new deployment or manage an existing one. The choices you make do not affect
future deployments. Later, you can create deployments with entirely different configurations.
Next Steps
• Connect to your MongoDB deployment to begin creating databases.
• Add servers to your deployment.
• Deploy additional replica sets, clusters, or standalones.
1.2 Functional Overview
Overview
MongoDB Management Service (MMS) is a service for managing, monitoring and backing up a MongoDB infrastructure. MMS provides the services described here.
Monitoring
MMS Monitoring provides real-time reporting, visualization, and alerting on key database and hardware indicators.
How it Works: A lightweight Monitoring Agent runs within your infrastructure and collects statistics from the nodes
in your MongoDB deployment. The agent transmits database statistics back to MMS to provide real-time reporting.
You can set alerts on indicators you choose.
Automation
MMS Automation provides an interface for provisioning machines, configuring MongoDB nodes and clusters, and
upgrading your MongoDB deployment.
9
How it Works: Automation Agents on each server maintain your deployments. The Automation Agent also maintains
the Monitoring and Backup agents and starts, restarts, and upgrades the agents as needed.
Automation allows only one agent of each type per machine and will remove additional agents. For example, when
maintaining Backup Agents, automation will remove a Backup Agent from a machine that has two Backup Agents.
Backup
MMS Backup provides scheduled snapshots and point-in-time recovery of your MongoDB replica sets and sharded
clusters. Backup can also create snapshots of standalones that are run as single-member replica sets.
How it Works: A lightweight Backup Agent runs within your infrastructure and backs up data from the MongoDB
processes you have specified.
Data Backup
When you start Backup for a MongoDB deployment, the agent performs an initial sync of the data as though it were a
new hidden member of the replica set. For a sharded cluster the agent performs a sync of each shard’s primary and of
each config server. The agent ships initial sync and oplog data over HTTPS back to MMS.
The Backup Agent then tails each replica set’s oplog to maintain on disk a standalone database, called a head, for each
backed-up replica set. Each head is consistent with the original primary up to the last oplog supplied by the agent.
Backup performs the initial sync and the tailing of the oplog using standard MongoDB queries. The production replica
set is not aware of the copy of the backup data.
Backup uses a mongod with a version equal to or greater than the version of the replica set it backs up.
The service retains snapshots based on a user-defined policy.
Sharded clusters snapshots temporarily stop the balancer via the mongos so that they can insert a marker token into
all shards and config servers in the cluster. MMS takes a snapshot when the marker tokens appear in the backup data.
Compression and block-level deduplication technology reduces snapshot data size. The snapshot only stores the
differences between successive snapshots. Snapshots use only a fraction of the disk space required for full snapshots.
10
Data Restoration
MMS Backup lets you restore data from a scheduled snapshot or from a selected point between snapshots. For sharded
clusters you can restore from checkpoints between snapshots. For replica sets, you can restore from selected points in
time.
When you restore from a snapshot, MMS reads directly from the Backup Blockstore database and transfers files either
through an HTTPS download link or by sending them via HTTPS or SCP.
When you restore from checkpoint or point in time, MMS first creates a local restore of a snapshot from the blockstore
and then applies stored oplogs until the specified point is reached. MMS delivers the backup via the same HTTPS or
SCP mechanisms.
2 Create a New MongoDB Deployment
Add Servers to MMS Add servers to MMS.
Deploy a Replica Set Use MMS to deploy a managed replica set.
Deploy a Sharded Cluster Use MMS to deploy a managed sharded cluster.
Deploy a Standalone For testing and deployment, create a new standalone MongoDB instance.
Connect to a MongoDB Process Connect to a MongoDB deployment managed by MMS.
2.1 Add Servers to MMS
Overview How to add servers to MMS.
Add Existing Servers to MMS Add your existing servers to MMS.
Configure AWS Integration Configure MMS to deploy EC2 servers through Amazon Web Services (AWS).
Add AWS Servers to MMS Add EC2 servers through MMS.
Overview
Adding Servers to MMS
You can add servers to MMS in the following ways:
• Provision them on Amazon Web Services (AWS) through the MMS interface. MMS provides integration with
AWS and lets you deploy new EC2 instances directly from MMS To use EC2 instances for your deployments,
you must:
– Configure AWS Integration
– Add AWS Servers to MMS
• Provision existing systems and infrastructure. MMS can deploy and manage MongoDB on your existing servers.
To use your existing hardware, you must deploy the Automation Agent to each server on which MMS will deploy
MongoDB. See Add Existing Servers to MMS.
• Use your local system for testing. MMS can deploy MongoDB to your laptop or desktop system. Do not use
local systems for production deployments. To use your local system, you must deploy the Automation Agent.
11
Server Requirements
The following are the minimum hardware and networking requirements for the servers that will host your MongoDB
deployments:
Hardware:
• At least 10 GB of free disk space plus whatever space is necessary to hold your MongoDB data.
• At least 4 GB of RAM.
• If you use Amazon Web Services (AWS) EC2 instances, we recommend at least an m3.medium instance.
Networking:
• For each server that hosts a MongoDB process managed by MMS, the output of hostname -f must generate
a hostname that is resolvable from all other servers in the MongoDB deployment.
Additional Information
For an overview of MMS functionality, see Functional Overview.
Add Existing Servers to MMS
Overview
You can allow MMS to install, manage, and discover MongoDB processes on your existing servers. To do so, you
install the Automation Agent on each server.
Prerequisites
Ensure that the directories used by the Automation Agent have appropriate permissions for the user running the agent.
You can install the Automation Agent on the operating systems listed in MMS on the Administration tab’s Agents
page.
To install the agent using rpm or deb packages, you must have root access.
Procedure
Install the Automation Agent on each each server that you want MMS to manage. The following procedure applies to
all operating systems. For instructions for a specific operating system, see Automation Agent.
Step 1: Select the Administration tab and then select Agents.
Step 2: Under Automation at the bottom of the page, click your operation system and follow the instructions to
install and run the agent. If the install file is a tar.gz archive file, make sure to extract the archive after download.
Step 3: Ensure that the directories used by the Automation Agent have appropriate permissions for the user
that runs the agent. Set the required permissions described in Directory and File Permissions.
Once you have installed the agent to all your servers, you can deploy your first replica set, cluster, or standalone.
12
Configure AWS Integration
Overview
If you have an Amazon Web Services (AWS) account, you can configure MMS to deploy EC2 servers to that account
directly from the MMS interface. MMS integrates with AWS to deploy EC2 instances that come with Automation
Agents pre-installed.
How MMS uses SSH Access to AWS When you provision an EC2 server through MMS, MMS logs into the server
using SSH and:
• Configures the disk partitions that you specified.
• Installs critical security patches.
• Installs the Automation Agent.
Considerations
If you attempt to provision larger AWS instances, be aware that Amazon often has a limited number of larger instances
in any given region, which may prevent provisioning.
AWS accounts have restrictions that limit the number of instances you can deploy. If you reach this limit, you must
contact AWS support to raise this limit.
Prerequisites
Access Keys You must provide the following keys when configuring AWS Settings:
• The AWS account’s Access Key ID and Secret Access Key. To access the keys, click your username in the top
right corner of AWS and select Security Credentials.
• An SSH public key for the computer that accesses MMS. When you provision a server, AWS uses this key to
create a shared private key, allowing you to connect to the server through SSH.
User Permissions The AWS user associated with the access keys must have an attached IAM policy with the permissions described in AWS IAM Policy. Without adequate permissions, the user cannot provision AWS servers from
MMS. This tutorial includes a procedure for setting these permissions.
Security Group The AWS account must have at least one security group configured. At minimum, the security
group must have the following inbound rules:
• A custom TCP rule on all MongoDB ports that allows traffic from any member of the security group.
• An SSH rule on the SSH port, usually 22, and that allows traffic from all IPs.
If you do not want to grant SSH access to all IPs, you must instead grant SSH access to the following ranges:
– 4.71.186.128/25
– 4.35.16.128/25
Optionally, add additional rules to your security group as needed. For example, to grant access to MongoDB from
hosts in another security group, add a custom TCP rule that specifies the MongoDB ports and the other security group.
To grant access from a specific IP address, such as the IP address for a specific office, add a custom TCP rule that
specifies the MongoDB ports and the specific IP address.
13
VPC If you are deploying into a Virtual Private Cloud (VPC), the VPC must exist before provisioning. If you are
using a VPC that you created and not a default AWS VPC, make sure that the VPC property DNS hostname is yes,
which guarantees that each instance provisioned in the VPC receives a hostname.
Note that MMS gives a public IP to any instances created on subnets.
Procedures
Configure Permissions for the AWS User The AWS user must have an attached IAM policy with certain minimum
permissions. Use the following procedure to set these permissions. Also consider the AWS Documentation for the
most current information on AWS processes.
Step 1: In AWS, open the IAM Management Console.
Step 2: In the left-hand pane, click Users, and then click the user for which to create the policy.
Step 3: Click Attach User Policy.
Step 4: Click Select Policy Template and select Amazon Ec2 Full Access.
Step 5: Edit and apply your policy. Edit the policy document to include the permissions described in AWS IAM
Policy. When you are done, click Apply Policy.
Configure AWS Settings
Step 1: Select the Administration tab and then select AWS Settings.
Step 2: Click the pencil icon for AWS Provisioning Settings and enter the settings.
tion:
Enter the following informa-
Region: The AWS region in which to provision new servers.
AccessKey ID and Secret Access Key: The keys for your AWS account. You can retrieve the keys by clicking your
username in the top right corner of AWS and selecting Security Credentials.
User Account: The AWS user that logs into the provisioned machines. After the machines are provisioned you will be
able to SSH into the machine as this user.
MongoDB Data Directory: The default data directory to be used for a MongoDB deployment on a server.
When you complete your entries, click Confirm.
Step 3: Add an SSH public key to use when provisioning a new server. To connect to a server through SSH, you
must have at least one public key that you can select when provisioning the server.
To add a key, select Add SSH Key and enter the content of the key. The location of your SSH key depends on your
operating system. On Unix systems the key is typically in the ~/ssh/ directory.
14
Add AWS Servers to MMS
Overview
MMS integrates with Amazon Web Services (AWS) so that you can provision EC2 servers directly from the MMS
interface. When you provision an EC2 server from MMS, MMS automatically installs the Automation Agent to the
server and is ready to deploy managed MongoDB instances on this system.
Prerequisites
To provision EC2 servers through MMS, you must first Configure AWS Integration.
AWS Machine Size
In general, provision one machine per MongoDB instance. Make sure the machines have sufficient capacity in terms
of memory (RAM) and storage. The root volume should have at least 25 gigabytes.
MMS does not allow selection of AWS instances smaller than the m3.medium instance. MMS currently supports the
AWS Linux and Ubuntu operating systems.
Procedure
Step 1: Select the Deployment tab and then Deployment page.
Step 2: Select the Add button and then select Provision EC2 Machines.
Step 3: Select the AWS region.
Step 4: Select the EC2 machine image and click Next.
Step 5: Select the instance type and click Next. For recommendations on selecting a machine, see AWS Machine
Size.
Step 6: Configure the instance, including number of servers and SSH key. Deploy one machine for each
mongod instance. A mongos instance requires minimal resources and can run on the same machine as a mongod.
Give the servers a common prefix in order to specify them as a group when creating new clusters or replica sets.
The security group must allow traffic on the ports you use for your deployment. The security groups populated here
come directly from your AWS account. MMS cannot create a new security group: if you would like a new group listed
in this menu, you must create it in the AWS console.
Select the SSH key to use when connecting to the server from the command line. To select an SSH key, you must have
at least one public key stored in your AWS Settings.
When you have made your selections, click NEXT.
15
Step 7: Add storage to the instance. Select a Root Volume Size (GiB) large enough for the deployment’s needs. We
recommend a root volume of at least 25 GB. The root volume stores the operating system, the downloaded MongoDB
versions, and the Automation Agent log files.
In the Data Directory field, enter the path MongoDB will use to store data, and in the Location of Data field select
which volume holds the data. We do not recommend storing your data on the Root Volume. For machines in the m1 or
m2 series, we recommend attaching an EBS Volume. For machines in the c3 series, we recommend storing the data
on the SSD instance stores.
When you finish modifying the settings, click PROVISION MACHINE.
The systems may not be fully operational for several minutes.
2.2 Deploy a Replica Set
Overview
A replica set is a group of MongoDB deployments that maintain the same data set. Replica sets provide redundancy
and high availability and are the basis for all production deployments. See the Replication Introduction in the MongoDB manual for more information about replica sets.
Use this procedure to deploy a new replica set managed by MMS. After deployment, use MMS to manage the replica
set, including such operations as adding, removing, and reconfiguring members.
Consideration
Use unique replica set names for different replica sets within an MMS group. Do not give different replica sets the
same name. MMS uses the replica set name to identify which set a member belongs to.
Prerequisites
You must have an existing set of servers to which to deploy, and MMS must have access to the servers.
The servers can exist on your own system or on Amazon Web Services (AWS). To give MMS access to servers on
your system, install the Automation Agent to each server.
You can use MMS to provision new servers on AWS. See: Add AWS Servers to MMS for full instructions.
Procedure
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Click the Add button and then select Create New Replica Set.
Step 3: Configure the replica set.
Enter information as required and click Apply.
To select specific servers to use for the deployment, enter the prefix of the servers in the Eligible Server RegExp field.
You can use regular expressions. To use all provisioned servers, enter a period (”.”). To run the deployment on your
local machine, enter the name of the machine.
For information on replica set options in the Member Options box, see Replica Set Members in the MongoDB Manual.
The votes field applies only to pre-2.6 versions of MongoDB.
16
To configure additional mongod runtime options, such as specifying the oplog size, or modifying journaling settings,
click Advanced Options. For option descriptions, see Advanced Options for MongoDB Deployments.
Step 4: Click Review & Deploy to review the configuration.
MMS displays the full configuration for you to review.
Step 5: Click Confirm & Deploy.
To view deployment progress, click View Agent Logs and select an agent at the top of the Agent Logs page. To check
for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
2.3 Deploy a Sharded Cluster
Overview
Sharded clusters provide horizontal scaling for large data sets and enable high throughput operations by distributing
the data set across a group of servers. See the Sharding Introduction in the MongoDB manual for more information.
Use this procedure to deploy a new sharded cluster managed by MMS. Later, you can use MMS to add shards and
perform other maintenance operations on the cluster.
Prerequisites
You must have an existing set of servers to which to deploy, and MMS must have access to the servers.
The servers can exist on your own system or on Amazon Web Services (AWS). To give MMS access to servers on
your system, install the Automation Agent to each server.
You can use MMS to provision new servers on AWS. See: Add AWS Servers to MMS for full instructions.
Procedure
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Click the Add button and select Create New Cluster.
Step 3: Configure the sharded cluster.
Enter information as required and click Apply.
To select specific servers to use for the deployment, enter the prefix of the servers in the Eligible Server RegExp field.
You can use regular expressions. To use all provisioned servers, enter a period (”.”). To run the deployment on your
local machine, enter the name of the machine.
For information on replica set options in the Member Options box, see Replica Set Members in the MongoDB Manual.
The votes field applies only to pre-2.6 versions of MongoDB.
17
To configure additional mongod or mongos options, such as specifying the oplog size, or modifying journaling
settings, click Advanced Options. For option descriptions, see Advanced Options for MongoDB Deployments.
Step 4: Click Review & Deploy to review the configuration.
MMS displays the full configuration for you to review.
Step 5: Click Confirm & Deploy.
To view deployment progress, click View Agent Logs and select an agent at the top of the Agent Logs page. To check
for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
2.4 Deploy a Standalone MongoDB Instance
Overview
You can deploy a standalone MongoDB instance managed by MMS. Use standalone instances for testing and development. Do not use these deployments, which lack replication and high availability, for production systems. For all
production deployments use replica sets. See Deploy a Replica Set for production deployments.
Prerequisites
You must have an existing server to which to deploy. For testing purposes, you can use your localhost, or another
machine to which you have access.
You can also deploy to a server on Amazon Web Services. See: :doc:‘/tutorial/provision-aws-servers‘for more about
configuring and provisioning AWS servers with MMS.
Procedure
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Click the Add button and select Create New Standalone.
Step 3: Configure the standalone MongoDB instance.
Enter information as required and click Apply. For descriptions of Advanced Options, see Advanced Options for
MongoDB Deployments.
Step 4: Click Review & Deploy to review the configuration.
MMS displays the full configuration for you to review.
18
Step 5: Click Confirm & Deploy.
To view deployment progress, click View Agent Logs and select an agent at the top of the Agent Logs page. To check
for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
2.5 Connect to a MongoDB Process
Overview
To connect to a MongoDB instance, retrieve the hostname and port information from the MMS console and then use
a MongoDB client, such as the mongo shell or a MongoDB driver, to connect to the instance. You can connect to a
cluster, replica set, or standalone.
Firewall Rules
Firewall rules and user authentication affect your access to MongoDB. You must have access to the server and port of
the MongoDB process.
If your instance runs on Amazon Web Services (AWS), your access depends in part on the security group used on the
deployment’s AWS server.
Procedures
Get the Connection Information for the MongoDB Instance
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the cluster, replica set, or process, click the ellipses icon and select Performance
Metrics. MMS displays the hostname and port of the process at the top of the charts page.
Connect to a Deployment Using the Mongo Shell
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the cluster, replica set, or process, click the ellipses icon and select Performance
Metrics. MMS displays the hostname and port of the process at the top of the charts page.
19
Step 4: On a system shell, run mongo and specify the host and port of the deployment.
following form:
Issue a command in the
mongo --username <user> --password <pass> --host <host> --port <port>
Connect to a Deployment Using a MongoDB Driver
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the cluster, replica set, or process, click the ellipses icon and select Performance
Metrics. MMS displays the hostname and port of the process at the top of the charts page.
Step 4: Connect from your driver. Use your driver to create a connection string that specifies the hostname and
port of the deployment. The connection string for your driver will resemble the following:
mongodb://[<username>:<password>@]hostname0<:port>[,hostname1:<port1>][,hostname2:<port2>][...][,host
If you specify a seed list of all hosts in a replica set in the connection string, your driver will automatically connect to
the term:primary.
For standalone deployments, you will only specify a single host. For sharded clusters, only specify a single mongos
instance.
Retrieve the Command to Connect Directly from the Process’s Server
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the cluster, replica set, or process, click the ellipses icon and select Connect to this
instance. MMS provides a mongo shell command that you can use to connect to the MongoDB process if you are
connecting from the system where the deployment runs.
3 Import an Existing MongoDB Deployment
Add Existing Processes to Monitoring Add existing MongoDB processes to MMS Monitoring.
Add Monitored Processes to Automation Add an existing MongoDB deployment to be managed through MMS Automation.
Reactivate Monitoring for a Process Reactivate a deactivated MongoDB process.
Remove Hosts Remove processes you no longer use from monitoring.
Edit Authentication Credentials Edit authentication credentials for host.
Edit SSL Use Setting Specify SSL use for host.
20
3.1 Add Existing MongoDB Processes to Monitoring
Overview
You can monitor existing MongoDB processes in MMS by adding the hostnames and ports of the processes. MMS
will start monitoring the mongod and mongos instances.
If you add processes from an environment that uses authentication, you must add each mongod instance separately
and explicitly set the authentication credentials on each.
If you add processes in an environment that does not use authentication, you can manually add one process from a
replica set or a sharded cluster as a seed. Once the Monitoring Agent has the seed, it automatically discovers all the
other nodes in the replica set or sharded cluster.
Unique Replica Set Names
Do not add two different replica sets with the same name. MMS uses the replica set name to identify which set a
member belongs to.
Preferred Hostnames
If the MongoDB process is accessible only by specific hostname or IP address, or if you need to specify the hostname
to use for servers with multiple aliases, set up a preferred hostname. For details, see the Preferred Hostnames setting
in Manage Your Account.
Prerequisite
You must first install the Automation Agent to the servers hosting the processes. See Add Existing Servers to MMS.
Add MongoDB Processes
If your deployments use authentication, perform this procedure for each process. If your deployment does not use
authentication, add one process from a replica set or sharded cluster and MMS will discover the other nodes in the
replica set or sharded cluster.
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Click Add and select Import Existing for Monitoring.
Step 3: Enter information for the MongoDB process.
Enter the following information, as appropriate:
21
Host Type
Internal Hostname
Port
Auth Mechanism
DB Username
DB Password
My deployment supports SSL
for MongoDB connections
The type of MongoDB deployment.
The hostname of the MongoDB instance as seen from the Monitoring Agent.
The port on which the MongoDB instance runs.
The authentication mechanism used by the host.
If the authentication mechanism is MONGODB-CR or LDAP, the username used
to authenticate the Monitoring Agent to the MongoDB deployment.
If the authentication mechanism is MONGODB-CR or LDAP, the password used
to authenticate the Monitoring Agent to the MongoDB deployment.
If checked, the Monitoring Agent must have a trusted CA certificate in order to
connect to the MongoDB instances. See Configure Monitoring Agent for SSL.
Step 4: Click Add.
To view agent output logs, click the Administration tab, then Agents, and then view logs for the agent.
To view process logs, click the Deployment tab, then the Deployment page, then the process, and then the Logs tab.
For more information on logs, see View Logs.
3.2 Add Monitored Processes to Automation
Overview
MMS can automate operations for your monitored MongoDB processes. Adding your processes to Automation lets
you reconfigure, stop, and restart MongoDB through the MMS interface.
Adding monitored processes involves two steps. First, install the Automation Agent on each server hosting a monitored
MongoDB process. Second, add the processes to Automation through the MMS interface.
Prerequisites
Automation supports most but not all available MongoDB options. Automation supports the options described in
Supported MongoDB Options for Automation.
The user running the Automation Agent must the same as the user running the MongoDB process to be managed.
The servers that host the MongoDB processes must have full networking access to each other through their fully
qualified domain names (retrieved on each server by issuing hostname -f). Each server must be able to reach
every other server through the FQDN.
MMS must be currently monitoring the MongoDB processes, and the Monitoring Agent must be running. The processes must appear in the MMS Deployment tab.
Procedures
Install the Automation Agent on Each Server
Install the Automation Agent on each server that hosts a monitored MongoDB process. Ensure that the Automation
Agent has adequate permissions to stop and restart the existing Monitoring Agent so that it can update the Monitoring
Agent as new versions are released.
On each server, you must download the agent, create the necessary directories, and configure the agent’s
local.config file with the Group ID and API key.
22
Step 1: In MMS, select the Administration tab and then select Agents.
Step 2: Under Automation at the bottom of the page, click your operation system and follow the instructions to
install and run the agent. For additional information on installing the agent, see Automation Agent.
Add the Processes to Automation
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Click Add and select Import Existing for Automation.
Step 3: Select the MongoDB processes. Click the Deployment Item field to display your currently monitored
processes. Select the cluster, replica set or standalone to add.
Step 4: Click Start Import. MMS displays the progress of the import for each MongoDB process, including any
errors. If you need to correct errors, click Stop Import, correct them, and restart this procedure.
Step 5: Click Confirm Import.
Step 6: Click Review & Deploy.
Step 7: Click Confirm & Deploy. MMS Automation takes over the management of the processes and peforms a
rolling restart. To view progress, click View Agent Logs.
If you diagnose an error that causes Automation to fail to complete the deployment, click Edit Configuration to correct
the error.
3.3 Reactivate Monitoring for a Process
Overview
If the Monitoring Agent cannot collect information from a MongoDB process, MMS stops monitoring the process.
MMS stops monitoring a mongos that is unreachable for 24 hours and a mongod that is unreachable for 7 days.
When the system stops monitoring a process, the Deployment page marks the process with an x in the Last Ping
column. If the instance is a mongod, MMS displays a caution icon at the top of each Deployment page.
You can reactivate monitoring for the process whether or not the process is running. When you reactivate monitoring,
the Monitoring Agent has an hour to reestablish contact and provide a ping to MMS. If a process is running and
reachable, it appears marked with a green circle in the Last Ping column. If it is unavailable, it appears marked with a
red square. If it remains unreachable for an hour, MMS again stops monitoring the process.
You can optionally remove a process that you are no longer using. Removed processes are permanently hidden from
MMS. For more information, see Remove Hosts.
Procedure
To reactivate monitoring for a process:
23
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Click the warning icon at the top of the page.
Step 3: Click Reactivate ALL hosts.
The processes that are now running and reachable by the Monitoring Agent will appear marked with green circles in
the Last Ping column.
The processes that are unavailable or unreachable will appear marked with a red square. If a process does not send a
ping within an hour after reactivation, it is deactivated again.
Step 4: Add the mongos instances.
To activate the mongos instances, click the Add Host button and enter the hostname, port, and optionally an admin
database username and password. Then click Add.
3.4 Remove Hosts
Overview
You can remove hosts that you no longer use, but when you do they are hidden permanently. If you run the instance
again, MMS will not discover it. If you choose to add the host again, MMS will not display it.
Only MMS Support can undelete it.
Instead of removing a host, you can optionally disable alerts for the host, which does not remove it from the Deployment pages. See Manage Host Alerts.
Procedure
To remove a host from MMS:
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: On the line listing the process, click the ellipses icon and select Remove.
Step 3: Click Remove.
Step 4: If prompted for a two-factor authentication code, enter it, click Verify, and then click Delete again.
3.5 Edit Authentication Credentials
If your MongoDB deployment enforces access control, the MMS agents must authenticate to MongoDB as a user with
the proper access.
24
Procedures
Edit Host Credential Information for Monitoring
Before editing these credentials, set up the agent as a user in MongoDB with appropriate access. See Configure
Monitoring Agent for Access Control.
To edit authentication credential information:
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: On the line listing the process, click the ellipses icon and select Monitoring Settings.
Step 3: Select the Credentials tab.
Step 4: At the bottom of the dialog box, click the Change button.
Step 5: Enter the credentials. Edit the following information, as appropriate:
Auth Mechanism
Current DB Username
Current DB Password
Update other hosts in
replica set/sharded cluster
as well
The authentication mechanism used by the host. Can specify MONGODB-CR,
LDAP (PLAIN), or Kerberos(GSSAPI).
If the authentication mechanism is MONGODB-CR or LDAP, the username used
to authenticate the Monitoring Agent to the MongoDB deployment. See Add
Monitoring Agent User for MONGODB-CR, Configure Monitoring Agent for
LDAP, or Configure the Monitoring Agent for Kerberos for setting up user
credentials.
If the authentication mechanism is MONGODB-CR or LDAP, the password used
to authenticate the Monitoring Agent to the MongoDB deployment. See Add
Monitoring Agent User for MONGODB-CR, Configure Monitoring Agent for
LDAP, or Configure the Monitoring Agent for Kerberos for setting up user
credentials.
Only for cluster or replica set. If checked, apply the credentials to all other hosts in
the cluster or replica set.
Step 6: Click the Submit button.
Step 7: Close the dialog box.
Edit Host Credential Information for Backup
Before editing these credentials, set up the agent as a user in MongoDB with appropriate access. See Configure Backup
Agent for Access Control.
To edit authentication credential information:
Step 1: Select the Backup tab and then select Replica Set Status or Sharded Cluster Status.
25
Step 2: On the line listing the cluster or replica set, click the gear icon.
Step 3: Select Edit Credentials.
Step 4: Enter the credentials. Edit the following information, as appropriate:
Auth Mechanism
Current DB Username
Current DB Password
My deployment supports
SSL for MongoDB
connections
The authentication mechanism used by the host. Can specify MONGODB-CR,
LDAP (PLAIN), or Kerberos(GSSAPI).
If the authentication mechanism is MONGODB-CR or LDAP, the username used
to authenticate the Monitoring Agent to the MongoDB deployment. See Configure
Backup Agent for MONGODB-CR, Configure Backup Agent for LDAP
Authentication, or Configure the Backup Agent for Kerberos for setting up user
credentials.
If the authentication mechanism is MONGODB-CR or LDAP, the password used
to authenticate the Monitoring Agent to the MongoDB deployment. See Configure
Backup Agent for MONGODB-CR, Configure Backup Agent for LDAP
Authentication, or Configure the Backup Agent for Kerberos for setting up user
credentials.
If checked, the Monitoring Agent must have a trusted CA certificate in order to
connect to the MongoDB instances. See Configure Monitoring Agent for SSL.
Step 5: Click Save.
3.6 Edit SSL Use Setting
If your MongoDB deployment uses SSL, then you must configure the Use SSL setting for the deployment.
Procedures
Edit Host SSL Use for Monitoring
Before editing these credentials, update the agent’s configuration file to use SSL. Configure Monitoring Agent for SSL.
To specify SSL use:
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: On the line listing the process, click the ellipses icon and select Monitoring Settings.
Step 3: Select SSL.
Step 4: Turn ON or OFF.
Step 5: Close the dialog.
26
Edit Host Credential Information for Backup
Before editing these credentials, update the agent’s configuration file to use SSL. Configure Backup Agent for SSL.
To specify SSL use:
Step 1: Select the Backup tab and then select Replica Set Status or Sharded Cluster Status.
Step 2: On the line listing the cluster or replica set, click the gear icon.
Step 3: Select SSL.
Step 4: Turn ON or OFF
Step 5: Close the dialog.
4 Manage Deployments
Edit a Replica Set Add hosts to, remove hosts from, or modify the configuration of hosts in an MMS managed replica
set. - ‘cloud’ - ‘onprem’
Migrate a Replica Set Member to a New Server Migrate replica sets to new underlying systems by adding members
to the set and decommissioning existing members.
Move or Add a Monitoring or Backup Agent Migrate a backup and monitoring agents to different servers.
Change the Version of MongoDB Upgrade or downgrade MongoDB deployments managed by MMS.
Restart a MongoDB Process Restart MongoDB deployments managed by MMS.
Shut Down MongoDB Processes Shut down MongoDB deployments managed by MMS.
Remove Processes from Monitoring Remove MongoDB deployments from management by MMS.
Connect to an AWS Server through SSH Connect directly to an AWS server that hosts a MongoDB deployment
managed by MMS.
Alerts Set up and manage alert configurations.
Monitoring Metrics Interpreting the metrics.
Logs View host and agent logs.
4.1 Edit a Replica Set
Overview
You can add, remove, and reconfigure members in a replica set directly in the MMS console.
27
Procedures
Add a Replica Set Member
You must have an existing server to which to deploy the new replica set member. To add a member to an existing
replica set, increasing the size of the set:
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Edit the replica set. Select the topology view by clicking the first of the two Processes icons. Then click
the replica set’s ellipses icon and select Modify.
Step 3: Add the member. In the MongoDs Per Replica Set field, click + to increase the number of members for the
replica set.
Configure the new members as desired in the Member Options box.
Then click Apply.
Step 4: Click Review & Deploy to review the configuration. MMS displays the full configuration for you to review.
Step 5: Click Confirm & Deploy. To view deployment progress, click View Agent Logs and select an agent at the
top of the Agent Logs page. To check for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
Edit a Replica Set Member
Use this procedure to:
• Reconfigure a member as hidden
• Reconfigure a member as delayed
• Reset a member’s priority level in elections
• Reset a member’s votes (for pre-2.6 versions of MongoDB)
To reconfigure a member as an arbiter, see Replace a Member with an Arbiter.
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: On the line listing the replica set, click the ellipses icon and select Modify. If you do not see the replica
set, click the topology icon (the first Processes icon).
28
Step 3: In the Member Options box, configure each member as needed.
the following in the MongoDB manual:
For information on member options, see
• Hidden Members
• Delayed Members
• Elections, which describes priority levels.
The Votes field applies to pre-2.6 versions of MongoDB.
Step 4: Click Apply.
Step 5: Click Review & Deploy to review the configuration. MMS displays the full configuration for you to review.
Step 6: Click Confirm & Deploy. To view deployment progress, click View Agent Logs and select an agent at the
top of the Agent Logs page. To check for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
Replace a Member with an Arbiter
You cannot directly reconfigure a member as an arbiter. Instead, you must must add a new member to the replica set
as an arbiter. Then you must shut down an existing secondary.
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: Click the replica set’s ellipses icon and select Modify.
Step 4: Add an arbiter. In the MongoDs Per Replica Set field, increase the number of members by 1.
In the Member Options box, click the member’s drop-down arrow and select Arbiter.
Click Apply.
Step 5: Click Review & Deploy.
Step 6: Click Confirm & Deploy.
Step 7: Remove the secondary. When the deployment completes, click the ellipses icon for secondary to be removed, and then select Remove from Replica Set.
Step 8: Click Review & Deploy.
29
Step 9: Click Confirm & Deploy. To view deployment progress, click View Agent Logs and select an agent at the
top of the Agent Logs page. To check for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
Upon completion, MMS removes the member from the replica set, but it will continue to run as a standalone MongoDB
instance. To shut down the standalone, see Shut Down MongoDB Processes.
Remove a Replica Set Member
Removing a member from a replica set does not shut down the member or remove it from MMS. MMS still monitors
the mongod as as standalone instance. To remove a member:
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: Click the ellipses icon for the member to be removed and select Remove from Replica Set.
Step 4: Click Remove to confirm.
Step 5: Click Review & Deploy.
Step 6: Click Confirm & Deploy. To view deployment progress, click View Agent Logs and select an agent at the
top of the Agent Logs page. To check for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
Upon completion, MMS removes the member from the replica set, but it will continue to run as a standalone MongoDB
instance. To shut down the standalone, see Shut Down MongoDB Processes.
Additional Information
To view data from all replica set members at once, see Replica Set Statistics.
For more information on replica set configuration options, see, Replica Set Configuration in the MongoDB manual.
4.2 Migrate a Replica Set Member to a New Server
Overview
For MMS managed replica sets, you can replace one member of a replica set with another new member from the
MMS console. Use this process to migrate members of replica sets to new underlying servers. From a high level, this
30
procedure requires that you: you add a member to the replica set on the new server and then shut down the existing
member on the old server. Specifically, you will
1. Provision the new server.
2. Add an extra member to the replica set.
3. Shut down old member of the replica set.
4. Un-manage the old member (Optional).
Considerations
Initial Sync
When you add a new replica set member, the member must perform an initial sync, which takes time to complete,
depending on the size of your data set. For more information on initial sync, see Replica Set Data Synchronization.
Migrating Multiple Members
If you are moving multiple members to new servers, migrate each member separately to keep the replica set available.
Procedure
Perform this procedure separately for each member of a replica set to migrate.
Step 1: Provision the new server.
You can provision a server on either Amazon Web Services (AWS) or your own infrastructure. See the appropriate
procedure:
• Add AWS Servers to MMS
• Add Existing Servers to MMS.
Step 2: Select the Deployment tab and then the Deployment page.
Step 3: On the line listing the replica set, click the ellipses icon and select Modify.
If you do not see the replica set, click the topology icon (the first Processes icon).
Step 4: Add a member to the replica set.
In the Nodes Per Replica Set field, increase the number of members by 1, and then click Apply.
31
Step 5: Verify changes.
Verify the server to which MMS will deploy the new replica set member. If necessary, select a different server.
The Deployment page’s Topology View lists the new replica set member and indicates the server to which MMS will
deploy it.
If MMS has not chosen the server you intended, click the Deployment page’s Server View to display your available
servers and their processes. Processes not yet deployed can be dragged to different servers. Drag the new replica set
member to the server to which to deploy it.
Step 6: Click Review & Deploy.
Step 7: Click Confirm & Deploy.
To view deployment progress, click View Agent Logs and select an agent at the top of the Agent Logs page. To check
for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
Step 8: Verify that the new member has synchronized.
Select the Deployment page’s view mode to view the new member’s status. Verify that the new member has synchronized and is no longer in the Recovering state.
Step 9: Remove the old member from the replica set.
Select the Deployment page’s edit mode, and then click the arrow to the right of the replica set member. Then click
the gear icon and select Remove Member. Then click Review & Deploy. Then click Confirm & Deploy.
Step 10: Shut down the old member.
Select the arrow to the right of the removed replica set member, and then click the gear icon and select Shut Down.
Then click Review & Deploy. Then click Confirm & Deploy.
Step 11: Optionally, unmanage the old member.
Select the arrow to the right of the removed replica set member, and then click the gear icon and select Unmanage.
Then click Review & Deploy. Then click Confirm & Deploy.
4.3 Move or Add a Monitoring or Backup Agent
Overview
When you deploy MongoDB as a replica set or sharded cluster to a group of servers, MMS selects one server to run
the Monitoring Agent. If you enable MMS Backup, MMS also selects a server to run the Backup Agent.
32
You can move the Monitoring and Backup Agents to different servers in the deployment. You might choose to do this,
for example, if you are terminating a server.
You also can add additional instances of each agent as hot standbys for high availability. However, this is not standard
practice. A single Monitoring Agent and single Backup Agent are sufficient and strongly recommended. If you run
multiple agents, only one Monitoring Agent and one Backup Agent per group or environment are primary. Only the
primary agent reports cluster status and performs backups. If you run multiple agents, see Confirm Only One Agent is
Actively Monitoring.
Procedures
Move a Monitoring or Backup Agent to a Different Server
To move an agent to a new server, you install a new instance of the agent on the target server, and then remove the
agent from its original server.
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the Servers tile view.
one or more agents.
The Servers tile view displays each provisioned server that is currently running
Step 3: On the server to which to move the agent, click the ellipses icon and select to install that type of agent.
Step 4: On the server from which to remove the agent, click the ellipses icon and remove the agent.
Step 5: Click Review & Deploy to review the configuration. MMS displays the full configuration for you to review.
Step 6: Click Confirm & Deploy. To view deployment progress, click View Agent Logs and select an agent at the
top of the Agent Logs page. To check for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
Install Additional Agent as Hot Standby for High Availability
In general, using only one Monitoring Agent and one Backup Agent is sufficient and strongly recommended. If you
run multiple agents, see Confirm Only One Agent is Actively Monitoring to ensure no conflicts.
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the Servers tile view.
one or more agents.
The Servers tile view displays each provisioned server that is currently running
Step 3: On the server to which to add an additional agent, click the ellipses icon and select the agent to add.
33
Step 4: Click Review & Deploy to review the configuration. MMS displays the full configuration for you to review.
Step 5: Click Confirm & Deploy. To view deployment progress, click View Agent Logs and select an agent at the
top of the Agent Logs page. To check for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
4.4 Change the Version of MongoDB
Overview
For MMS managed MongoDB, MMS supports safe automatic upgrade and downgrade operations between releases of
MongoDB while maximizing the availability of your deployment. MMS supports upgrade and downgrade operations
for sharded clusters, replica sets,and standalone MongoDB instances.
Considerations
Before changing a deployment’s MongoDB version:
• Consult the following documents for any special considerations or application compatibility issues:
– The MongoDB Release Notes
– The documentation for your driver.
• Plan the version change during a predefined maintenance window.
• Before changing version on a production environment, change versions on a staging environment that reproduces
your production environment to ensure your configuration is compatible with all changes.
Procedure
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the cluster, replica set, or process, click the ellipses icon and select Modify.
Step 4: In the Version field select the version. Then click Apply.
Step 5: Click Review & Deploy to review the configuration.
MMS displays the full configuration for you to review.
34
Step 6: Click Confirm & Deploy.
To view deployment progress, click View Agent Logs and select an agent at the top of the Agent Logs page. To check
for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
4.5 Restart a MongoDB Process
Overview
If an MMS-managed MongoDB process is not currently running, you can restart it directly from the MMS console.
Considerations
If the Monitoring Agent cannot collect information from a MongoDB process, MMS stops monitoring the process.
MMS stops monitoring a mongos that is unreachable for 24 hours and a mongod that is unreachable for 7 days.
Procedure
To restart a process:
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the cluster, replica set, or process, click the ellipses icon and select Startup.
Step 4: Click Startup to confirm.
Step 5: Click Review & Deploy to review the configuration.
MMS displays the full configuration for you to review.
Step 6: Click Confirm & Deploy.
To view deployment progress, click View Agent Logs and select an agent at the top of the Agent Logs page. To check
for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
35
4.6 Shut Down MongoDB Processes
Overview
You can shut down an entire sharded cluster, entire replica set, or a single standalone instance. The procedure
terminates all the mongod and mongos processes involved.
The procedure does not remove the processes from MMS Monitoring. MMS continues to monitor the processes and
display their statuses. To remove processes from Monitoring, see Remove Processes from Monitoring.
Procedure
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the cluster, replica set, or process, click the ellipses icon and select Shutdown.
Step 4: Click Shutdown to confirm.
Step 5: Click Review & Deploy to review the configuration.
MMS displays the full configuration for you to review.
Step 6: Click Confirm & Deploy.
To view deployment progress, click View Agent Logs and select an agent at the top of the Agent Logs page. To check
for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
Additional Information
To restart processes after shutting them down, see Restart a MongoDB Process.
To remove processes from MMS monitoring, see Remove Processes from Monitoring.
4.7 Remove Processes from Monitoring
Overview
You can remove processes from monitoring by MMS, in which case MMS no longer manages the processes nor
displays them in the Deployment page
This procedure does not shut down the processes. If you unmanage running processes, the processes continue to run.
If you also intend to stop the processes, do that first. See Shut Down MongoDB Processes.
36
Consideration
Instead of removing processes from monitoring, you can optionally disable their alerts, which allows you to continue
to view the processes in the Deployment page. See Manage Host Alerts.
Prerequisite
If the processes are no longer needed for any purpose, shut them down before removing them. Otherwise they will
continue to run, even though MMS no longer monitors them. See Shut Down MongoDB Processes.
Procedure
To remove processes from management by MMS:
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the cluster, replica set, or process, click the ellipses icon and select Unmanage.
Step 4: Click Review & Deploy to review the configuration.
MMS displays the full configuration for you to review.
Step 5: Click Confirm & Deploy.
To view deployment progress, click View Agent Logs and select an agent at the top of the Agent Logs page. To check
for updated entries, refresh the page.
If you diagnose an error and need to correct the deployment configuration, click Edit Configuration and then click Edit
Configuration again. Reconfigure the deployment through the deployment arrow button or through the Add button. If
you cannot find a solution, shut down the deployment. When you complete your changes, click Review & Deploy and
then Confirm & Deploy.
4.8 Connect to an AWS Server through SSH
Overview
A server provisioned on Amazon Web Services (AWS) through MMS is accessible through its hostname as listed on
the Deployment page. You can use an SSH operation that resembles the following to connect to the server:
ssh -i <ssh-key> <username>@<hostsring>.mongodbdns.com
Prerequisites
• The AWS security group assigned to the AWS server must allow SSH access from your IP address. For more
information, see Security Group.
37
• To connect to the AWS server through SSH, you must have the public key that matches the shared private key
you created when provisioning the server.
To provide MMS with a public key for use when provisioning AWS servers, see Configure AWS Integration.
Procedures
Step 1: Select the Deployment tab and then Deployment page.
Step 2: Connect to your EC2 instance using the hostname listed.
You must have your private key file from your AWS Settings page. Your key must not be publicly viewable for SSH
to work. Use this command if needed: chmod 400 myKey.pem.
Open an SSH client and issue an ssh command that uses your <key> and <hostname>:
ssh -i <key> <ec2-username>@<hostname>
4.9 Alerts
Manage Host Alerts Procedure to enable/disable alerts for hosts.
Create an Alert Configuration Procedures to create alert configurations.
Manage Alert Configuration Procedures for managing alert configurations.
Manage Alerts Procedures for managing alerts.
Alert Conditions Identifies all available alert triggers and conditions.
Manage Host Alerts
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: On the line listing the process, click the ellipses icon and select Monitoring Settings.
Step 3: Select Alert Status and then modify the alert settings.
Create an Alert Configuration
Overview
An alert configuration defines the conditions that trigger an alert and defines the notifications to be sent.
You can create an alert configuration from scratch or clone it from an existing alert.
Considerations
Costs Costs to send alerts depend on your telephone service contract. Many factors may affect alert delivery, including do not call lists, caps for messages sent or delivered, delivery time of day, and message caching.
38
Alert Intervals To implement alert escalation, you can create multiple alert configurations with different minimum
frequencies. MMS processes alerts on a 5-minute interval. Therefore, the minimum frequency for an alert is 5 minutes.
The time between re-notifications increases by the frequency amount every alert cycle (e.g. 5 minutes, 10 minutes, 15
minutes, 20 minutes, etc.) up to a maximum of 24 hours. The default frequency for a new alert configuration is 60
minutes.
When an alert state triggers, you can set a time to elapse before MMS will send alert messages at the specified interval.
This helps eliminate false positives. Type in the after waiting field the number of minutes to wait before sending the
alert at the specified interval for each recipient.
Procedures
You can create a new alert configuration or clone an existing one. This section provides both procedures.
Create an Alert Configuration
Step 1: Select the Activity tab and then select Alert Settings.
Step 2: Click the Add Alert button.
Step 3: Select the alert recipients and choose how they receive the alerts. In Send to, specify the alert interval
and distribution method for each alert recipient. Click Add to add more recipients.
To receive an SMS alert, a user must have correctly entered their telephone number in their Account page on the
Administration tab. MMS removes all punctuation and letters and only uses the digits for the telephone number.
If you are outside of the United States or Canada, you will need to include ‘011’ and your country code. For instance,
for New Zealand (country code 64), you would need to enter ‘01164’, followed by your phone number. Alternately,
you can sign up for a Google Voice number, and use that number for your authentication.
For HipChat alerts, enter the HipChat room name and API token. Alerts will appear in the HipChat room message
stream. See the Group Settings page to define default group settings for HipChat.
For PagerDuty alerts, enter only the service key. Define escalation rules and alert assignments in PagerDuty. See the
Group Settings page to define default group settings for PagerDuty.
Step 4: Click Save.
Clone an Alert Configuration You can create new alert configurations by cloning an existing one then editing it.
Step 1: Select the Activity tab and then select Alert Settings.
Step 2: Click the gear icon to the right of an alert and then select Clone.
39
Step 3: Select the alert recipients and choose how they receive the alerts. In Send to, specify the alert interval
and distribution method for each alert recipient. Click Add to add more recipients.
To receive an SMS alert, a user must have correctly entered their telephone number in their Account page on the
Administration tab. MMS removes all punctuation and letters and only uses the digits for the telephone number.
If you are outside of the United States or Canada, you will need to include ‘011’ and your country code. For instance,
for New Zealand (country code 64), you would need to enter ‘01164’, followed by your phone number. Alternately,
you can sign up for a Google Voice number, and use that number for your authentication.
For HipChat alerts, enter the HipChat room name and API token. Alerts will appear in the HipChat room message
stream. See the Group Settings page to define default group settings for HipChat.
For PagerDuty alerts, enter only the service key. Define escalation rules and alert assignments in PagerDuty. See the
Group Settings page to define default group settings for PagerDuty.
Step 4: Click Save.
Manage Alert Configuration
Overview
You can manage alert configurations from the Activity tab. An alert configuration defines the conditions that trigger an
alert and defines the notifications to be sent.
Manage Alert Configurations
View Alert Configurations
page.
To view alert configurations, click the Activity tab and then select the Alert Settings
Alert configurations define the conditions that trigger alerts and the notifications sent when alerts are triggered.
MMS creates the following alert configurations automatically when you create a new group:
• Users awaiting approval to join group
• Host is exposed to the public internet
• User added to group
• Monitoring Agent is down
If you enable backup, MMS creates the following alert configurations for the group if they do not already exist:
• Oplog Behind
• Resync Required
• Cluster Mongos Is Missing
Create or Clone an Alert Configuration To create or clone an alert configuration, see Create an Alert Configuration.
Modify an Alert Configuration Each alert configuration has a distribution list, a frequency for sending the alert,
and a waiting period after an alert state triggers before sending the first alert.
By default, an alert configuration sends alerts at 60-minute intervals. You can modify the interval. The minimum
interval is 5 minutes.
40
Step 1: Select the Activity tab and then select Alert Settings.
Step 2: Click the gear icon to the right of an alert and then select Edit.
Step 3: Select the alert recipients and choose how they receive the alerts. In Send to, specify the alert interval
and distribution method for each alert recipient. Click Add to add more recipients.
To receive an SMS alert, a user must have correctly entered their telephone number in their Account page on the
Administration tab. MMS removes all punctuation and letters and only uses the digits for the telephone number.
If you are outside of the United States or Canada, you will need to include ‘011’ and your country code. For instance,
for New Zealand (country code 64), you would need to enter ‘01164’, followed by your phone number. Alternately,
you can sign up for a Google Voice number, and use that number for your authentication.
For HipChat alerts, enter the HipChat room name and API token. Alerts will appear in the HipChat room message
stream. See the Group Settings page to define default group settings for HipChat.
For PagerDuty alerts, enter only the service key. Define escalation rules and alert assignments in PagerDuty. See the
Group Settings page to define default group settings for PagerDuty.
Step 4: Click Save.
Delete an Alert Configuration
Step 1: Select the Activity tab and then select Alert Settings.
Step 2: Click the gear icon to the right of an alert and then select Delete.
Step 3: Click Confirm. When you delete an alert configuration that has open alerts associated to it, MMS cancels
the open alerts and sends no further notifications. This is true whether users have acknowledged the alerts or not.
Disable or Enable an Alert Configuration
Step 1: Select the Activity tab and then select Alert Settings.
Step 2: Click the gear icon to the right of an alert and then select either Disable or Enable. When you disable
an alert configuration it remains visible in a grayed out state. MMS automatically cancels active alerts related to a
disabled alert configuration. You can reactivate disabled alerts.
For example, if you have an alert configured for Host Down and you currently have an active alert telling you a host is
down, MMS automatically cancels active Host Down alerts if you disable the default Host Down configuration. MMS
will send no further alerts of this type unless the disabled alert is re-enabled.
41
Manage Alerts
Overview
You can manage alerts from the Activity tab.
When a condition triggers an alert, users receive the alert at regular intervals until the alert is resolved or canceled.
Users can mark the alert as acknowledged for a period of time but will again receive notifications when the acknowledgment period ends if the alert condition still exists.
Alerts end when the alert is resolved or canceled. An alert is resolved, also called “closed,” when the condition that
triggered the alert has been corrected. MMS sends users a notification at the time the alert is resolved.
An alert is canceled if the alert configuration that triggered the alert is deleted or disabled, or if the target of the alert
is removed from the system. For example, if you have an open alert for “Host Down” and you delete that host from
MMS, then the alert is canceled. When an alert is canceled, MMS does not send a notification and does not record an
entry in the activity feed.
Manage Alerts
View Open Alerts To view open alerts, click the Activity tab and then select All Activity. The All Activity page
displays a feed of all events tracked by MMS. If you have open alerts, the page displays them above the feed.
Filter Activity Feed You can filter the event feed by date.
Step 1: Select the Activity tab and then select All Activity.
Step 2: Click the gear icon and specify a date range.
Download Activity Feed You can download the event feed as a CSV file (comma-separated values).
Step 1: Select the Activity tab and then select All Activity.
Step 2: Click the gear icon and select Download as CSV File. You can download all events or choose to filter the
feed before downloading. MMS limits the number of events returned to 10,000.
Acknowledge an Open Alert
Step 1: Select the Activity tab. The All Activity page appears.
Step 2: On the line item for the alert, click Acknowledge.
Step 3: Select the time period for which to acknowledge the alert.
the period of time you select.
42
MMS will send no further alert messages for
Step 4: Click Acknowledge. After you acknowledge the alert, MMS sends no further notifications to the alert’s
distribution list until the acknowledgement period has passed or until the alert is resolved. The distribution list receives
no notification of the acknowledgment.
If the alert condition ends during the acknowledgment period, MMS sends a notification of the resolution. For example,
if you acknowledge a host-down alert and the host comes back up during the acknowledgement period, MMS sends
you a notification that the host is up.
If you configure an alert with PagerDuty, a third-party incident management service, you can only acknowledge the
alert on your PagerDuty dashboard.
Unacknowledge an Acknowledged Alert
Step 1: Select the Activity tab. The All Activity page appears.
Step 2: On the line item for the alert, click Unacknowledge.
Step 3: Click Confirm. If the alert condition continues to exist, MMS will resend alerts.
View Closed Alerts To view closed alerts, click the Activity tab and then select Closed Alerts. The Closed Alerts
page displays alerts that users have closed explicitly or where the metric has dropped below the threshold of the alert.
Alert Conditions
Overview
MMS provides configurable alert conditions that you can apply to MMS components, such as hosts, clusters, or agents.
This document groups the conditions according to the target components to which they apply.
Select alert conditions when configuring alerts, for more information on configuring alerts, see the Create an Alert
Configuration and Manage Alerts documents.
Host Alerts
The Host Alerts are applicable to MongoDB hosts (i.e. mongos and mongod instances). and are grouped here
according to the category monitored.
Host Status
is down
Sends an alert when MMS does not receive a ping from a host for more than 9 minutes. Under normal operation
the Monitoring Agent connects to each monitored host about once per minute. MMS will not alert immediately,
however, but waits nine minutes in order to minimize false positives, as would occur, for example, during a host
restart.
is recovering
Sends an alert when a secondary member of a replica set enters the RECOVERING state. For information on
the RECOVERING state, see Replica Set Member States.
43
does not have latest version
This does not apply to On-Prem MMS.
Sends an alert when the version of MongoDB running on a host is more than two releases behind. For example
if the current production version of MongoDB is 2.6.0 and the previous release is 2.4.9 then a host running
version 2.4.8 will trigger this alert but a host running 2.4.9 (previous) 2.6.0 (current) or 2.6.1-rc2 (nightly) will
not.
is exposed to the public internet
Sends an alert when the host is exposed to the public internet. When configured, MMS periodically attempts
to make a socket connection to your hosts. If MMS is able to connect, MMS triggers the alert. MMS runs this
check the 1st and 15th of the month only.
Asserts These alert conditions refer to the metrics found on the host’s asserts chart. To view the chart, see
Accessing a Host’s Statistics.
Asserts: Regular is
Sends an alert if the rate of regular asserts meets the specified threshold.
Asserts: Warning is
Sends an alert if the rate of warnings meets the specified threshold.
Asserts: Msg is
Sends an alert if the rate of message asserts meets the specified threshold. Message asserts are internal server
errors. Stack traces are logged for these.
Asserts: User is
Sends an alert if the rate of errors generated by users meets the specified threshold.
Opcounter These alert conditions refer to the metrics found on the host’s opcounters chart. To view the chart,
see Accessing a Host’s Statistics.
Opcounter: Cmd is
Sends an alert if the rate of commands performed meets the specified threshold.
Opcounter: Query is
Sends an alert if the rate of queries meets the specified threshold.
Opcounter: Update is
Sends an alert if the rate of updates meets the specified threshold.
Opcounter: Delete is
Sends an alert if the rate of deletes meets the specified threshold.
Opcounter: Insert is
Sends an alert if the rate of inserts meets the specified threshold.
Opcounter: Getmores is
Sends an alert if the rate of getmore (i.e. cursor batch) operations meets the specified threshold. For more
information on getmore operations, see the Cursors page in the MongoDB manual.
Opcounter - Repl These alert conditions apply to hosts that are secondary members of replica sets. The alerts use
the metrics found on the host’s opcounters - repl chart. To view the chart, see Accessing a Host’s Statistics.
Opcounter: Repl Cmd is
Sends an alert if the rate of replicated commands meets the specified threshold.
Opcounter: Repl Update is
Sends an alert if the rate of replicated updates meets the specified threshold.
44
Opcounter: Repl Delete is
Sends an alert if the rate of replicated deletes meets the specified threshold.
Opcounter: Repl Insert is
Sends an alert if the rate of replicated inserts meets the specified threshold.
Memory These alert conditions refer to the metrics found on the host’s memory and non-mapped virtual
memory charts. To view the charts, see Accessing a Host’s Statistics. For additional information about these metrics,
click the i icon for each chart.
Memory: Resident is
Sends an alert if the size of the resident memory meets the specified threshold. It is typical over time, on a
dedicated database server, for the size of the resident memory to approach the amount of physical RAM on the
box.
Memory: Virtual is
Sends an alert if the size of virtual memory for the mongod process meets the specified threshold. You can
use this alert to flag excessive memory outside of memory mapping. For more information, click the memory
chart’s i icon.
Memory: Mapped is
Sends an alert if the size of mapped memory, which maps the data files, meets the specified threshold. As
MongoDB memory-maps all the data files, the size of mapped memory is likely to approach total database size.
Memory: Computed is
Sends an alert if the size of virtual memory that is not accounted for by memory-mapping meets the specified
threshold. If this number is very high (multiple gigabytes), it indicates that excessive memory is being used outside of memory mapping. For more information on how to use this metric, view the non-mapped virtual
memory chart and click the chart’s i icon.
B-tree These alert conditions refer to the metrics found on the host’s btree chart. To view the chart, see Accessing
a Host’s Statistics.
B-tree: accesses is
Sends an alert if the number of accesses to B-tree indexes meets the specified average.
B-tree: hits is
Sends an alert if the number of times a B-tree page was in memory meets the specified average.
B-tree: misses is
Sends an alert if the number of times a B-tree page was not in memory meets the specified average.
B-tree: miss ratio is
Sends an alert if the ratio of misses to hits meets the specified threshold.
Lock % This alert condition refers to metric found on the host’s lock % chart. To view the chart, see Accessing a
Host’s Statistics.
Effective Lock % is
Sends an alert if the amount of time the host is write locked meets the specified threshold. For details on this
metric, view the lock % chart and click the chart’s i icon.
Background This alert condition refers to metric found on the host’s background flush avg chart. To view
the chart, see Accessing a Host’s Statistics.
45
Background Flush Average is
Sends an alert if the average time for background flushes meets the specified threshold. For details on this
metric, view the background flush avg chart and click the chart’s i icon.
Connections The following alert condition refers to a metric found on the host’s connections chart. To view the
chart, see Accessing a Host’s Statistics.
Connections is
Sends an alert if the number of active connections to the host meets the specified average.
Queues These alert conditions refer to the metrics found on the host’s queues chart. To view the chart, see Accessing a Host’s Statistics.
Queues: Total is
Sends an alert if the number of operations waiting on a lock of any type meets the specified average.
Queues: Readers is
Sends an alert if the number of operations waiting on a read lock meets the specified average.
Queues: Writers is
Sends an alert if the number of operations waiting on a write lock meets the specified average.
Page Faults These alert conditions refer to metrics found on the host’s Record Stats and Page Faults
charts. To view the charts, see Accessing a Host’s Statistics.
Accesses Not In Memory: Total is
Sends an alert if the rate of disk accesses meets the specified threshold. MongoDB must access data on disk if
your working set does not fit in memory. This metric is found on the host’s Record Stats chart.
Page Fault Exceptions Thrown: Total is
Sends an alert if the rate of page fault exceptions thrown meets the specified threshold. This metric is found on
the host’s Record Stats chart.
Page Faults is
Sends an alert if the rate of page faults (whether or not an exception is thrown) meets the specified threshold.
This metric is found on the host’s Page Faults chart.
Cursors These alert conditions refer to the metrics found on the host’s cursors chart. To view the chart, see
Accessing a Host’s Statistics.
Cursors: Open is
Sends an alert if the number of cursors the server is maintaining for clients meets the specified average.
Cursors: Timed Out is
Sends an alert if the number of timed-out cursors the server is maintaining for clients meets the specified average.
Cursors: Client Cursors Size is
Sends an alert if the cumulative size of the cursors the server is maintaining for clients meets the specified
average.
Network These alert conditions refer to the metrics found on the host’s network chart. To view the chart, see
Accessing a Host’s Statistics.
Network: Bytes In is
Sends an alert if the number of bytes sent to the database server meets the specified threshold.
46
Network: Bytes Out is
Sends an alert if the number of bytes sent from the database server meets the specified threshold.
Network: Num Requests is
Sends an alert if the number of requests sent to the database server meets the specified average.
Replication These alert conditions refer to the metrics found on a primary’s replication oplog window
chart or a secondary’s replication lag chart. To view the charts, see Accessing a Host’s Statistics.
Replication Oplog Window is
Sends an alert if the approximate amount of time available in the primary’s replication oplog meets the specified
threshold.
Replication Lag is
Sends an alert if the approximate amount of time that the secondary is behind the primary meets the specified
threshold.
Replication Headroom is
Sends an alert when the difference between the primary oplog window and the replication lag time on a secondary meets the specified threshold.
Oplog Data per Hour is
Sends an alert when the amount of data per hour being written to a primary’s oplog meets the specified threshold.
DB Storage This alert condition refers to the metric displayed on the host’s db storage chart. To view the chart,
see Accessing a Host’s Statistics.
DB Storage is
Sends an alert if the amount of on-disk storage space used by extents meets the specified threshold. Extents are
contiguously allocated chunks of datafile space.
DB storage size is larger than DB data size because storage size measures the entirety of each extent, including
space not used by documents. For more information on extents, see the collStats command.
DB Data Size is
Sends an alert if approximate size of all documents (and their paddings) meets the specified threshold.
Journaling These alert conditions refer to the metrics found on the host’s journal - commits in write
lock chart and journal stats chart. To view the charts, see Accessing a Host’s Statistics.
Journaling Commits in Write Lock is
Sends an alert if the rate of commits that occurred while the database was in write lock meets the specified
average.
Journaling MB is
Sends an alert if the average amount of data written to the recovery log meets the specified threshold.
Journaling Write Data Files MB is
Sends an alert if the average amount of data written to the data files meets the specified threshold.
Replica Set Alerts
These alert conditions are applicable to replica sets.
Primary Elected
Sends an alert when a set elects a new primary. Each time MMS receives a ping, it inspects the output of the
replica set’s rs.status() method for the status of each replica set member. From this output, MMS determines
47
which replica set member is the primary. If the primary found in the ping data is different than the current
primary known to MMS, this alert triggers.
Primary Elected does not always mean that the set elected a new primary. Primary Elected may
also trigger when the same primary is re-elected. This can happen when MMS processes a ping in the midst of
an election.
No Primary
Sends an alert when a replica set does not have a primary. Specifically, when none of the members of a replica
set have a status of PRIMARY, the alert triggers. For example, this condition may arise when a set has an even
number of voting members resulting in a tie.
If the Monitoring Agent collects data during an election for primary, this alert might send a false positive. To
prevent such false positives, set the alert configuration’s after waiting interval (in the configuration’s Send to
section).
Number of Healthy Members is below
Sends an alert when a replica set has fewer than the specified number of healthy members. If the replica set has
the specified number of healthy members or more, MMS triggers no alert.
A replica set member is healthy if its state, as reported in the rs.status() output, is either PRIMARY or
SECONDARY. Hidden secondaries and arbiters are not counted.
As an example, if you have a replica set with one member in the PRIMARY state, two members in
the SECONDARY state, one hidden member in the SECONDARY, one ARBITER, and one member in the
RECOVERING state, then the healthy count is 3.
Number of Unhealthy Members is above
Sends an alert when a replica set has more than the specified number of unhealthy members. If the replica set
has the specified number or fewer, MMS sends no alert.
Replica set members are unhealthy when the agent cannot connect to them, or the member is in a rollback or
recovering state.
Hidden secondaries are not counted.
Agent Alerts
These alert conditions are applicable to Monitoring Agents and Backup Agents.
Monitoring Agent is down
Sends an alert if the Monitoring Agent has been down for at least 7 minutes. Under normal operation, the
Monitoring Agent sends a ping to MMS roughly once per minute. If MMS does not receive a ping for at least 7
minutes, this alert triggers. However, this alert will never trigger for a group that has no hosts configured.
Important: When the Monitoring Agent is down, MMS will trigger no other alerts. For example, if a host is
down there is no Monitoring Agent to send data to MMS that could trigger new alerts.
Backup Agent is down
Sends an alert if the Backup Agent has been down for at least 15 minutes. Under normal operation, the Backup
Agent periodically sends data to MMS. This alert is never triggered for a group that has no running backups.
Monitoring Agent is out of date
Sends an alert when the Monitoring Agent is not running the latest version of the software.
Backup Agent is out of date
Sends an alert when the Backup Agent is not running the latest version of the software.
48
Backup Alerts
These alert conditions are applicable to the MMS Backup service.
Oplog Behind
Sends an alert if the most recent oplog data received by MMS is more than 75 minutes old.
Resync Required
Sends an alert if the replication process for a backup falls too far behind the oplog to catch up. This occurs when
the host overwrites oplog entries that backup has not yet replicated. When this happens, backup must be fully
resynced.
Cluster Mongos Is Missing
Sends an alert if MMS cannot reach a mongos for the cluster.
User Alerts
These alert conditions are applicable to the MMS Users.
Added to Group
Sends an alert when a new user joins the group.
Removed from Group
Sends an alert when a user leaves the group.
Changed Roles
Sends an alert when a user’s roles have been changed.
Group Alert
This alert condition applies to MMS groups.
Users awaiting approval to join group
Sends an alert if there are users who have asked to join the group. A user can ask to join a group when first
registering for MMS.
4.10 Monitoring Metrics
Deployment Description of the Deployment tab, which lists all hosts that are currently being monitored.
Host Statistics In-depth guide to host statistics and the options that you can specify to customize your view.
Aggregated Cluster Statistics Compare hosts dynamically across the cluster.
Replica Set Statistics Compare hosts dynamically across a replica set.
Profile Databases Collect profile data for the host.
Deployment
Deployment provides access to all your monitored objects. The Deployment tab includes the pages described here.
49
Deployment Page
The Deployment page provides access to all monitored mongod and mongos instances. The page includes the
following information:
Field
Last Ping
Host
Orange triangle icon under a host name.
Description
The last time this agent sent a ping to the MMS servers.
Click a ping to view a detailed status from the ping.
The hostname and port of the instance. Click the hostname to view host statistics.
The startup warning indicator for the host. Only displayed when warnings exist. Click the host’s last ping
for warning details. MMS startup warnings can include
the following:
• MMS suspects the host has a low ulimit setting of less than 1024. MMS infers the host’s
ulimit setting using the total number of available and current connections. See the UNIX
ulimit Settings reference page.
• MMS flags a deactivated host.
Important: If you have deactivated hosts, review
all deactivated hosts to ensure that they are still in
use, and remove all hosts that are not active. Then
click on the warning icon and select Reactive ALL
hosts.
Type
Cluster
Shard
Repl Set
Up Since
Version
The type of host. Possible types include the following:
• PRIMARY
• SECONDARY
• STANDALONE
• ARBITER
When the host recovers, the rectangle flag turns yellow
and displays RECOVERING. When the host returns a fatal error, the flag displays FATAL. The flag also can display NO DATA.
The name of the cluster to which this instance belongs.
Only cluster members display this value. Click the cluster name to display aggregated information on the cluster’s replica sets. See Aggregated Cluster Statistics for
details.
The name of the shard.
The name of the shard’s replica set. Click the replica
set name to display replica set statistics. See Replica Set
Statistics for details.
The date the host first pinged MMS.
The version of the MongoDB running on this instance.
Host Mapping Page
The Host Mapping page shows the mapping between system hostnames and the names provided by the monitored
mongod and mongos processes.
50
Host Statistics
For each host, MMS provides an extensive set of charts for analyzing the statistics collected by the Monitoring Agent.
Accessing a Host’s Statistics
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the process, click the ellipses icon and select Performance Metrics.
Step 4: Hover the mouse pointer over a chart to display chart controls.
Information on a Host’s Chart.
To use the controls, see Accessing
Accessing Information on a Host’s Chart
Hover the mouse cursor over the chart to display the chart controls.
• Click the i icon for a description of the chart.
• Click-and-drag to select a portion of the chart to zoom into. All charts on the page zoom to the same level.
• Double-click to revert the charts back to the default zoom setting.
• Hover the mouse pointer over a point on the chart to display statistics for that point in time.
• Click the two-way arrow to open an expanded version of the chart.
• Click the curved arrow for a list of additional actions:
– Chart Permalink opens a page that displays only this chart.
– Email Chart opens a dialogue box where you can input an email address and short message to send the
chart by email.
• Click and hold the upper-left triangular grabber to move the chart to a different place on the page.
Chart Annotations
Annotations may appear as colored vertical lines on your charts to indicate server events. The following color/event
combinations are:
• A red bar indicates a server restart.
• A purple bar indicates the server is now a primary.
• A yellow bar indicates the server is now a secondary.
If you do not wish to see the chart annotations, you can disable them on the Administration tab’s Personalization page.
51
Aggregated Cluster Statistics
Overview
Cluster statistics provide an interface to view data for an entire cluster at once. You can compare components dynamically across the cluster and view host-specific and aggregated data, as well as pinpoint moments in time and isolate
data to specific components.
Procedure
To view cluster statistics:
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the cluster, click the ellipses icon and select Performance Metrics. MMS displays a
chart and table with an initial set of cluster statistics. At the top of the chart, the DATA SIZE field measures the cluster’s
data size on disk. For more information, see the explanation of dataSize on the dbStats page.
If Backup is enabled, hover the mouse pointer over the “clock” icon to view the time of the last snapshot and time of
the next scheduled snapshot. Click the icon to view snapshots.
Step 4: Select the components to display. In the buttons above the chart, select whether to display the cluster’s
shards, mongos instances, or config servers.
If you select shards, select whether to display Primaries, Secondaries, or Both using the buttons at the chart’s lower
right.
The chart displays a different colored line for each component. The table below displays additional data for each
component, using the same colors.
Step 5: Select the data to display. Select the type of data in the CHART drop-down list. MMS graphs the data for
each component individually. You can instead graph the data as an average or sum by clicking the Averaged or Sum
button at the chart’s lower right.
Step 6: Change the granularity and zoom. To the right of the chart, select a GRANULARITY for the data. The
option you select determines the available ZOOM options. Whenever you change the granularity, the selected zoom
level changes to the closest zoom level available for that granularity.
To zoom further and isolate a specific region of data, click-and-drag on that region of the chart. To reset the zoom
level, double-click anywhere on the chart.
Step 7: View metrics for a specific date and time. Move the mouse pointer over the chart to view data for a point
in time. The data in the table below the chart changes as you move the pointer.
52
Step 8: Isolate certain components for display. To remove a component from the chart, click its checkmark in the
table below the chart. To again display it, click the checkmark again.
To quickly isolate just a few components from a large number displayed, select the None button below the chart
and then select the checkmark for the individual components to display. Alternatively, select the All button and then
deselect the checkmark for individual components not to display.
Step 9: View statistics for a specific component. In the table below the chart, click a component’s name to display
its statistics page.
If your are viewing shards, you can click the replica set name in the SHARDS column to display replica set statistics,
or you can click the P or S icon in the MEMBERS column to display host statistics for a primary or secondary. Hover
over an icon for tooltip information.
Step 10: Change the name of the cluster. If you want to change the name of the cluster, hover the mouse pointer
over the cluster name. A pencil icon appears. Click the icon and enter the new name.
Replica Set Statistics
Overview
The Replica set statistics interface makes is possible to view data from all replica set members at once.
Procedure
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: Click the ellipses icon next to the replica set and click Performance Metrics. MMS displays a separate
chart for each replica set member.
Step 4: Select the members to display. In the TOGGLE MEMBERS section at the top of the page, click the P and
S icons to choose which members to display. Hover the mouse pointer over an icon to display member information.
Step 5: Select the granularity and the zoom. Select the GRANULARITY of the data displayed. The selected
granularity option determines the available ZOOM options.
To isolate a specific region of data, click-and-drag on that region of the chart. All other charts automatically zoom to
the same region.
To reset the zoom level, double-click anywhere on the chart.
Step 6: Add, remove, and reorder charts. Add and remove charts using either the Add Chart drop-down list or the
buttons at bottom of the page.
Move a chart within the display by hovering the mouse over the chart, clicking the grabber in the upper left corner,
and dragging the chart to the new position.
53
Step 7: View an explanation of a chart’s data. Hover the mouse pointer over the and click the i icon.
Step 8: View metrics for a specific date and time. Move the mouse pointer over the chart to view data for a point
in time.
Profile Databases
Overview
MMS Monitoring can collect data from MongoDB’s profiler to provide statistics about performance and database
operations.
Considerations
Before enabling profiling, be aware of these issues:
• Profile data can include sensitive information, including the content of database queries. Ensure that exposing
this data to MMS Monitoring is consistent with your information security practices.
• The profiler can consume resources which may adversely affect MongoDB performance. Consider the implications before enabling profiling.
Procedures
Enable Profiling To allow MMS Monitoring to collect profile data for a specific process:
Note: The Monitoring Agent attempts to minimize its effect on the monitored systems. If resource intensive operations, like polling profile data, begins to impact the performance of the database, MMS Monitoring will throttle the
frequency that it collects data. See How does MMS gather database statistics? for more information about the agent’s
throttling process.
When enabled, MMS Monitoring samples profiling data from monitored processes. The agent sends only the most
recent 20 entries from last minute.
With profiling enabled, configuration changes made in MMS can take up to 2 minutes to propagate to the agent and
another minute before profiling data appears in the MMS interface.
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: On the line item for the process, click the ellipses icon and select Monitoring Settings.
Step 3: Click the Profiling tab.
Step 4: Turn on profiling. Click the button to toggle between Off and On. When the button is On, MMS receives
database profile statistics.
Step 5: Start database profiling by using the mongo shell to modify the setProfilingLevel command.
See the database profiler documentation for instructions for using the profiler.
54
Display Profiling Levels When profiling is on, the Profile Data tab displays profiled data. For more information on
profiling, see the database profiler documentation in the MongoDB manual.
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: On the line listing the process, click the ellipses icon and select Performance Metrics.
Step 3: Select the Profile Data tab.
Delete Profile Data Deleting profile data deletes the Web UI cache of the current profiling data. You must then
disable profiling or drop or clear the source collection, or MMS will repopulate the profiling data.
If MMS Monitoring is storing a large amount of profile data for your instance, the removal process will not be instantaneous.
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: On the line listing the process, click the ellipses icon and select Performance Metrics.
Step 3: Select the Profile Data tab.
Step 4: Click the Delete Profile Data button at the bottom of the page.
Step 5: Confirm the deletion. MMS begins removing stored profile data from the server’s record. MMS removes
only the Web UI cache of the current profiling data. The cache quickly re-populates with the same data if you do not
disable profiling or drop or clear the profiled collection.
4.11 View Logs
Overview
MMS collects log information for both MongoDB and the MMS agents. For MongoDB deployments, MMS provides
access to both real-time logs and on-disk logs.
The MongoDB logs provide the diagnostic logging information for your mongod and mongos instances. The Agent
logs provide insight into the behavior of your MMS agents.
MongoDB Real-Time Logs
The Monitoring Agent collects real-time log information from each MongoDB deployment by issuing the getLog
command with every monitoring ping. The getLog command collects log entries from the MongoDB RAM cache.
MMS enables real-time log collection by default. You can disable log collection for either the whole MMS group or
for individual MongoDB instances. If you disable log collection, MMS continues to display previously collected log
entries.
55
View MongoDB Real-Time Logs
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the topology view by clicking the first of the two Processes icons.
Step 3: On the line listing the process, click the ellipses icon and select Performance Metrics.
Step 4: Click the Logs tab. The tab displays log information. If the tab instead diplays the Collect Logs For Host
option, toggle the option to On and refresh the page.
Step 5: Refresh the browser window to view updated entries.
Enable or Disable Log Collection for a Deployment
Step 1: Select the Deployment tab and then the Deployment page.
Step 2: Select the list view by clicking the second of the two Processes icons.
Step 3: On the line for any process, click the ellipses icon and select Monitoring Settings.
Step 4: Click the Logs tab and toggle the Off /On button as desired.
Step 5: Click X to close the Edit Host box. The deployment’s previously existing log entries will continue to appear
in the Logs tab, but MMS will not collect new entries.
Enable or Disable Log Collection for the Group
Step 1: Select the Administration tab, then the Group Settings page.
Step 2: Set the Collect Logs For All Hosts option to On or Off, as desired.
MongoDB On-Disk Logs
MMS can collect on-disk logs even if the MongoDB instance is not running. The Automation Agent collects the logs
from the location specified by the MongoDB systemLog.path configuration option. The MongoDB on-disk logs
are a subset of the real-time logs and therefore less verbose.
You can configure log rotation for the on-disk logs. MMS enables log rotation by default.
View MongoDB On-Disk Logs
Step 1: Select the Deployment tab and then Mongo Logs page. Alternatively, you can select the Deployment
page’s edit mode, then the arrow to the right of a deployment, then the gear icon drop-down list, and then Request
Logs.
56
Step 2: Request the latest logs. To request the latest logs:
1. Click the Manage drop-down button and select Request Server Logs.
2. Select the checkboxes for the logs you want to request, then click Request Logs.
Step 3: To view a log, select the Show Log link for the desired date and hostname.
Configure Log Rotation
Step 1: Select the Deployment tab and then Mongo Logs page.
Step 2: Click the Manage drop-down button and select MongoDB Log Settings.
Step 3: Configure the log rotation settings and click Save.
Step 4: Click Review & Deploy.
Step 5: Click Confirm & Deploy.
Agent Logs
MMS collects logs for all your Automation Agents, Monitoring Agents, and Backup Agents. To view the logs:
Step 1: From any page, click an agent icon at the top of the page and select Logs.
MMS opens the Agent Logs page and displays the log entries for agents of the same type.
You can also open the Agent Logs page by selecting the Administration tab, then Agents page, and then view logs link
for a particular agent. The page displays the agent’s log entries.
Step 2: Filter the log entries.
Use the drop-down list at the top of the page to display different types of agents.
Use the gear icon to the right of the page to clear filters and to export logs.
5 Back Up MongoDB Deployments
Backup Preparations Before backing up your cluster or replica set, decide how to back up the data and what data to
back up.
Activate Backup Activate MMS Backup for a cluster or replica set.
Restore MongoDB Deployments Procedures to restore complete MongoDB deployments using Backup data.
Restore MongoDB Data Procedures to restore data from Backup to MongoDB instances.
Backup Maintenance Procedures to manage backup operations for maintenance.
57
5.1 Backup Preparations
Overview
Before backing up your cluster or replica set, decide how to back up the data and what data to back up. This page
describes items you must consider before starting a backup. For an overview of how Backup works, see Backup.
Snapshot Frequency and Retention Policy
You can take snapshots every 6, 8, 12, or 24 hours and save them for 2-5 days. MMS can retain daily snapshots for up
to 365 days, weekly snapshots for up to 52 weeks, and monthly snapshots for up to 36 months. By default, MMS uses
the retention policy described here.
Changes to the snapshot schedule will affect your snapshot storage costs. The longer your snapshot window, the longer
it will take to build a point in time restore. Administrators can change the schedule through the snapshotSchedule
resource in the API.
Excluded Namespaces
Excluded namespaces are databases or collections that MMS will not back up. Exclude namespaces to prevent backing
up collections that contain logging data, caches, or other ephemeral data. Excluding these kinds of databases and
collections will allow you to reduce backup time and costs.
Storage Engine
When you enable backups for a cluster or replica set that runs on MongoDB 3.0 or higher, you can choose the storage
engine for the backups. Your choices are the MMAPv1 engine or WiredTiger engine. If you do not specify a storage
engine, MMS uses MMAPv1 by default. For more information on storage engines, see Storage in the MongoDB
manual.
You can choose a different storage engine for a backup than you do for the original data. There is no requirement
that the storage engine for a backup match that of the data it replicates. If your original data uses MMAPv1, you can
choose WiredTiger for backing up, and vice versa.
You can change the storage engine for a cluster or replica set’s backups at any time, but doing so requires an initial
sync of the backup on the new engine.
If you choose the WiredTiger engine to back up a collection that already uses WiredTiger, the initial sync replicates all the collection’s WiredTiger options.
For information on these options, see the
storage.wiredTiger.collectionConfig section of the Configuration File Options page in the MongoDB
manual.
Index collection options are never replicated.
Resyncing Production Deployments
For production deployments, it is recommended that as a best practice you periodically (annually) resync all backed-up
replica sets. When you resync, data is read from a secondary in each replica set. During resync, no new snapshots are
generated.
58
Checkpoints
For sharded clusters, checkpoints provide additional restore points between snapshots. With checkpoints enabled,
MMS Backup creates restoration points at configurable intervals of every 15, 30 or 60 minutes between snapshots.
To create a checkpoint, MMS Backup stops the balancer and inserts a token into the oplog of each shard and config
server in the cluster. These checkpoint tokens are lightweight and do not have a consequential impact on performance
or disk use.
Backup does not require checkpoints, and they are disabled by default.
Restoring from a checkpoint requires MMS Backup to apply the oplog of each shard and config server to the last
snapshot captured before the checkpoint. Restoration from a checkpoint takes longer than restoration from a snapshot.
Snapshots when Agent Cannot Stop Balancer
For sharded clusters, MMS disables the balancer before taking a cluster snapshot. In certain situations, such as a long
migration or no running mongos, MMS tries to disable the balancer but cannot. In such cases, MMS will continue
to take cluster snapshots but will flag the snapshots with a warning that data may be incomplete and/or inconsistent.
Cluster snapshots taken during an active balancing operation run the risk of data loss or orphaned data.
Snapshots when Agent Cannot Contact a mongod
For sharded clusters, if the Backup Agent cannot reach a mongod instance, whether a shard or config server, then the
agent cannot insert a synchronization oplog token. If this happens, MMS will not create the snapshot and will display
a warning message.
5.2 Activate Backup
Overview
You can back up a sharded cluster, replica set, or a standalone that has been set up as a single-member replica set.
Prerequisites
• MMS must be monitoring the deployment. For a sharded cluster, MMS must also be monitoring at least one
mongos in the cluster.
• A replica set must be MongoDB version 2.2.0 or later.
• A sharded-cluster must be MongoDB version 2.4.3 or later.
• Each replica set must have an active primary.
• For a sharded cluster, all config servers must be running and the balancing round must have completed within
the last hour.
• If you explicitly select a sync target, ensure that the sync target is accessible on the network and keeping up with
replication.
Procedure
Before using this procedure, see the Backup Preparations to decide how to back up the data and what data to back up.
59
Step 1: Select the Backup tab.
Step 2: Select the replica set or cluster to back up.
If you have not yet enabled Backup, select Begin Setup and follow the prompts. Skip the rest of the this procedure.
If you have already enabled Backup, navigate to either the Sharded Cluster Status or Replica Set Status page. Then
click the Start button for the replica set or cluster to back up.
Step 3: Select which process to use for the initial Sync Source.
To minimize the impact on the primary, sync off a secondary.
Step 4: If using access control, specify mechanism and credentials, as needed.
Auth Mechanism
Current DB Username
Current DB Password
My deployment supports
SSL for MongoDB
connections
The authentication mechanism used by the host. Can specify MONGODB-CR,
LDAP (PLAIN), or Kerberos(GSSAPI).
If the authentication mechanism is MONGODB-CR or LDAP, the username used
to authenticate the Monitoring Agent to the MongoDB deployment. See Configure
Backup Agent for MONGODB-CR, Configure Backup Agent for LDAP
Authentication, or Configure the Backup Agent for Kerberos for setting up user
credentials.
If the authentication mechanism is MONGODB-CR or LDAP, the password used
to authenticate the Monitoring Agent to the MongoDB deployment. See Configure
Backup Agent for MONGODB-CR, Configure Backup Agent for LDAP
Authentication, or Configure the Backup Agent for Kerberos for setting up user
credentials.
If checked, the Monitoring Agent must have a trusted CA certificate in order to
connect to the MongoDB instances. See Configure Monitoring Agent for SSL.
You can optionally configure authentication credentials later through the deployment’s gear icon.
Step 5: To optionally select a storage engine or exclude namespaces, click Show Advanced Options.
Select the following as desired:
Storage Engine: Select MongoDB Memory Mapped for the MongoDB default MMAPv1 engine or WiredTiger for
the 64-bit WiredTiger engine available beginning with MongoDB 3.0. Before selecting a storage engine, see the
considerations in Storage Engines.
Manage Excluded Namespaces: Click Manage Excluded Namespaces and enter the databases and collections to exclude. For colletions, enter the full namespace: <database>.<collection>. Click Save. You can later add or
remove namespaces from the backup, as needed. For more information, see Excluded Namespaces.
Step 6: Click Start Backup.
5.3 Restore MongoDB Deployments
Use these procedures to restore an entire MongoDB deployment using Backup artifacts. For more specific tutorials
for restoration, please see the Restore MongoDB Instances with Backup procedures.
60
Restore Sharded Cluster Restore a sharded cluster from a stored snapshot.
Restore Replica Set Restore a replica set from a stored snapshot or custom point-in-time snapshot.
Restore a Sharded Cluster from a Backup
Overview
You can restore a sharded cluster onto new hardware from the artifacts captured by MMS Backup.
You can restore from a snapshot or checkpoint. When you restore from a checkpoint, MMS takes the snapshot previous
to the checkpoint and applies the oplog to create a custom snapshot. Checkpoint recovery takes longer than recovery
from a stored snapshot.
MMS provides restore files as downloadable archive; MMS can also scp files directly to your system. The scp
delivery method requires additional configuration but provides faster delivery.
MMS provides a separate backup artifacts for each shard and one file for the config servers.
Sequence
The sequence to restore a snapshot is to:
• select and download the restore files,
• distribute the restore files to their new locations,
• start the mongod instances,
• configure each shard’s replica set, and
• configure and start the cluster.
Considerations
Client Requests During Restoration You must ensure that the MongoDB deployment does not receive client requests during restoration. You must either:
• restore to new systems with new hostnames and reconfigure your application code once the new deployment is
running, or
• ensure that the MongoDB deployment will not receive client requests while you restore data.
Snapshots when Agent Cannot Stop Balancer MMS displays a warning next to cluster snapshots taken while
the balancer is enabled. If you restore from such a snapshot, you run the risk of lost or orphaned data. For more
information, see Snapshots when Agent Cannot Stop Balancer.
Procedures
Select and Download the Snapshot Files
Step 1: Select the Backup tab and then select Sharded Cluster Status.
Step 2: Click the name of the sharded cluster to restore. MMS displays your selection’s stored snapshots.
61
Step 3: Select the snapshot from which to restore. To select a stored snapshot, click the Restore this snapshot
link next to the snapshot.
To select a custom snapshot, click the Restore button at the top of the page. In the resulting page, select a snapshot
as the starting point. Then select the Use Custom Point In Time checkbox and enter the point in time in the Date and
Time fields. MMS includes all operations up to but not including the point in time. For example, if you select 12:00,
the last operation in the restore is 11:59:59 or earlier. Click Next.
Step 4: Select HTTP as the delivery method for the snapshot. In the Delivery Method field, select Pull via Secure
HTTP (HTTPS).
Optionally, you can instead choose SCP as the delivery method. If you choose SCP, you must provide the hostname
and port of the server to receive the files and provide access to the server through a username and password or though
an SSH key. Follow the instructions on the MMS screen.
Step 5: Select tar.gz as the download format. In the Format drop-down list, select Archive (tar.gz).
Step 6: Finalize the request. Click Finalize Request and confirm your identify via two-factor verification. Then
click Finalize Request again.
Step 7: Retrieve the snapshot. MMS creates one-time links to tar files for the snapshot. The links are available for
one download each, and each expires after an hour.
To download the tar files, select the MMS Backup tab and then Restore Jobs. When the restore job completes, the
download link appears for every config server and shard in the cluster. Click each link to download the tar files and
copy each tar file to its server. For a shard, copy the file to every member of the shard’s replica set.
If you optionally chose SCP as the delivery method, the files are copied to the server directory you specfied. To verify
that the files are complete, see the section on how to validate an SCP restore.
Restore Each Shard’s Primary
server that provides the primary:
For all shards, restore the primary. You must have a copy of the snapshot on the
Step 1: Shut down the entire replica set. Connect to each member of the set and issue the following:
use admin
db.shutdownServer()
For version 2.4 or earlier, use db.shutdownServer({force:true}).
Step 2: Restore the snapshot data files to the primary. Extract the data files to the location where the mongod
instance will access them through the dbpath setting. If you are restoring to existing hardware, use a different data
directory than used previously. The following are example commands:
tar -xvf <backup-restore-name>.tar.gz
mv <backup-restore-name> /data
Step 3: Start the primary with the new dbpath. For example:
mongod --dbpath /<path-to-data> --replSet <replica-set-name> --logpath /<path-to-data>/mongodb.log --
62
Step 4: Connect to the primary and initiate the replica set. For example, first issue the following to connect:
mongo
And then issue rs.initiate():
rs.initiate()
Step 5: Restart the primary as a standalone, without the --replSet option. For example, first issue the following to shut down. (For version 2.4 or earlier, use db.shutdownServer({force:true})):
use admin
db.shutdownServer()
And then restart as a standalone:
mongod --dbpath /<path-to-data> --logpath /<path-to-data>/mongodb.log --fork
Step 6: Connect to the primary and drop the oplog. For example, first issue the following to connect:
mongo
And then issue rs.drop() to drop the oplog.
use local
db.oplog.rs.drop()
Step 7: Run the seedSecondary.sh script on the primary. The seedSecondary.sh script re-creates the oplog
collection and seeds it with the timestamp of the snapshot’s creation. This will allow the secondary to come back up to
time without requiring a full initial sync. This script is customized by MMS for this particular snapshot and is included
in the backup restore file.
To run the script, issue the following command at the system prompt, where <mongod-port> is the port of the
mongod instance and <oplog-size-in-gigabytes> is the size of the replica set’s oplog:
./seedSecondary.sh <mongod-port> <oplog-size-in-gigabytes>
Step 8: Restart the primary as part of a replica set. For example, first issue the following to shut down. (For
version 2.4 or earlier, use db.shutdownServer({force:true})):
use admin
db.shutdownServer()
And then restart as part of a replica set:
mongod --dbpath /<path-to-data> --replSet <replica-set-name>
Restore All Secondaries After you have restored the primary for a shard you can restore all secondaries. You must
have a copy of the snapshot on all servers that provide the secondaries:
Step 1: Connect to the server where you will create the new secondary.
63
Step 2: Restore the snapshot data files to the secondary. Extract the data files to the location where the mongod
instance will access them through the dbpath setting. If you are restoring to existing hardware, use a different data
directory than used previously. The following are example commands:
tar -xvf <backup-restore-name>.tar.gz
mv <backup-restore-name> /data
Step 3: Start the secondary as a standalone, without the --replSet option. For example, first issue the following to shut down. (For version 2.4 or earlier, use db.shutdownServer({force:true})):
use admin
db.shutdownServer()
And then restart as a standalone:
mongod --dbpath /<path-to-data> --logpath /<path-to-data>/mongodb.log --fork
Step 4: Run the seedSecondary.sh script on the secondary. The seedSecondary.sh script re-creates the oplog
collection and seeds it with the timestamp of the snapshot’s creation. This will allow the secondary to come back up to
time without requiring a full initial sync. This script is customized by MMS for this particular snapshot and is included
in the backup restore file.
To run the script, issue the following command at the system prompt, where <mongod-port> is the port of the
mongod instance and <oplog-size-in-gigabytes> is the size of the replica set’s oplog:
./seedSecondary.sh <mongod-port> <oplog-size-in-gigabytes>
Step 5: Restart the secondary as part of the replica set. For example, first issue the following to shut down. (For
version 2.4 or earlier, use db.shutdownServer({force:true})):
use admin
db.shutdownServer()
And then restart as part of a replica set:
mongod --dbpath /<path-to-data> --replSet <replica-set-name>
Step 6: Connect to the primary and add the secondary to the replica set. Connect to the primary and use
rs.add() to add the secondary to the replica set.
rs.add("<host>:<port>")
Repeat this operation for each member of the set.
Restore Each Config Server Perform this procedure separately for each config server. Each config server must
have a copy of the tar file with the config server data.
Step 1: Restore the snapshot to the config server. Extract the data files to the location where the config server’s
mongod instance will access them. This is the location you will specify as the dbPath when running mongod for
the config server.
tar -xvf <backup-restore-name>.tar.gz
mv <backup-restore-name> /data
64
Step 2: Start the config server. The following example starts the config server using the new data:
mongod --configsvr --dbpath /data
Step 3: Update the sharded cluster metadata. If the new shards do not have the same hostnames and ports as the
original cluster, you must update the shard metadata. To do this, connect to each config server and update the data.
First connect to the config server with the mongo shell. For example:
mongo
Then access the shards collection in the config database. For example:
use config
db.shards.find().pretty()
The find() method returns the documents in the shards collection. The collection contains a document for each
shard in the cluster. The host field for a shard displays the name of the shard’s replica set and then the hostname and
port of the shard. For example:
{ "_id" : "shard0000", "host" : "shard1/localhost:30000" }
To change a shard’s hostname and port, use the MongoDB update() command to modify the documents in the
shards collection.
Start the mongos Start the cluster’s mongos bound to your new config servers.
Restore a Replica Set from a Backup
Overview
You can restore a replica set from the artifacts captured by MMS Backup. You can restore either a stored snapshot or
a point in time in the last 24 hours between snapshots. If you restore from a point in time, MMS Backup creates a
custom snapshot for the selected point by applying the oplog to the previous regular snapshot. Point-in-time recovery
takes longer than recovery from a stored snapshot.
When you select a snapshot to restore, MMS creates a link to download the snapshot as a tar file. The link is available
for one download only and times out after an hour. You can optionally have MMS scp the tar file directly to your
system. The scp delivery method requires additional configuration but provides faster delivery.
You can restore either to new hardware or existing hardware. If you restore to existing hardware, use a different data
directory than used previously.
Sequence
The sequence used here to restore a replica set is to download the restore file and distribute it to each server, restore
the primary, and then restore the secondaries. For additional approaches to restoring replica sets, see the procedure
from the MongoDB Manual to Restore a Replica Set from a Backup.
Prerequisites
Oplog Size To seed each replica set member, you will use the seedSecondary.sh script included in the backup
restore file. When you run the script, you will provide the replica set’s oplog size, in gigabytes. If you do not have
65
the size, see the section titled “Check the Size of the Oplog” on the Troubleshoot Replica Sets page of the MongoDB
manual.
Client Requests
You must either:
You must ensure that the MongoDB deployment does not receive client requests during restoration.
• restore to new systems with new hostnames and reconfigure your application code once the new deployment is
running, or
• ensure that the MongoDB deployment will not receive client requests while you restore data.
Procedures
Select and Download the Snapshot
Step 1: Select the Backups tab and then select Replica Set Status.
Step 2: Click the name of the replica set to restore. MMS displays your selection’s stored snapshots.
Step 3: Select the snapshot from which to restore. To select a stored snapshot, click the Restore this snapshot
link next to the snapshot.
To select a custom snapshot, click the Restore button at the top of the page. In the resulting page, select a snapshot
as the starting point. Then select the Use Custom Point In Time checkbox and enter the point in time in the Date and
Time fields. MMS includes all operations up to but not including the point in time. For example, if you select 12:00,
the last operation in the restore is 11:59:59 or earlier. Click Next.
Step 4: Select HTTP as the delivery method for the snapshot. In the Delivery Method field, select Pull via Secure
HTTP (HTTPS).
Optionally, you can instead choose SCP as the delivery method. If you choose SCP, you must provide the hostname
and port of the server to receive the files and provide access to the server through a username and password or though
an SSH key. Follow the instructions on the MMS screen.
Step 5: Finalize the request. Click Finalize Request and confirm your identify via two-factor verification. Then
click Finalize Request again.
Step 6: Retrieve the snapshot. MMS creates a one-time link to a tar file of the snapshot. The link is available for
one download and times out after an hour.
To download the snapshot, select the MMS Backup tab and then select Restore Jobs. When the restore job completes,
select the download link next to the snapshot.
If you optionally chose SCP as the delivery method, the files are copied to the server directory you specfied. To verify
that the files are complete, see the section on how to validate an SCP restore.
Step 7: Copy the snapshot to each server to restore.
Restore the Primary You must have a copy of the snapshot on the server that provides the primary:
66
Step 1: Shut down the entire replica set. Connect to each member of the set and issue the following:
use admin
db.shutdownServer()
For version 2.4 or earlier, use db.shutdownServer({force:true}).
Step 2: Restore the snapshot data files to the primary. Extract the data files to the location where the mongod
instance will access them through the dbpath setting. If you are restoring to existing hardware, use a different data
directory than used previously. The following are example commands:
tar -xvf <backup-restore-name>.tar.gz
mv <backup-restore-name> /data
Step 3: Start the primary with the new dbpath. For example:
mongod --dbpath /<path-to-data> --replSet <replica-set-name> --logpath /<path-to-data>/mongodb.log --
Step 4: Connect to the primary and initiate the replica set. For example, first issue the following to connect:
mongo
And then issue rs.initiate():
rs.initiate()
Step 5: Restart the primary as a standalone, without the --replSet option. For example, first issue the following to shut down. (For version 2.4 or earlier, use db.shutdownServer({force:true})):
use admin
db.shutdownServer()
And then restart as a standalone:
mongod --dbpath /<path-to-data> --logpath /<path-to-data>/mongodb.log --fork
Step 6: Connect to the primary and drop the oplog. For example, first issue the following to connect:
mongo
And then issue rs.drop() to drop the oplog.
use local
db.oplog.rs.drop()
Step 7: Run the seedSecondary.sh script on the primary. The seedSecondary.sh script re-creates the oplog
collection and seeds it with the timestamp of the snapshot’s creation. This will allow the secondary to come back up to
time without requiring a full initial sync. This script is customized by MMS for this particular snapshot and is included
in the backup restore file.
To run the script, issue the following command at the system prompt, where <mongod-port> is the port of the
mongod instance and <oplog-size-in-gigabytes> is the size of the replica set’s oplog:
67
./seedSecondary.sh <mongod-port> <oplog-size-in-gigabytes>
Step 8: Restart the primary as part of a replica set. For example, first issue the following to shut down. (For
version 2.4 or earlier, use db.shutdownServer({force:true})):
use admin
db.shutdownServer()
And then restart as part of a replica set:
mongod --dbpath /<path-to-data> --replSet <replica-set-name>
Restore Each Secondary After you have restored the primary you can restore all secondaries. You must have a
copy of the snapshot on all servers that provide the secondaries:
Step 1: Connect to the server where you will create the new secondary.
Step 2: Restore the snapshot data files to the secondary. Extract the data files to the location where the mongod
instance will access them through the dbpath setting. If you are restoring to existing hardware, use a different data
directory than used previously. The following are example commands:
tar -xvf <backup-restore-name>.tar.gz
mv <backup-restore-name> /data
Step 3: Start the secondary as a standalone, without the --replSet option. For example, first issue the following to shut down. (For version 2.4 or earlier, use db.shutdownServer({force:true})):
use admin
db.shutdownServer()
And then restart as a standalone:
mongod --dbpath /<path-to-data> --logpath /<path-to-data>/mongodb.log --fork
Step 4: Run the seedSecondary.sh script on the secondary. The seedSecondary.sh script re-creates the oplog
collection and seeds it with the timestamp of the snapshot’s creation. This will allow the secondary to come back up to
time without requiring a full initial sync. This script is customized by MMS for this particular snapshot and is included
in the backup restore file.
To run the script, issue the following command at the system prompt, where <mongod-port> is the port of the
mongod instance and <oplog-size-in-gigabytes> is the size of the replica set’s oplog:
./seedSecondary.sh <mongod-port> <oplog-size-in-gigabytes>
Step 5: Restart the secondary as part of the replica set. For example, first issue the following to shut down. (For
version 2.4 or earlier, use db.shutdownServer({force:true})):
use admin
db.shutdownServer()
And then restart as part of a replica set:
68
mongod --dbpath /<path-to-data> --replSet <replica-set-name>
Step 6: Connect to the primary and add the secondary to the replica set. Connect to the primary and use
rs.add() to add the secondary to the replica set.
rs.add("<host>:<port>")
Repeat this operation for each member of the set.
5.4 Restore MongoDB Instances with Backup
Use the procedures in these tutorials to restore data from Backup artifacts to MongoDB instances. If you want to
restore an entire MongoDB deployment, use the Restore MongoDB Deployments tutorials.
Restore from a Stored Snapshot Restore a replica set or sharded cluster from a stored snapshot.
Restore from a Point in the Last Day Restore a replica set from a custom snapshot from any point within a 24-hour
period of time.
Restore a Single Database Restore only a portion of a backup to a new mongod instance.
Seed a New Secondary Use MMS Backup to seed a new secondary in an existing replica set.
Restore from a Stored Snapshot
Overview
With MMS Backup, you can restore from a stored snapshot or build a custom snapshot reflecting a different point in
the last 24 hours. For all backups, restoring from a stored snapshot is faster than restoring from a custom snapshot in
the last 24 hours.
MMS Backup automatically takes and stores a snapshot every 6 hours. These snapshots are available for restores
following the snapshot retention policy.
For replica sets, you will receive one .tar.gz file containing your data; for sharded clusters, you will receive a series
of .tar.gz files.
Procedure
Step 1: Select the Backups tab, and then select either Sharded Cluster Status or Replica Set Status.
Step 2: Click the name of the sharded cluster or replica set to restore. MMS displays your selection’s stored
snapshots.
Step 3: Select the snapshot from which to restore. To select a stored snapshot, click the Restore this snapshot
link next to the snapshot.
To select a custom snapshot, click the Restore button at the top of the page. In the resulting page, select a snapshot
as the starting point. Then select the Use Custom Point In Time checkbox and enter the point in time in the Date and
Time fields. MMS includes all operations up to but not including the point in time. For example, if you select 12:00,
the last operation in the restore is 11:59:59 or earlier. Click Next.
69
Step 4: Select HTTP as the delivery method for the snapshot. In the Delivery Method field, select Pull via Secure
HTTP (HTTPS).
Optionally, you can instead choose SCP as the delivery method. If you choose SCP, you must provide the hostname
and port of the server to receive the files and provide access to the server through a username and password or though
an SSH key. Follow the instructions on the MMS screen.
Step 5: Finalize the request. Click Finalize Request and confirm your identify via two-factor verification. Then
click Finalize Request again.
Step 6: Retrieve the snapshot. To download the snapshot, select the MMS Backup tab and then select Restore Jobs.
When the restore job completes, select the download link next to the snapshot.
For a sharded clusters, MMS provides several download links for the several .tar.gz files.
Step 7: Extract the data files from the .tar.gz archive created by the backup service.
tar -zxvf <tarball-name>.tar.gz
Step 8: Select the location where the mongod will access the data files. The directory you choose will become
the mongod’s data directory. You can either create a new directory or use the existing location of the extracted data
files.
If you create a new directory, move the files to that directory.
If you use the existing location of the extracted data files, you can optionally create a symbolic link to the location
using the following command, where <hash>-<rsname>-<time> is the name of the snapshot and <dbpath> is
the data directory:
ln -s <hash>-<rsname>-<time>/ <dbpath>
Step 9: Start the mongod with the new data directory as the dbpath. In the mongod configuration, set the
dbpath option to the path of the data directory that holds the data files from the MMS Backup snapshot.
mongod --dbpath /data/db
Additional Information
Restore from a Point in the Last 24 Hours
Restore from a Point in the Last 24 Hours
MMS Backup lets you restore data from a point within the last 24-hour period. MMS creates a backup that includes all
operations up to the point in time you select. The point in time is an upper exclusive bound: if you select a timestamp
of 12:00, then the last operation in the restore will be no later than 11:59:59.
To restore from a point in time, see the procedure for the resource you are restoring:
• Restore a Sharded Cluster from a Backup
• Restore a Replica Set from a Backup
70
Restore a Single Database
Overview
A backup snapshot contains a complete copy of the contents of your mongod dbpath. To restore a single collection
or database or partial data, retrieve a backup snapshot and expand the snapshot data on a volume. Then use the
mongodump and mongorestore commands to build and restore your data.
Procedure
Select and Download a Snapshot
Step 1: Select the Backups tab and then select Replica Set Status.
Step 2: Click the name of the replica set that contains the database to restore. MMS displays your selection’s
stored snapshots.
Step 3: Select the snapshot from which to restore. To select a stored snapshot, click the Restore this snapshot
link next to the snapshot.
To select a custom snapshot, click the Restore button at the top of the page. In the resulting page, select a snapshot
as the starting point. Then select the Use Custom Point In Time checkbox and enter the point in time in the Date and
Time fields. MMS includes all operations up to but not including the point in time. For example, if you select 12:00,
the last operation in the restore is 11:59:59 or earlier. Click Next.
Step 4: Select HTTP as the delivery method for the snapshot. In the Delivery Method field, select Pull via Secure
HTTP (HTTPS).
Optionally, you can instead choose SCP as the delivery method. If you choose SCP, you must provide the hostname
and port of the server to receive the files and provide access to the server through a username and password or though
an SSH key. Follow the instructions on the MMS screen.
Step 5: Finalize the request. Click Finalize Request and confirm your identify via two-factor verification. Then
click Finalize Request again.
Step 6: Retrieve the snapshot. MMS creates a one-time link to a tar file of the snapshot. The link is available for
one download and times out after an hour.
To download the snapshot, select the MMS Backup tab and then select Restore Jobs. When the restore job completes,
select the download link next to the snapshot.
If you optionally chose SCP as the delivery method, the files are copied to the server directory you specfied. To verify
that the files are complete, see the section on how to validate an SCP restore.
Restore the Database
71
Step 1: Use the mongodump command to dump a single database. Use the unpacked snapshot restore directory
as the dpath switch and the single database name as the --db switch in the mongodump command:
mongodump --dbpath <path> --db <database-name>
Step 2: Use the mongorestore command to import the single database dump. Enter this mongorestore
command:
mongorestore --db <database-name> --drop
You also may specify the --drop switch to drop all collections from the target database before you restore them from
the bson file created with mongodump.
Seed a New Secondary from Backup Restore
Overview
When a natural synchronization of a new secondary host costs too much time or resources, seeding a secondary from
an MMS Backup restore is a faster better alternative. Seeding also does not impact an active MongoDB instance to
retrieve data.
Prerequisites
To seed a secondary from a backup restore file, you must have:
• A backup restore file.
• The seedSecondary.sh script included in the backup restore file.
When you run the seedSecondary.sh script as part of this tutorial, you must provide the replica set’s oplog size,
in gigabytes. If you do not have the size, see the section titled “Check the Size of the Oplog” on the Troubleshoot
Replica Sets page of the MongoDB manual.
Considerations
An MMS backup stores all database files in a single directory. If you run MongoDB with the directoryPerDb
option, then after restore you must redistribute the files to the different databases. MMS Backup does not provide
restoration artifacts that use the directoryPerDb option.
The seedSecondary.sh file will not be in the backup restore if you have blacklisted dbs or collections or have resynced
your backup after the snapshot (or for config servers). In these cases, including the script would cause an inconsistent
secondary. In the case of a blacklist, your secondary would not include some collections which would cause problems
for your deployment.
Seeding a new secondary from a backup restore requires an oplog window on the current primary that spans back to
the snapshot’s timestamp.
Procedure
Step 1: Remove the broken secondary from your replica set.
rs.remove("SECONDARYHOST:SECONDARYPORT")
72
Step 2: Login to the server on which to create the new secondary.
Step 3: Bring up new node as a standalone.
tar -xvf backup-restore-name.tar.gz
mv backup-restore-name data
mongod --port <alternate-port> --dbpath /data
Where ALTERNATEPORT is not the usual port your secondary runs on.
Step 4: Run seedSecondary.sh script to create oplog collection and seed with correct timestamp. The seedSecondary.sh script re-creates the oplog collection and seeds it with correct timestamp.
To run the script, issue the following command at the system prompt, where <mongod-port> is the port of the
mongod instance and <oplog-size-in-gigabytes> is the size of the replica set’s oplog:
./seedSecondary.sh <mongod-port> <oplog-size-in-gigabytes>
Step 5: Shut down the new secondary on the alternate port.
Step 6: Start up the new secondary.
mongod --port <secondary-port> --dbpath /data
--replSet REPLICASETNAME
Step 7: Add the new secondary to the replica set on the primary host.
rs.add("<secondary-host>:<secondary-port>")
5.5 Backup Maintenance
Configure Backup Data Delivery Select MMS Backup delivery method and file format.
Delete Backup Snapshots Manually remove unneeded stored snapshots from MMS.
Stop, Disable, Restart Backup Procedures to stop, restart, or disable backup.
Resync Backup If your Backup oplog has fallen too far behind your deployment to catch up, you must resync the
Backup service.
Select Backup File Delivery Method and Format
Overview
With MMS Backup, you can restore from a stored snapshot or, if you are restoring a replica set, you may build a
custom snapshot reflecting a different point in the last 24 hours. For all backups, restoring from a stored snapshot is
faster than restoring from a custom snapshot in the last 24 hours.
Once you select a backup-enabled sharded cluster or replica set to restore, the next step is to select the delivery method
and file format.
Procedures
Select Backup File via Secure HTTP (HTTPS) In the Select Restore Destination window, select Pull via Secure
HTTP (HTTPS) to create a one-time direct download link.
73
Select Backup File via Secure Copy (SCP) In the Select Restore Destination window, select Push via Secure Copy
(SCP). You can grant access by supplying MMS with a username and password to your server, or you can provide a
username and grant access via SSH public key.
To grant access via SSH public key:
Step 1: Select the Administration tab, and then select Group Settings.
Step 2: Scroll down to the Backup Restore Settings section.
Step 3: In the Passphrase box, enter a passphrase and then click the Generate a New Public Key button. MMS
Backup generates and displays a public key.
Step 4: Log in to your server using the same username you will supply in your restore request.
Step 5: Add your public key to the authorized hosts file for that user. For security reasons, you should remove
the public key from the authorized hosts file once you have obtained your backup file. The authorized hosts file is
often located at ~/.ssh/authorized_keys.
Note: For security reasons, you should remove this public key from the authorized hosts file once you have obtained
your backup file.
Select Backup File Format In the Select Restore Destination window, select Individual DB Files or Archive (tar.gz)
as the Format:
• Select Individual DB Files to transmit MongoDB data files produced by MMS Backup directly to the target
directory. The individual database files are faster for MMS Backup to construct, but require additional file space
on the destination server. The data is compressed during transmission.
• Select Archive (tar.gz) to deliver database files in a single tar.gz file you must extract before reconstructing
databases.
Next Steps
Restore from a Stored Snapshot
Restore from a Point in the Last 24 Hours
Delete Snapshots for Replica Sets and Sharded Clusters
Overview
To delete snapshots for replica sets and sharded clusters, use the MMS console to find then select a backup snapshot
to delete.
Constraints
You can delete any replica set or sharded cluster snapshot if it is not needed for replica set point-in-time restores.
74
Procedure
Step 1: Click the MMS Backup tab.
Step 2: Select type of backup file to delete. Select either Replica Set Status or Sharded Cluster Status.
Step 3: Click the name of the replica set or sharded cluster. Displays replica set or sharded cluster details with a
list of possible backup files to delete.
Step 4: Select backup file to delete. On the list of snapshots, click the Delete link to the right of a snapshot.
Step 5: Confirm deletion. Click the OK button on the Delete Snapshot interface to confirm deletion of the backup.
Stop, Start, or Disable the MMS Backup Service
Overview
Stopping the MMS Backup Service for a replica set or sharded cluster suspends the service for that resource. MMS
stops taking new snapshots but retains existing snapshots until their listed expiration date.
After stopping backups, you can restart the Backup Service at any time. Depending how much time has elapsed, the
Backup Service may perform an initial sync.
Disabling the MMS Backup Service, by contrast, immediately deletes all snapshots. Later, if you want back up the
cluster or replica set, when you enable backup, MMS behaves as if the resource has never been backed up. Enabling
backups on a previously disabled resource always requires an initial sync.
Procedures
Stop the Backup Service for a Cluster or Replica Set
Step 1: Click the Backup tab and then click either Sharded Cluster Status or Replica Set Status, depending on
the resource to stop backup for.
Step 2: Click Stop for the cluster or replica set. If prompted, enter the two-factor authentication code, click Verify,
and click Stop again.
Restart the MMS Backup Service
Step 1: Click the Backup tab and then click either Sharded Cluster Status or Replica Set Status, depending on
the resource to re-enable.
Step 2: Click Restart for the cluster or replica set.
Step 3: Select a Sync source and click Restart.
75
Disable the MMS Backup Service
Step 1: Stop and then terminate each sharded cluster enrolled in Backup.
select Sharded Cluster Status.
In MMS, click the Backup tab and
For each cluster enrolled in Backup, click Stop. If prompted, enter the two-factor authentication code, click Verify,
and click Stop again.
When the Terminate button appears, click Terminate. Click Terminate again.
Step 2: Stop and then terminate each replica set enrolled in Backup. In MMS, click the Backup tab and select
Replica Set Status.
For each replica set enrolled in Backup, click Stop. If prompted, enter the two-factor authentication code, click Verify,
and click Stop again.
When the Terminate button appears, click Terminate. Click Terminate again.
Resync Backup
Overview
If you receive a Backup requires resync alert, you must resync the backup for the specified MongoDB instance.
It is also recommended that you resync all backups annually for production deployments.
During resync, data is read from a secondary in each replica set and no new snapshots are generated.
The Backup requires a resync alert occurs if the Backup Agent’s tailing cursor cannot keep up with your
deployment’s oplog. This is similar to when a secondary falls too far behind the primary in a replica set.
Considerations
To ensure the Backup oplog does not fall behind the deployment’s oplog, always provision adequate machine resources
for the agent. If you stop your MMS agents for maintenance reasons, always restart them in a timely manner. To
provide a buffer for maintenance and for occasional activity bursts, ensure that the oplog on the primary is large
enough to contain 24 hours of activity. For more information on the Backup oplog, see the Backup FAQs.
Procedures
Use the appropriate procedure below for your deployment type, sharded cluster or replica set.
Resync a Sharded Cluster
Step 1: Select the Backup tab and then select Sharded Cluster Status.
Step 2: Select See Shards/Configs. The column expands to display the shards and config servers.
76
Step 3: Resync. For the MongoDB instance to resync:
Click the resync link.
Accept the default selection in the Sync source drop-down list, and click the RESYNC button.
If prompted for a two-factor verification code, enter the code and click VERIFY. Then click the RESYNC button again.
Resync a Replica Set
Step 1: Select the Backup tab and then select Replica Set Status.
Step 2: In the replica set’s LAST SYNC column, select resync.
Step 3: Select a Sync source and click the RESYNC button. If prompted for a two-factor verification code, enter
the code and click VERIFY. Then click the RESYNC button again.
6 Administration
Manage Your Account Administer your account and groups.
Manage Your Two-Factor Authentication Options Describes two-factor authentication, which is required for MMS.
Security Describes MMS security features.
Manage Groups Create and manage MMS groups.
Manage MMS Users and Roles Control access to MMS.
Manage MongoDB Users and Roles Control access to your MongoDB deployments.
6.1 Manage Your Account
The Administration tab lets you personalize your console and activate or deactivate a variety of features. The Administration tab provides the pages described here.
Account Page
The Account page allows users to update their personal information.
The username, email address, and password are also used for jira.mongodb.org. Changing your email address or
password in MMS will also change the email address and password you use to log into Jira.
• User Name: Displays the user’s name. You cannot change your username.
• Email Address: Displays the email address MMS associates with your account. You can change your email
address by clicking on the “pencil” icon.
• Mobile Phone Number: The number to use to receive SMS alerts, including two-factor authentication codes.
• Password: Allows you to change your MMS password. Passwords must fulfill MMS‘s password requirements.
• Two-Factor Authentication: MMS requires two factor authentication for login. For details, see Manage Your
Two-Factor Authentication Options.
To delete or reset two-factor authentication, contact |mms| Support.
77
Personalization Page
The Personalization page allows users to configure the console to suit their needs and preferences. The available fields
depend on the user’s role.
• My Time Zone: Sets your local time zone.
• My Date Format: Allows you to select your preferred date format.
• Page Shown When Switching Groups: Sets which page of the MMS console you will see when you select a
different group. If you select Current, MMS will not change pages when you select a different group.
• Display Opcounters On Separate Charts: Allows you to control the presentation of Opcounter Charts. If enabled, MMS charts each opcounter type separately. Otherwise, each opcounter type is overlaid together in a
single chart.
• Display Chart Annotations: Toggles the presence of chart annotations. Chart annotations overlay information
about significant system events on the charts. For example, with chart annotations MMS will draw a red vertical
line over the charts.
• Receive |mms| Newsletters: Allows you to opt-in to, or opt-out of receiving e-mail newsletters about MMS.
API Keys & Whitelists Page
API Keys & Whitelists lets you generate an API key for your MMS group. Use the API key to support automated
installation of your Monitoring Agent with scripts included with the agent installation files.
You can also define an API Whitelist of IP addresses permitted to invoke operations that require a higher level of
security. See Enable the Public API for more information.
My Groups Page
My Groups displays the MMS groups you belong to. From here you can add a group.
Group Settings Page
These settings apply to all users in the group. To set group settings, see Manage Group Settings.
Users Page
Users displays the group’s users and their roles. From here you can add and manage users.
Agents Page
The Agent page displays the status of your installed agent and provides links to download new agents, in both .zip
and .tar.gz formats. The software is dynamically assembled with your API key. Instructions are included to set up
and start the downloaded agent, as well as create a new user for the agent if MongoDB authentication is used.
The Agents page includes the following information about your installed agents:
78
Field
Status
Type
Hostname
State
Ping
Count
Version
Log
Description
The time of the last ping from the agent.
The type of agent.
The hostname for the agent and any warnings, such as that the agent is down or out-of-date.
Indicates whether the agent is active.
The number of pings (i.e. data payloads) sent by the agent since midnight GMT. Typically agents
send pings every minute.
The version of the agent software running on this agent instance.
Click view logs to view the agent’s log.
If you have more than one Monitoring Agent, only one agent actively monitors MongoDB instances at a time. See
Monitoring Architecture for more information.
AWS Settings Page
• AWS Provisioning Settings: Adds an access key for use when provisioning a new AWS server.
• SSH Key for User Account: Adds an SSH key for use when logging into a server that has been provisioned on
AWS.
Billing/Subscriptions
For users with the appropriate permissions, this page displays the account’s payment method and billing history.
Payment History
For users with the appropriate permissions, this page displays the account’s payment history.
6.2 Manage Your Two-Factor Authentication Options
Overview
MMS requires two-factor authentication to help users control access to their MMS accounts. To log into MMS, a
user must provide their password (i.e. “something you know”), as well as a second time-sensitive verification code,
delivered during authentication (i.e. “something you have”). By requiring both factors, MMS can grant authentication
requests with a higher degree of confidence.
MMS users receive verification codes through text messages (SMS), automated voice calls or an application that
implements the Time-based One-time Password Algorithm (TOTP), such as the Google Authenticator application.
Users can configure two-factor authentication mechanisms when signing up for MMS or in the Administration tab’s
Account page in MMS.
Authentication with Text or Voice Messages
Users can receive verification codes through text or voice by providing phone numbers when setting up their MMS
profiles. When a user needs a code, MMS sends the code using text (SMS) or through an automated phone call that
reads out the code.
Certain network providers and countries may impose delays on SMS messages. Users who experience delays should
consider Google Authenticator for verification codes.
79
Note: From India, use Google Authenticator for two-factor authentication. Google Authenticator is more reliable
than authentication with SMS text messages to Indian mobile phone numbers (i.e. country code 91).
Authentication with Applications
Authentication using Google Authenticator Google Authenticator is a smartphone application that uses TOTP to
generate verification codes. When a user needs a code, the application generates a time-based code based on a private
key that was shared between MMS and the user’s Google Authenticator application during the initial pairing process.
The Google Authenticator application does not require a Google account and does not connect a user’s MMS account
to Google in any way. The has both iOS and Android versions, and the user does not need to associate the application
with a Google account. MMS two-factor authentication using Google Authenticator is not in any way integrated with
Google’s own account authentication mechanisms, and MMS does not provide two-factor authentication codes to
Google.
Authentication using Another Implementation of TOTP There are implementations of the Time-based One-time
Password Algorithm (TOTP) other than Google Authenticator. For example, the Authenticator application for Windows Phones.
Ensure that whichever devices runs the TOTP application has it’s own set of robust authentication requirements.
For other implementations of TOTP, consider the list of TOTP implementations on Wikipedia.
Two-Factor Authentication on a Shared Account
A global team that shares the same MMS account can use Google Authenticator and use the same seed code for all
team members. To generate a common seed code that all team members can use, select the Can’t scan the barcode?
link when Configuring Two-Factor Authentication with Google Authenticator.
Procedures
Configure Two-Factor Authentication with Text or Voice
Step 1: In MMS, select the Administration tab and then Account.
Step 2: Select the pencil icon for Two Factor Authentication. Or, if this is the first time you are setting up an
account, click the Configure button to the right side of the Account page and follow the instructions.
Step 3: Select Use Voice/SMS.
Step 4: Enter the phone number for the phone that will receive the codes. If you are outside of the United States
or Canada, you must include 011 and your country code. Alternatively, you can sign up for a Google Voice number
and use that number for your authentication.
Step 5: Select how to receive the codes. Select either Text message (SMS) or Voice call (US/Canada only).
Step 6: Click Send Code. MMS sends the codes to your phone.
80
Step 7: Enter the code in the box provided in MMS and click Verify.
Step 8: Click Save Changes.
Configure Two-Factor Authentication with Google Authenticator
Step 1: Install Google Authenticator from either the Google Play store or the iOS Apple Store, depending on
your device.
Step 2: Run Google Authenticator.
Step 3: Click Begin Setup.
Step 4: When prompted, select how you will enter the shared private key. Under Manually Add an
Account, select either Scan a barcode or Enter provided key. Stay on this screen while you use the
next steps to access the barcode or key in MMS.
Step 5: In MMS, select the Administration tab and then Account.
Step 6: Select the pencil icon for Two Factor Authentication. Or, if this is the first time you are setting up an
account, click the Configure button to the right side of the Account page and follow the instructions.
Step 7: Select Use Google Authenticator. MMS provides a barcode and a Can’t scan the barcode? link.
Step 8: Scan or enter the shared private key. If your smartphone can scan barcodes, then scan the barcode.
Otherwise, click Can’t scan the barcode? and type the provided Key into your smartphone.
Step 9: Enter the Google Authenticator code in MMS. After you scan the barcode or enter the key, Google
Authenticator generates a 6-digit code. Enter that in the box provided in MMS and click Verify.
Step 10: Click Save Changes.
Generate New Recovery Codes
As a backup, you can generate recovery codes to use in place of a sent code when you do not have access to a phone or
your Google Authenticator application. Each recovery code is single-use, and you should save these codes in a secure
place. When you generate new recovery codes, you invalidate previously generated ones.
Step 1: In MMS, select the Administration tab and then Account.
Step 2: Select the pencil icon for Two Factor Authentication. Or, if this is the first time you are setting up an
account, click the Configure button to the right side of the Account page and follow the instructions.
81
Step 3: Select Generate New Recovery Codes.
Keep the codes in a safe place. Each code can be used in conjunction with your username and password to not only
access MMS but to reset your security settings on MMS.
6.3 Security
Overview
MMS provides configurable encryption, authentication, and authorization to ensure the security of your MMS agents
and MongoDB deployments. MMS supports SSL, MONGODB-CR, LDAP, and Kerberos.
SSL Encryption
MMS can use SSL for encrypting communications for the following Monitoring Agent and Backup Agent connections:
• Connections to MMS.
• Connections to MongoDB instances that use SSL. You must set each MongoDB host’s Use SSL setting in MMS
and must configure the agents’ SSL settings. See Configure Monitoring Agent for SSL and Configure Backup
Agent for SSL.
Access Control and Authentication
MongoDB uses Role-Based Access Control (RBAC) to determine access to a MongoDB system. When run with
access control, MongoDB requires users to authenticate themselves to determine their access.
If you enable authentication for your deployments, the MMS agents authenticate to the deployments as MongoDB
users with appropriate privileges.
If a MongoDB deployment runs with access control, the Monitoring and Backup Agents must authenticate to the
deployment as MongoDB users with appropriate access. See the following:
• Required Access for Monitoring Agent
• Required Access for Backup Agent
For an overview on authenticating with the supported mechanisms, see MONGODB-CR, LDAP, and Kerberos.
MONGODB-CR
MMS can use the MongoDB Challenge-Response, i.e. MONGODB-CR, authentication mechanism to authenticate to
a MongoDB deployment. For more information, see the MONGODB-CR section on the Authentication page in the
MongoDB manual.
If your MongoDB deployment uses MONGODB-CR for authentication, you must create a MongoDB user for the MMS
agents as well as specify the host’s authentication settings.
To create a MongoDB user, see Add Monitoring Agent User for MONGODB-CR and Configure Backup Agent for
MONGODB-CR.
You can specify the host’s authentication settings when adding the host, or you can edit the settings for an existing
host.
82
LDAP
MMS agents can use the LDAP authentication mechanism to authenticate to the MongoDB deployment.
Agent Configuration
If your MongoDB deployment uses LDAP for authentication, you must create a MongoDB user for the MMS agents
as well as specify the host’s authentication settings.
To create a MongoDB user for the agents, see Configure Monitoring Agent for LDAP and Configure Backup Agent for
LDAP Authentication.
You can specify the host’s authentication settings when adding the host, or you can edit the settings for an existing
host.
Kerberos
Agent Configuration
If your MongoDB deployment uses Kerberos for authentication, you must create the Kerberos Principal for the MMS
agents, create a MongoDB user for that Kerberos Principal, edit the agent’s configuration file, and specify the host’s
authentication settings.
If you are running both the Monitoring Agent and the Backup Agent on the same server, then both agents must connect
as the same Kerberos Principal.
To create a Kerberos Principal and the associated MongoDB user as well as edit the configuration file, see Configure
the Monitoring Agent for Kerberos and Configure the Backup Agent for Kerberos.
You can specify the host’s authentication settings when adding the host, or you can edit the settings for an existing
host.
Two-Factor Authentication
To activate two-factor authentication, which users and administrators use to authenticate to the MMS interface, see
Manage Your Two-Factor Authentication Options.
Required Ports and IP Addresses
Required Outbound Access
The agents connect to MMS on port 443. Whether you provision your servers on AWS or on your own network,
configure your network infrastructure to allow outbound connections on port 443.
If you wish to restrict outbound access on port 443 to specific IP addresses, you must keep open the following
addresses to allow connection to the mms.mongodb.com and api-backup.mongodb.com servers:
• 54.173.82.137
• 54.175.147.155
The MMS Agents will GET AND POST to these IPs on port 443.
83
Additionally, the Automation Agents require outbound access on port 443 to download MongoDB binaires from the
fastdl.mongodb.org domain, provided by Amazon Cloudfront. The IP ranges for Cloudfront change frequently.
See the current list of IP ranges for Cloudfront.
Required Inbound Access
If you are not using MMS provisioning, you do not need to keep any inbound ports open.
If you are using MMS provisioning, you must, at minimum, grant SSH access to the following ranges:
• 4.71.186.128/25
• 4.35.16.128/25
Important: MongoDB reserves the right to change these IP addresses at any time without user notice.
For information specific to AWS access, see How MMS uses SSH Access to AWS.
Required Ports on Your Network
All MongoDB processes must be accessible to all MMS Agents. Therefore, all MongoDB ports must be open to every
server that hosts an Automation, Monitoring or Backup Agent. For example, if you are running MongoDB processes
on 27000, 27017 and 27020, then those three ports must be open from all servers that are hosting an MMS Agent.
6.4 Manage Groups
Overview
Groups associate MMS users with MongoDB in the MMS application. A group provides access to a distinct MMS
environment or deployment. Each group has one Monitoring Agent and Backup Agent.
You create the first MMS group when you register the first MMS user. Create additional groups to manage segregated
systems or environments. For example, your deployment might have two or more environments separated by firewalls.
In this case, you would need two or more separate MMS groups.
MMS API and shared secret keys are unique to each group. Each group requires its own Monitoring Agent with
the appropriate API and shared secret keys. Within each group, the agent needs to be able to connect to all hosts it
monitors in the group.
You can manage the users that have access to your MMS groups and assign roles to users to provide controlled access
to MMS.
Working with Multiple Environments
If you have multiple MongoDB systems in distinct environments and cannot monitor all systems with a single agent,
you will need to add a new group. Having a second group makes it possible to run two agents.
You may also use a second group and agent to monitor a different set of MongoDB instances in the same environment
if you want to segregate the hosts within the MMS console. A user can only view data from the hosts monitored in a
single group at once.
After adding a second group, the MMS interface will have a drop-down list that will allow you to change groups.
Selecting a new group will refresh the current page with the data available from the servers in this group.
84
Procedures
Create a Group
When you create a new group, you are automatically added as the first user to the group. The group is automatically
assigned a set of alert configurations.
Step 1: Select the Administration tab and then the My Groups page.
Step 2: Click the ADD GROUP button.
Step 3: Type a name for the new group and click CONTINUE. For security and auditing reasons, you cannot use
a name used earlier. Once you name a group, the group’s name cannot be changed.
Step 4: Assign Hosts. After you create the group, MMS will log you into the group and displays a Welcome page.
To create the group’s first deployment, click either BEGIN SETUP to use the MMS set-up wizard or click Advanced
Setup to add a deployment manually.
Remove a Group
Please contact MMS support to remove a company or group from your MMS account.
Manage Group Settings
Step 1: Select the Administration tab and then select Group Settings.
Step 2: Modify group settings as desired. See Group Settings options for a full description of the group settings.
If you have Global Owner access, the interface displays a second Group Settings link under the Admin Only section.
For information on these settings, see Admin Only Group Settings.
Group Settings
The following settings in the Administration tab’s Group Settings page apply to all users in the group:
• Group Time Zone: Sets your group’s time zone.
• Collect Logs For All Hosts: Activates or deactivates the collection of log data for all hosts. This overwrites the
statuses set on the individual hosts.
• Collect Profiling Information for All Hosts: Activates or deactivates the collection of profiling information for
all hosts. MMS Monitoring can collect data from MongoDB’s profiler to provide statistics about performance
and database operations. Ensure exposing profile data to MMS Monitoring is consistent with your information
security practices. Also be aware the profiler can consume resources which may adversely affect MongoDB
performance.
• Collect Database Specific Statistics: Allows you to enable or disable the collection of database statistics. For
more information, see “How does |mms| gather database statistics?”.
• Enable Public API: Allows you to use the Public API with the group.
85
• Reset Duplicates: Allows you to reset and remove all detected duplicate hosts. This is useful if your server
environment has drastically changed and you believe a host is incorrectly marked as a duplicate.
• Preferred Hostnames: Allows you to specify the hostname to use for servers with multiple aliases. This prevents
servers from appearing multiple times under different names. By default, the Monitoring Agent tries to connect
by resolving hostnames. If the agent cannot connect by resolving a hostname, you can force the Monitoring
Agent to prefer an IP address over its corresponding hostname for a specific IP address. To override this default
behavior, set an IP address as a preferred hostname. If your IP addresses have a common prefix, create a
preferred hostname with the ends-with button or click the regexp button to use a regular expression.
• Public Key for SCP Restores: If you use MMS Backup, this setting allows you to generate a public key for SCP
backup restoration. If you restore a snapshot through SCP, MMS uses the key to transmit the snapshot. For more
information on restores, see Restore MongoDB Instances with Backup, and how to validate an SCP restore and
other SCP FAQs.
• PagerDuty Service Key: Adds a service key for a PagerDuty account. This is the default key used if you create
an alert configuration that uses PageDuty.
• HipChat Settings: Adds a room and API token for a HipChat account. These are the default settings used if you
create an alert configuration that uses HipChat.
Admin Only Group Settings
The following group settings in the Admin Only section of the Administration tab could, in certain situations, affect
more than the group. For example, setting logging to a high verbosity would cause system logs to roll over faster.
Only users with the Global Owner role can edit these settings:
• Mongos Deactivation Threshold: Change the amount of time before MMS stops monitoring an unreachable
mongos. By default, the Monitoring Agent stops monitoring an unreachable mongos after 24 hours. Set this
to the amount of time in hours to wait before deactivation.
• Monitoring Agent Log Level: Change the verbosity of the Monitoring Agent log.
• Automation Agent Log Level: Change the verbosity of the Automation Agent log.
6.5 Manage MMS Users and Roles
MMS requires authentication to log into a MMS account and provides user-based roles to control access to MMS
features.
Manage MMS Users Create and manage MMS users and assign roles.
MMS Roles Describes the user roles available within the MMS.
Manage MMS Users
Overview
MMS users provide access to MMS groups. You can create a new user in a group to give access to that group. You
can later give the user access to additional groups. When you create a user, you assign the user a role in the group. A
role determines the actions the user can perform and the data the user can access.
Procedures
Add Users
86
Step 1: Click the Administration tab and then select the Users page.
Step 2: Click the ADD USER button.
Step 3: Enter the new user’s email address and role. You can optionally enter a JIRA username instead of an
email address.
Step 4: Click ADD/INVITE.
Step 5: If prompted, enter the two-factor verification code. There might be a delay of a few seconds before you
receive the prompt. MMS will prompt you for a two-factor verification code if you have not verified recently.
Step 6: Click the Send Email Invitation button. If the console finds a connected Jira account, MMS will automatically add the user to your Jira group and the MMS console.
Users can also create accounts using the account registration page, or through Jira at jira.mongodb.org.
Note: If you create an account in Jira or make any changes to that account from within Jira, it can take up to 30
minutes for that change to propagate to MMS. During this window you cannot add a user to a group in MMS. Also,
passwords changed in Jira are subject to the same propagation delay for MMS accounts.
View MMS Users To view users, click the Administration tab and then Users page. The Users page lists users who
have access to your MMS group, their roles, their time zones, and other information. The page also lists any invitations
to join the group waiting for a reply, as well as any requests from users who want to join the group. A user can request
to join a group when first registering for MMS.
View Invitations When you invite a user to join a group, MMS then sends an email to the prospective new user. To
view invitations sent but not yet accepted, click the Administration tab and then select the Users page. The page lists
any users with pending invitations. To cancel an invitation, click CANCEL INVITE.
View Requests Users can request access when they create their MMS account, as on the registration page.
To view requests, click the Administration tab and then select the Users page. The Users page lists any pending
requests to join your group. To approve or deny a request, click the appropriate button.
Remove MMS Users
Step 1: Click the Administration tab and then select the Users page.
Step 2: Remove the user. Click the user’s gear icon and select Delete User.
Assign Roles to MMS Users Assign roles to MMS users to limit the actions they can perform and the data they can
view.
To assign roles to users in a group, you must have either the User Admin role or Owner role in the group.
To assign roles inside of MMS, select the Administration tab and then the Users page. Click the user’s gear icon and
select Edit User. Click the appropriate checkboxes to assign roles.
87
MMS Roles
Overview
MMS roles allow you to grant users different levels of access to MMS. You can grant a user the privileges needed to
perform a specific set of tasks and no more.
To assign user roles, see Assign Roles to MMS Users. You cannot assign your own roles.
Read Only The Read Only role has the lowest level of privileges. The user can generally see everything in a group,
including all activity, operational data, users, and user roles. The user, however, cannot modify or delete anything.
User Admin The User Admin role grants access to do the following:
• Add an existing user to a group.
• Invite a new user to a group.
• Remove an existing group invitation.
• Remove a user’s request to join a group, which denies the user access to the group.
• Remove a user from a group.
• Modify a user’s roles within a group.
• Update the billing email address.
Monitoring Admin The Monitoring Admin role grants all the privileges of the Read Only role and grants additional access to do the following:
• Manage alerts (create, modify, delete, enable/disable, acknowledge/unacknowledge).
• Manage hosts (add, edit, delete, enable deactivated).
• Manage group-wide settings.
• Download Monitoring Agent.
Backup Admin The Backup Admin role grants all the privileges of the Read Only role and grants access to manage
backups, including the following:
• Start, stop, and terminate backups.
• Request restores.
• View and edit excluded namespaces.
• View and edit host passwords.
• Modify backup settings.
• Generate SSH keys.
• Download the Backup Agent.
88
Automation Admin The Automation Admin role grants all the privileges of the Read Only role and grants access
to the following management actions:
• View deployments.
• Provision machines.
• Edit configuration files.
• Modify settings.
• Download the Automation Agent.
Billing Admin The Billing Admin role grants access to modify the account’s payment methods.
Owner The Owner role has the privileges of all the other roles combined, as well as additional privileges available
only to Owner. In addition to the privileges of other roles, an Owner can:
• Set up the Backup service.
• Update billing information.
• Enable the Public API.
Roles
Each role grants privileges within a group.
6.6 Manage MongoDB Users and Roles
You can enable MongoDB access control and manage MongoDB users and roles directly from the MMS interface.
Enable Access Control on MongoDB Deployments Control access to MongoDB databases.
Manage MongoDB Users and Roles Add MongoDB users and assign roles.
Manage Custom Roles Create custom roles.
Enable Access Control on MongoDB Deployments
Overview
Access control provides MongoDB authentication and authorization on your deployments. Authentication requires
clients to provide user credentials before they can connect to MongoDB. Authorization limits each client to the resources and actions allowed by the client’s roles. If you leave access control disabled, any client can access any
database in your deployments and perform any action.
When you enable MongoDB access control, you enable it for all the deployments in your MMS group. The group
shares one set of users for all deployments, but each user has permissions only for specific resources.
Access control applies to the MMS agents as well as to clients. When you enable access control, MMS creates the
appropriate users for the agents.
89
Considerations
Once you enable access control, you must create MongoDB users so that clients can access your databases. Always
use the MMS interface to manage users and roles. Do not do so through direct connection to a MongoDB instance.
When you enable access control, MMS creates a user with global privileges used only by the Automation Agent. The
first user you create can be any type of user, as the Automation Agent guarantees you will always have access to user
management.
For more information on MongoDB access control, see the Authentication and Authorization pages in the MongoDB
manual.
Procedure
Enable Authentication
Step 1: Select the Deployment tab and then select Authentication & Users.
Step 2: Turn on authentication. Click the button for Auth Enabled to toggle it to Yes. This automatically creates
users for your Monitoring, Backup, and Automation agents.
Step 3: Click Review & Deploy.
Step 4: Review your changes, and click Confirm & Deploy.
Next Steps To create your first users and assign privileges, see Manage MongoDB Users and Roles.
Manage MongoDB Users and Roles
Overview
When MongoDB access control is enabled, you provide client access to MongoDB by creating users and assigning
user roles. The users you create apply to all MongoDB instances in your MMS group, but each user has a specified
authentication database. Together, the user’s name and database serve as a unique identifier for that user.
You can specify access using MongoDB’s built-in roles and also by creating custom roles. MMS provides the interface
for doing so.
You can create users before enabling accessing control or after, but they don’t go into effect until you enable access
control. The MongoDB instances won’t require user credentials until access control is enabled.
To authenticate, a client must specify the username, password, database, and authentication mechanism. For example,
from the mongo shell, a client would specify the --username, --password, --authenticationDatabase,
and --authenticationMechanism options.
MongoDB users are separate from MMS users. MongoDB users have access to MongoDB databases. MMS users
access to MMS groups.
90
Considerations
If you want MMS to ensure that all deployments in a group have the same database users and roles, use only the MMS
interface to manage users.
However, if you want certain deployments in a group to have certain users or roles not set at the group level, you can
add them through direct connection to the MongoDB instances.”
Procedures
Add a MongoDB User
Step 1: Select the Deployment tab and then select Authentication & Users.
Step 2: Select the ADD USER button.
Step 3: In the Identifier fields, enter the the database on which the user authenticates and enter a username.
Together, the database and username uniquely identify the user. Though the user has just one authentication database,
the user can have privileges on other database. You grant privileges when assigning the user roles.
Step 4: In the Roles drop-down list, select the user’s roles. You can assign both user-defined roles and built-in
roles.
Step 5: Enter the user’s password and click ADD USER.
Step 6: Click Review & Deploy.
Step 7: Review your changes, and click Confirm & Deploy.
Edit a User’s Roles
Step 1: Select the Deployment tab and then select Authentication & Users.
Step 2: Click the user’s gear icon and select Edit.
Step 3: Edit the user’s information. In the Roles drop-down list, you can both add and delete roles. You can add
both user-defined roles and built-in roles.
Step 4: Click SAVE CHANGES.
Step 5: Click Review & Deploy.
Step 6: Review your changes, and click Confirm & Deploy.
91
Remove a MongoDB User
Step 1: Select the Deployment tab and then select Authentication & Users.
Step 2: Click the user’s gear icon and select Remove.
Step 3: To confirm, click DELETE USER.
Step 4: Click Review & Deploy.
Step 5: Review your changes, and click Confirm & Deploy.
Manage Custom Roles
Overview
Roles grant users access to MongoDB resources. By default, MongoDB provides a number of built-in roles, but if
these roles cannot describe a desired privilege set, you can create custom roles.
When you create a role, you specify the database to which it applies. MMS stores your custom roles on all MongoDB
instances in your MMS group but uniquely identifies a role by the combination of the database name and role name.
If a database with that name exists on multiple deployments within your MMS group, the role applies to each of those
databases. If you create a role on the admin database, the role applies to all admin databases in the deployment.
Roles consist of privileges that grant access to specific actions on specific resources. On most databases, a resource is
the database or a collection, but on the admin database a resource can be all databases, all collections with a given
name across databases, or all deployments.
A role can inherit privileges from other roles in its database. A role on the admin database can inherit privileges from
roles in other databases.
MongoDB roles are separate from MMS roles.
Prerequisite
MongoDB access control must be enabled to apply roles. You can create roles before enabling accessing control or
after, but they don’t go into effect until you enable access control.
Considerations
Use only the MMS interface to manage users and roles. Do not do so through direct connection to a MongoDB
instance.
Procedures
Create a Custom MongoDB Role
Step 1: Select the Deployment tab and then select Authorization & Roles.
92
Step 2: Select the ADD ROLE button.
Step 3: In the Identifier fields, enter the database on which to define the role and enter a name for the role. A
role applies to the database on which it is defined and can grant access down to the collection level. The role’s database
and name uniquely identify the role.
Step 4: Select the role’s privileges. You can add privileges in two ways:
Give a role the privileges of another role. To give a role all the privileges of one or more existing roles, select the
roles in the Inherits From field. The field provides a drop-down list that includes both MongoDB built-in roles and any
custom roles you have already created.
Add a privilege directly. To add specific privileges to the role, click ADD PRIVILEGES FOR A RESOURCE.
In the Resource field, specify the resource to which to apply the role. To specify the whole database, leave the field
blank. To specify a collection, enter the collection name. If the resource is on the admin database, you can click
ADMIN and apply the role outside the admin database.
In the Available Privileges section, select the actions to apply. For a description of each action, see Privilege Actions
in the MongoDB manual.
Step 5: Click ADD PRIVILEGES.
Step 6: Click ADD ROLE.
Step 7: Click Review & Deploy.
Step 8: Review your changes, and click Confirm & Deploy.
Edit a Custom Role You can change a custom role’s privileges. You cannot change its name or database.
Step 1: Select the Deployment tab and then select Authorization & Roles.
Step 2: Click the role’s gear icon and select Edit.
Step 3: Remove privileges. To remove an inherited role, click the x next to the role.
To remove a privilege, click the trash icon next to the privilege.
Step 4: Add privileges. You can add privileges to the role in two ways:
Give a role the privileges of another role. To give a role all the privileges of one or more existing roles, select the
roles in the Inherits From field. The field provides a drop-down list that includes both MongoDB built-in roles and any
custom roles you have already created.
93
Add a privilege directly. To add specific privileges to the role, click ADD PRIVILEGES FOR A RESOURCE.
In the Resource field, specify the resource to which to apply the role. To specify the whole database, leave the field
blank. To specify a collection, enter the collection name. If the resource is on the admin database, you can click
ADMIN and apply the role outside the admin database.
In the Available Privileges section, select the actions to apply. For a description of each action, see Privilege Actions
in the MongoDB manual.
Step 5: Click ADD PRIVILEGES.
Step 6: Click SAVE CHANGES.
Step 7: Click Review & Deploy.
Step 8: Review your changes, and click Confirm & Deploy.
View Privileges for a Role To view a role’s privileges, select the Deployment tab, then the Roles page, and then
select view privileges next to the role.
Each privilege pairs a resource with a set of Privilege Actions. All roles are assigned a database. Each built-in role is
assigned to either admin database or every database.
Remove a Custom Role
Step 1: Select the Deployment tab and then select Authorization & Roles.
Step 2: Click the role’s gear icon and select Remove.
Step 3: To confirm, click DELETE ROLE.
Step 4: Click Review & Deploy.
Step 5: Review your changes, and click Confirm & Deploy.
7 API
Public API Principles Overview of the Public API.
Public API Resources The resources exposed by the Public API.
Public API Tutorials Enable the API, and create and modify a deployment.
94
7.1 Public API Principles
Overview
The MMS Public API follows the principles of the REST architectural style to expose a number of internal resources
which enable programmatic access to MMS‘s features.
The API has the following features:
• JSON entities - All entities are expressed in JSON.
• Digest authentication - To ensure that your API key is never sent over the network, API requests are authenticated using HTTP Digest Authentication.
• Browsable interface - Using a consistent linking mechanism, you can browse the entire API by starting at the
root resource and following links to related resources.
• Security - In addition to Digest Authentication, the API is only accessible via HTTPS, and certain calls requiring
even more security are protected by a user-defined whitelist. Further, an API user’s capabilities are restricted
by their assigned role(s). For example, a user with the Read Only role within a particular group will not be
allowed to modify any resources within that group.
HTTP Methods
All resources support a subset of these common HTTP Methods:
• GET - Retrieve the JSON representation of a resource.
• POST - Create a new resource using the provided JSON representation.
• PUT - Replace a resource with the provided JSON representation.
• PATCH - Update the specified fields in a resource using the provided JSON representation.
• DELETE - Remove a resource.
JSON
All entities are represented in JSON. The following rules and conventions apply:
• When sending JSON to the server via POST or PUT, make sure to specify the correct content type request
header: Content-Type: application/json
• Invalid fields will be rejected rather than ignored. If, for example, you attempt to create a new entity and misspell
one of the fields, or if you attempt to update an existing entity and include a field that cannot be modified, the
server will respond with a 400 status code and an error message stating which field was invalid.
• All dates are returned as ISO-8601 formatted strings designated in UTC. When sending dates to the server (ie,
as query parameters or fields in POST or PATCH request entities), use ISO-8601 formatted dates. If you do
not specify a time zone, UTC is assumed. However, it is highly recommended that you include a time zone
designator to avoid any ambiguity.
• In some cases, a timestamp will be returned as a BSON timestamp, most notably in the backup resources. These
are represented in JSON documents as an object with two fields: date, an ISO-8601 formatted date string in
UTC with granularity to the second, and increment a 32-bit integer.
• Fields that contain numeric values in a particular unit will be named so as to disambiguate the unit being used.
For example, a host’s uptime is returned in millseconds, so the name of the host entity field is uptimeMsec.
95
• Fields that do not have a current value will be returned with an appropriate default value. For example, MMS
will not have any statistics for a newly discovered host, so any statistics-related fields will have a value of zero.
Fields that do not have a sensible default value will be omitted from the entity. For example, a host that is not
using authentication will omit the username field from the returned entity.
• The fields in the JSON documents returned by the server are in no particular order, and it may change. Do not
depend on the order of the fields.
Linking
Each resource includes one or more links to sub-resources and/or related resources. For example, a host has a link to
the group it belongs to, the replica set it belongs to, and so on. Links are placed in the links field of an entity, which
is an array of link relation objects. Each link relation has two fields:
• rel - Name (or type) of the relation. Many of these are considered Extension Relation Types and will be
prefixed by http://mms.mongodb.com.
• href - The target URL.
All entities include at least one link relation called self, which is simply its own URL. When an entity is part of a list
(ie, when requesting all hosts in a group), then it only includes the self link relation. Here’s an example of a portion
of a host resource with a few links:
{
"id": "xxx",
"groupId": "yyy",
"hostname": "mongodb.foo.com",
"port": 27017,
// additional host properties...
"links": [
{
"rel": "self",
"href": "https://mms.mongodb.com/api/public/v1.0/groups/xxx/hosts/yyy"
},
{
"rel": "http://mms.mongodb.com/group",
"href": "https://mms.mongodb.com/api/public/v1.0/groups/xxx"
}
]
}
For more information, refer to the Web Linking Specification. Note that although the specification describes a format
for including links in the HTTP response headers, doing so is not a requirement. To make the API easily browsable, it
includes the links in the response body rather than in the response headers.
Lists
Some resources return a list of entities. For example, you can request a list of all hosts in a group. When a list of
entities is expected in a response, the results will be returned in batches bounded by two query parameters:
• pageNum - Page number (1-based). Defaults to 1 if not specified.
• itemsPerPage - Maximum number of items to return, up to a maximum of 100. Defaults to 100 if not
specified.
The response entity contains three fields:
• totalCount - The total number of items in the entire result set. For example, if a group has a total of 57
hosts, and you make a request with pageNum=6 and itemsPerPage=10, then totalCount will be 57.
96
• results - The result set, which is an array of entity documents.
• links - Contains one to three link relations: previous for the previous page of results (omitted for the first
page); next for the next page of results (omitted for the last page); self for the current page (always present).
If you make a request for a list of entities and there are no results, then the API will respond with a 200 status code
and the results array will be empty. It does not respond with a 404 in this case, since the list of entities may not be
empty at some point in the future. However, had you requested a list of entities in a context that does not exist (ie, the
list of hosts for a non-existent group), then this will result in a 404 response status.
Here’s an example respoonse for the second page of 10 hosts in a group with a total of 57 hosts:
{
"totalCount": 57,
"results": [
{
"id": "yyy",
"groupId": "xxx",
// additional host properties...
},
// additional host documents...
],
"links": [
{
"rel": "previous",
"href": "https://www.mongodb.com/api/public/v1.0/groups/xxx/hosts?itemsPerPage=10&pageNum=1"
},
{
"rel": "next",
"href": "https://www.mongodb.com/api/public/v1.0/groups/xxx/hosts?itemsPerPage=10&pageNum=3"
}
]
}
Envelopes
Some clients may not be able to access the HTTP response headers and/or status code. In that case, you can request
that the response include an “envelope,” which is simply an extra layer of information in the JSON document that
contains any relevant details that would normally be in the response headers. By default, the API will not include the
response in an envelope. To request one, simply add the query parameter envelope=true.
For responses that contain a single entity, the envelope will contain two fields:
• status - The HTTP status code.
• content - The requested entity.
For responses that contain a list of entities, there is already an envelope that wraps the results, so specifying
envelope=true in this case will only add the status field to the existing envelope.
Pretty Printing
By default, extraneous whitespace is stripped from the JSON returned by the server. To ask for pretty-printed JSON,
simply append the pretty=true query parameter to any request. Note that all the examples in this document show
pretty-printed JavaScript for clarity, although the example URLs do not contain this additional query parameter.
97
Response Codes
Responses utilize the standard HTTP response codes, including:
Code
200
201
202
400
401
403
404
405
409
429
5xx
Meaning
OK
Created
Accepted
Bad
Request
Unauthorized
Forbidden
Not Found
Method
Not
Allowed
Conflict
Too Many
Requests
Various
server
errors
Notes
The request was successful. This is typically the response to a successful GET request.
A new resource was created. This is typically the response to a succcessful POST request.
A request for an asynchronous operation was accepted.
Something was wrong with the client request.
Authentication is required but was not present in the request. Typically this means that the
digest authentication information was omitted from the request.
Access to the specified resource is not permitted. Usually means that the user associated
with the given API Key is not allowed to access the requested resource.
The requested resource does not exist.
The HTTP method is not supported for the specified resource. Keep in mind that each
resource may only support a subset of HTTP methods. For example, you are not allowed to
DELETE the root resource.
This is typically the response to a request to create or modify a property of an entity that is
unique when an existing entity already exists with the same value for that property. For
example, attempting to create a group with the same name as an existing group is not
allowed.
You have exceeded the rate limit. See the section on Rate Limiting for more information.
Something unexpected went wrong. Try again later and consider notifying MMS Support.
Errors
When a request results in an error, the response body will contain a document with additional details about what went
wrong. The document contains three fields:
• error - The error code, which is simply the HTTP status code.
• reason - A short description of the error, which is simply the HTTP status phrase.
• detail - A more detailed description of the error.
For example, here is the response body for a request for a host that does not exist:
{
"error": 404,
"reason": "Not Found",
"detail": "No host exists with ID yyy in group xxx."
}
Authentication
As previously mentioned, the MMS API uses HTTP Digest Authentication. The details of digest authentication are
beyond the scope of this document, but it essentially requires a username and a password which are hashed using a
unique server-generated value called a nonce. The username is the username of a registered MMS account, and the
password is an API Key associated to that username.
Keep the following points in mind:
98
• The server-generated nonce is used by the client to hash the username and password before sending them back
to the server to authenticate a request. The nonce is only valid for a short amount of time as per the digest
authentication specification. This is to prevent replay attacks, so you can’t cache a nonce and use it forever.
• Using digest authentication in combination with HTTPS provides an extra layer of security by ensuring that a
password is never transmitted back to the server.
• Some resource methods require even more security and are additionally protected by a whitelist, which is a list
of client IP addresses associated to a user account that are permitted to access these protected resources.
• The MMS UI has a concept of roles, which allow more fine-grained control of the operations a user is allowed
to perform. The API resources also enforce the same authorization rules, so the resources and methods that can
be accessed by an API Key are governed by the roles granted to the associated user. For example, to DELETE a
host, the user that owns the API key used to make the request must be a Monitoring Admin or Owner in
the group that the host belongs to.
• Many resources are tied to a group,
as evidenced by URLs of the form
.../api/public/v1.0/groups/<GROUP-ID>/.... For these resources, the user tied to the
API key must be a member of the group or must be assigned to one of the GLOBAL roles. Otherwise the server
will respond with a 403 (Forbidden) status.
Automation
The API provides endpoints that let you modify a group’s deployment and retrieve deployment status. You can modify a
deployment by sending a new automation configuration to MMS. The automation configuration is where you describe
and configure the MongoDB processes to be deployed. MMS refers to this as the deployment’s “goal state.” When
you submit a new automation configuration through the API, the Automation Agents adjust the current state of the
system to match the goal state.
Important: There is no protection in the API to prevent concurrent modifications. If two administrators both start
with a configuration based on the current version, make their own modifications, and then submit their modifications,
the later modification wins.
Rate Limiting
Certain resources are subject to rate limiting. For resources that are rate limited, MMS will allow up to 100 requests
per minute per group. Keep in mind that an API key is assigned to a user, but that user may access multiple groups.
Consider two users: A and B. User A belongs to group X, and user B belongs to groups X and Y. At 1:00:00pm, User A
makes 50 requests to a rate limited resource in group X, all of which are complete by 1:00:20pm. At 1:00:30pm, User
B attempts to make 60 requests to a rate limited resource in group X. Since User A has already used up 50 requests
within the 1:00pm minute for group X, the last 10 requests User B attempts to make will be rejected. However, User
B can make requests to a rate limited resource in group Y, since each group maintains a separate request counter. At
1:01pm, requests to group X may proceed, because the request counter used for rate limiting will reset each minute.
Additional Information
See Public API Resources for a complete reference of all resources available in the MMS Public API.
7.2 Public API Resources
The MMS Public API exposes the following resources:
Root
99
Hosts
Metrics
Clusters
Groups
Users
Alerts
Alert Configurations
Backup Configurations
Snapshot Schedule
Snapshots
Restore Jobs
Whitelist
Automation Configuration
Automation Status
Root
This is the starting point (or the homepage, if you will) for the MMS API. From here, you can traverse the links to
reach all other API resources.
Sample Entity
{
"throttling": false,
"links": [ ... ]
}
Entity Fields
Name Type Description
throt- booleanTells whether or not MMS is throttling data. This can be used as a simple indicator of the current
tling
health of MMS, since throttling is generally enabled when MMS is in an unhealthy state.
Links
Relation
self
groups
user
100
Description
Me
Groups accessible to the current API user.
The current API user.
Example
Retrieve the root resource:
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0"
HTTP/1.1 200 OK
{
"throttling" : false,
"links" : [ ... ]
}
Hosts
You can typically access a host using a variety of names. DNS records and entries in the /etc/hosts file determine
what names you can use to access a given host.
When you add a host to MMS, MMS automatically discovers various valid hostname and port combinations for
each monitored mongod and mongos process. MMS then ranks the hostnames to choose a “primary” hostname.
Hostnames with the most periods are ranked highest, while the loopback address (127.0.0.1) and localhost
lowest. MMS treats the “losing” hostnames as host aliases.
When MMS processes a ping from the Monitoring agent, the algorithm for assigning a primary hostname repeats. As
a result, the primary hostname may change over time. You can also specify preferred hostnames in MMS‘s group
settings to override the hostname algorithm.
Operations
• GET /api/public/v1.0/groups/GROUP-ID/hosts - Get all hosts in a group. Use the clusterId
query parameter to only get the hosts that belong to the specified cluster. The resulting list is sorted alphabetically by hostname:port.
• GET /api/public/v1.0/groups/GROUP-ID/hosts/HOST-ID - Get a single host by ID.
• GET /api/public/v1.0/groups/GROUP-ID/hosts/byName/HOSTNAME:PORT - Get a single
host by its hostname and port combination. You can specify either the primary hostname or an alias.
• POST /api/public/v1.0/groups/GROUP-ID/hosts - Create a new host in the group. Note that
after a new host is created, MMS will not know much about it except what is provided. Thus, the document
returned in the response will be missing many values until they are discovered, which could take several minutes.
Only these fields may be specified when creating a host:
– hostname - Required.
– port - Required.
– username - Required if authMechanismName is MONGODB_CR.Otherwise it’s illegal.
– password - Required if authMechanismName is MONGODB_CR. Otherwise it’s illegal.
– sslEnabled - Default is false if omitted.
– logsEnabled - Default is false if omitted.
– alertsEnabled - Default is true if omitted.
– profilerEnabled - Default is false if omitted.
– muninPort - Default is 0 and Munin stats are not collected if omitted.
101
– authMechanismName - Default is NONE if omitted. If set to MONGODB_CR then you must provide the
username and password.
• PATCH /api/public/v1.0/groups/GROUP-ID/hosts/HOST-ID - Update an existing host using
the fields provided. Unspecified fields will preserve their current values.
– Only these fields may be specified: username password sslEnabled logsEnabled
alertsEnabled profilerEnabled muninPort authMechanismName
– If authMechanismName is NONE then any existing value for username and password will be
cleared out. For MONGODB_CR you must provide both username and password.
• DELETE /api/public/v1.0/groups/GROUP-ID/hosts/HOST-ID - Remove a host.
Sample Entity
{
"id": "680ab316473d6b28f966364b947134fc",
"groupId": "2847387cd717dabc348a",
"hostname": "localhost",
"port": 27017,
"typeName": "SHARD_SECONDARY",
"lastPing": "2014-02-15T16:03:47Z",
"ipAddress": "127.0.0.1",
"version": "2.4.3",
"deactivated": false,
"hasStartupWarnings": true,
"sslEnabled": false,
"logsEnabled": false,
"lastReactivated": "2013-12-15T09:17:23Z",
"uptimeMsec": 48918394,
"lastRestart": "2014-01-16T12:34:01Z",
"shardName": "sh1",
"replicaSetName": "rs1",
"replicaStateName": "RECOVERING",
"created": "2013-11-05T03:04:05Z",
"hostEnabled": true,
"journalingEnabled": false,
"alertsEnabled": true,
"hidden": false,
"muninEnabled": false,
"profilerEnabled": false,
"lowUlimit": false,
"muninPort": 4949,
"authMechanismName": "MONGODB_CR",
"username": "mongo",
"aliases": [ "127.0.0.1:27017" ],
"links": [ ... ]
}
Entity Fields
Name
id
groupId
102
Type
string
string
Description
Unique identifier.
ID of the group that owns this host.
Continued on next page
Name
hostname
port
typeName
lastPing
ipAddress
version
deactivated
hasStartupWarnings
sslEnabled
logsEnabled
lastReactivated
uptimeMsec
lastRestart
shardName
replicaSetName
Table 1 – continued from previous page
Type
Description
string
Primary hostname. A host typically
has several aliases, so the primary is
the best available name as decided by
MMS.
integer
Port that MongoDB process
(mongod or mongos) listens
on.
enum
Type for this host. Possible values
are:
• STANDALONE
• REPLICA_PRIMARY
• REPLICA_SECONDARY
• REPLICA_ARBITER
• RECOVERING
• MASTER
• SLAVE
• SHARD_MONGOS
• SHARD_CONFIG
• SHARD_STANDALONE
• SHARD_PRIMARY
• SHARD_SECONDARY
• NO_DATA
The host’s type for new hosts added
to MMS will be NO_DATA until the
Monitoring Agent receives its first
ping.
date
When the last ping for this host was
received.
string
IP address of this host.
string
Version of MongoDB running on this
host.
boolean
Has this host been deactivated by
MMS? A host will be marked as deactivated when MMS hasn’t received
a ping from it in several days.
boolean
Are there startup warnings for this
host?
boolean
Is SSL enabled for this host?
boolean
Is MMS collecting logs for this host?
date
The last time this has was manually
reactivated.
long
Number of milliseconds since this
host’s last restart.
date
Date this host was last restarted.
string
Name of the shard this host belongs
to. Only present if the host is part of
a sharded cluster.
string
Name of the replica set this host belongs to. Only present if this host is
part of a replica set.
Continued on next page
103
Name
replicaStateName
created
hostEnabled
journalingEnabled
alertsEnabled
muninEnabled
hidden
profilerEnabled
lowUlimit
muninPort
authMechanismName
Table 1 – continued from previous page
Type
Description
enum
Current state of this host within a
replica set. Only present if this host is
part of a replica set. See Replica Set
Member States for possible values.
date
Date this host was created or first discovered by MMS.
boolean
Is this host currently enabled? Hosts
can be manually disabled in the MMS
UI.
boolean
Is journaling enabled for this host?
boolean
Are alerts enabled for this host?
boolean
Are Munin stats being collected for
this host?
boolean
Is this host currently hidden? When
MMS deactivates a host, it will also
mark it as hidden.
boolean
Is MMS collecting profile information from this host?
boolean
Does this host have a low ulimit
setting?
integer
What port should be used to collect
Munin stats from this host?
enum
The authentication mechanism used
to connect to this host. Possible values are:
• MONGODB_CR
• GSSAPI
• NONE
username
string
password
string
aliases
array of strings
Username
for
connecting
to
this host.
Only present when
the authMechanismName is
MONGODB_CR.
Password for connecting to this host.
If a host’s authMechanismName
is MONGODB_CR, then you must include this field when creating the host
or updating its credentials. However,
it will never be exposed when a host
entity is returned.
A list of alternate hostname:port
combinations that MMS has discovered for the host.
Links
Relation
self
cluster
parentCluster
group
104
Description
Me
The cluster this host belongs to. Only present if the host is part of a replica set or master/slave.
The parent cluster. Only present if the host is part of a sharded cluster.
The group that this host belongs to.
Examples
Create a New Host
curl -u "username:apiKey" -H "Content-Type: application/json" --digest -X POST "https://mms.mongodb.c
{
"hostname": "localhost",
"port": 27017
}'
HTTP/1.1 201 Created
Location: https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db4cbc26d9e/hosts/680ab316473d6
{
"id" : "4059580c20c4581872ef24d0b8f5dca0",
"groupId" : "5196d3628d022db4cbc26d9e",
"hostname" : "localhost",
"port" : 27017,
"deactivated" : false,
"hasStartupWarnings" : false,
"sslEnabled" : false,
"logsEnabled" : false,
"created" : "2014-04-22T19:56:50Z",
"hostEnabled" : true,
"journalingEnabled" : false,
"alertsEnabled" : true,
"hidden" : false,
"muninEnabled" : false,
"profilerEnabled" : false,
"lowUlimit" : false,
"authMechanismName" : "NONE",
"links" : [ ... ]
}
Update a Host
curl -u "username:apiKey" -H "Content-Type: application/json" --digest -i -X PATCH "https://mms.mongo
{
"sslEnabled": true,
"username": "mongo",
"password": "M0ng0DB!:)"
}'
HTTP/1.1 200 OK
{
"id" : "680ab316473d6b28f966364b947134fc",
"groupId" : "533c5895b91030606f21033a",
"hostname" : "localhost",
"port" : 26000,
"deactivated" : false,
"hasStartupWarnings" : false,
"sslEnabled" : true,
"logsEnabled" : false,
"created" : "2014-04-22T19:56:50Z",
"hostEnabled" : true,
"journalingEnabled" : false,
"alertsEnabled" : true,
"hidden" : false,
105
"muninEnabled" : false,
"profilerEnabled" : false,
"lowUlimit" : false,
"authMechanismName" : "MONGODB_CR",
"username" : "mongo",
"links" : [ ... ]
}
Get One Host
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/533c5895b910306
HTTP/1.1 200 OK
{
"id" : "56e9378f601dc49360a40949c8a6df6c",
"groupId" : "533c5895b91030606f21033a",
"hostname" : "mymongo.test.com",
"port" : 26000,
"deactivated" : false,
"hasStartupWarnings" : false,
"sslEnabled" : true,
"logsEnabled" : false,
"created" : "2014-04-22T19:56:50Z",
"hostEnabled" : true,
"journalingEnabled" : false,
"alertsEnabled" : true,
"hidden" : false,
"muninEnabled" : false,
"profilerEnabled" : false,
"lowUlimit" : false,
"authMechanismName" : "MONGODB_CR",
"username" : "mongo",
"aliases": [ "mymongo:26000", "12.34.56.78:26000" ]
"links" : [ ... ]
}
Get All Hosts
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/533c5895b910306
HTTP/1.1 200 OK
{
"totalCount" : 2,
"results" : [
{
"id" : "56e9378f601dc49360a40949c8a6df6c",
"groupId" : "533c5895b91030606f21033a",
"hostname" : "mymongo.test.com",
"port" : 26000,
"deactivated" : false,
"hasStartupWarnings" : false,
"sslEnabled" : true,
"logsEnabled" : false,
"created" : "2014-04-22T19:56:50Z",
"hostEnabled" : true,
"journalingEnabled" : false,
106
"alertsEnabled" : true,
"hidden" : false,
"muninEnabled" : false,
"profilerEnabled" : false,
"lowUlimit" : false,
"authMechanismName" : "MONGODB_CR",
"username" : "mongo",
"aliases": [ "mymongo:26000", "12.34.56.78:26000" ]
"links" : [ ... ]
},
{
...
}
]
}
Delete a Host
curl -u "username:apiKey" --digest -i -X DELETE "https://mms.mongodb.com/api/public/v1.0/groups/533c5
HTTP/1.1 200 OK
Metrics
Requests to this resource are subject to rate limiting.
Operations
• GET /api/public/v1.0/groups/GROUP-ID/hosts/HOST-ID/metrics - Get a list of all available metrics for the host. Each entity in the list will be a partial metric entity. No actual data points are returned,
but each entity contains a self link which you may follow to retrieve the full metric entity.
• GET /api/public/v1.0/groups/GROUP-ID/hosts/HOST-ID/metrics/METRIC-NAME - Get
the data points for the specified host and metric. If no additional query parameters are given, then the minutelevel data for the past hour is returned. The METRIC-NAME may be any of the supported values listed for
the metricName field, above. Note that if the provided metric is either a database-level metric (ie, its name
begins with DB_) or a hardware metric for a specific device (ie, its name begins with MUNIN_IOSTAT), then
the response entity will contain a list of links to all available database (or hardware device) metrics. You may
also provide additional query parameters:
– granularity - The size of the epoch. Acceptable values are: MINUTE HOUR DAY.
– period - The ISO-8601 formatted time period that specifies how far back in the past to
query.
For example, to request the last 36 hours of hour-level data, you must specify:
granularity=HOUR&period=P1DT12H.
• GET /api/public/v1.0/groups/GROUP-ID/hosts/HOST-ID/metrics/DB-METRIC-NAME/DB-NAME
- Get the data points for the specified host, database metric, and database name. The database metrics include
the supported values for the metricName field that begin with DB_. The same query parameters described
above are also supported.
• GET /api/public/v1.0/groups/GROUP-ID/hosts/HOST-ID/metrics/HW-METRIC-NAME/DEVICE-NAME
- Get the data points for the specified host, hardware metric, and device name. The device-specific hardware
metrics include the supported values for the metricName field that begin with MUNIN_IOSTAT_. The same
query parameters described above are also supported.
107
Sample Entity
{
"hostId": "680ab316473d6b28f966364b947134fc",
"groupId": "2847387cd717dabc348a",
"metricName" : "OPCOUNTERS_UPDATE",
"units" : "RAW",
"granularity" : "MINUTE",
"dataPoints" : [ {
"timestamp" : "2014-08-26T16:42:00Z",
"value" : 10.3911
}, {
"timestamp" : "2014-08-26T16:43:00Z",
"value" : 14.938
}, {
"timestamp" : "2014-08-26T16:44:00Z",
"value" : 12.8882
},
...
],
"links" : [ ... ]
}
108
109
Entity Fields
Name
hostId
Type
string
groupId
metricName
string
enum
110
Description
ID of the host to which this metric
pertains.
ID of the group that owns this host.
The name of the metric. Possible values are:
• ASSERT_MSG
• ASSERT_REGULAR
• ASSERT_USER
• ASSERT_WARNING
• BACKGROUND_FLUSH_AVG
• COMPUTED_MEMORY
• CONNECTIONS
•
CURSORS_TOTAL_CLIENT_CURSORS_SIZ
• CURSORS_TOTAL_OPEN
•
CURSORS_TOTAL_TIMED_OUT
•
DB_ACCESSES_NOT_IN_MEMORY
• DB_DATA_SIZE_TOTAL
• DB_LOCK_PERCENTAGE
•
DB_PAGE_FAULT_EXCEPTIONS_THROWN
• DB_STORAGE_TOTAL
•
EFFECTIVE_LOCK_PERCENTAGE
•
EXTRA_INFO_PAGE_FAULTS
•
GLOBAL_ACCESSES_NOT_IN_MEMORY
•
GLOBAL_LOCK_CURRENT_QUEUE_READER
•
GLOBAL_LOCK_CURRENT_QUEUE_TOTAL
•
GLOBAL_LOCK_CURRENT_QUEUE_WRITER
•
GLOBAL_PAGE_FAULT_EXCEPTIONS_THR
•
INDEX_COUNTERS_BTREE_ACCESSES
•
INDEX_COUNTERS_BTREE_HITS
•
INDEX_COUNTERS_BTREE_MISSES
•
INDEX_COUNTERS_BTREE_MISS_RATIO
•
JOURNALING_COMMITS_IN_WRITE_LOCK
• JOURNALING_MB
• MEMORY_MAPPED
• MEMORY_RESIDENT
• MEMORY_VIRTUAL
• MUNIN_CPU_IOWAIT
• MUNIN_CPU_IRQ
• MUNIN_CPU_NICE
• MUNIN_CPU_SOFTIRQ
Links
Relation
self
group
host
Description
Me
The group that the host belongs to.
The host to which the metric pertains.
Examples
Get All Available Metrics
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/51b9361d5ae9048
HTTP/1.1 200 OK
{
"totalCount" : 53,
"results" : [ {
"hostId" : "04cf770dc43c9ff21747ecf71ff9ee78",
"groupId" : "51b9361d5ae9048f0aab01f4",
"metricName" : "ASSERT_REGULAR",
"units" : "RAW",
"links" : [ {
"rel" : "self",
"href" : "https://mms.mongodb.com/api/public/v1.0/groups/51b9361d5ae9048f0aab01f4/hosts/04cf770
} ]
}, {
"hostId" : "04cf770dc43c9ff21747ecf71ff9ee78",
"groupId" : "51b9361d5ae9048f0aab01f4",
"metricName" : "ASSERT_WARNING",
"units" : "RAW"
"links" : [ {
"rel" : "self",
"href" : "https://mms.mongodb.com/api/public/v1.0/groups/51b9361d5ae9048f0aab01f4/hosts/04cf770
} ]
}, ... ],
"links" : [ ... ]
}
Get a Single Metric The following example gets hour-level data for the past 12 hours.
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/51b9361d5ae9048
HTTP/1.1 200 OK
{
"groupId" : "51b9361d5ae9048f0aab01f4",
"hostId" : "04cf770dc43c9ff21747ecf71ff9ee78",
"metricName" : "OPCOUNTERS_QUERY",
"units" : "RAW",
"granularity" : "MINUTE",
"dataPoints" : [ {
"timestamp" : "2014-08-29T14:00:00Z",
"value" : 381.2
}, {
"timestamp" : "2014-08-29T15:00:00Z",
111
"value" : 407.23
}, {
"timestamp" : "2014-08-29T16:00:00Z",
"value" : 365.3124
}, ... ],
"links" : [ ... ]
}
Clusters
MongoDB supports two different kinds of clusters: replica sets and sharded clusters. Since a shard within a sharded
cluster is typically a replica set, a sharded cluster is a cluster of clusters. This relationship is reflected in the way
MMS models clusters, and it might lead to unexpected results from the Clusters resource. As an example, consider a
deployment with one sharded cluster containing four shards, and each shard is a three-node replica set. In this scenario,
the Clusters resource will return five entities: one that represents the sharded cluster, and four to represent the replica
sets (shards). However, if each shard in this fictitious deployment was a standalone mongod instead of a replica set,
then the Clusters resource would only return one entity representing the sharded cluster.
Operations
• GET /api/public/v1.0/groups/GROUP-ID/clusters/CLUSTER-ID - Get a single cluster by
ID.
• GET /api/public/v1.0/groups/GROUP-ID/clusters - Get all clusters in a group. Note that if
MMS hasn’t received a ping from a cluster in several days, it will be considered inactive and will be filtered
from this list. Use the parentClusterId query parameter to get all clusters with the specified parent cluster
ID. The list of entities is sorted in ascending order by the date that MMS discovered the cluster.
• PATCH /api/public/v1.0/groups/GROUP-ID/clusters/CLUSTER-ID - Update a cluster by
ID. The only property that you may modify is the clusterName, since all other properties of a cluster
are discovered by MMS. Additionally, this operation is only permitted on clusters of type SHARDED and
SHARDED_REPLICA_SET.
Sample Entity
{
"id": "yyy",
"groupId": "xxx",
"typeName": "REPLICA_SET",
"clusterName": "Cluster 0",
"shardName": "shard001",
"replicaSetName": "rs1",
"lastHeartbeat": "2014-02-26T17:32:45Z",
"links": [ ... ]
}
112
Entity Fields
Name
id
groupId
typeName
Type
string
string
enum
Description
Unique identifier.
ID of the group that owns this cluster.
Specifies what kind of cluster this is.
Possible values are:
• MASTER_SLAVE
• REPLICA_SET
• SHARDED
• SHARDED_REPLICA_SET
clusterName
string
shardName
string
replicaSetName
string
lastHeartbeat
date
Display name of the cluster. Only applies to sharded clusters. Note that
mongod itself doesn’t allow you to
name a cluster; this name is supplied
by (and editable within) MMS. For a
replica set within a sharded cluster,
the cluster name is the name of its
parent cluster.
Name of the shard. Only present
for a cluster of type SHARDED or
REPLICA_SET that is part of a
sharded cluster.
Name of the replica set. Only present
for a cluster of type REPLICA_SET.
The approximate last time MMS processed a ping from this cluster.
Links
Relation
self
parentCluster
group
clusters
hosts
Description
Me
The parent cluster. Only present if the type is SHARDED or REPLICA_SET within a sharded cluster.
The group that this cluster belongs to.
The member shards that belong to this cluster. Only present if the type is SHARDED_REPLICA_SET.
The member hosts that belong to this cluster. Present for all types except SHARDED_REPLICA_SET.
Note: to get the hosts of a sharded cluster, follow the clusters link and get the hosts for each
shard.
Examples
Get a Cluster
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/533c5895b910306
HTTP/1.1 200 OK
{
"id" : "533d7d4730040be257defe88",
113
"typeName" : "SHARDED_REPLICA_SET",
"clusterName" : "Animals",
"lastHeartbeat" : "2014-04-03T15:26:58Z",
"links" : [ ... ]
}
Get all Clusters
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/533c5895b910306
HTTP/1.1 200 OK
{
"totalCount" : 3,
"results" : [ {
"id" : "533d7d4730040be257defe88",
"typeName" : "SHARDED_REPLICA_SET",
"clusterName" : "Animals",
"lastHeartbeat" : "2014-04-03T15:26:58Z",
"links" : [ ... ]
}, {
"id" : "533d7d4630040be257defe85",
"typeName" : "REPLICA_SET",
"clusterName" : "Animals",
"shardName" : "cats",
"replicaSetName" : "cats",
"lastHeartbeat" : "2014-04-03T15:24:54Z",
"links" : [ ... ]
}, {
"id" : "533d7d4630040be257defe83",
"typeName" : "REPLICA_SET",
"clusterName" : "Animals",
"shardName" : "dogs",
"replicaSetName" : "dogs",
"lastHeartbeat" : "2014-04-03T15:26:30Z",
"links" : [ ... ]
} ],
"links" : [ ... ]
}
Update a Cluster
curl -u "username:apiKey" -H "Content-Type: application/json" --digest -i -X PATCH "https://mms.mongo
{
"clusterName": "Zoo"
}'
HTTP/1.1 200 OK
{
"id" : "533d7d4730040be257defe88",
"typeName" : "SHARDED_REPLICA_SET",
"clusterName" : "Zoo",
"lastHeartbeat" : "2014-04-03T15:26:58Z",
"links" : [ ... ]
}
114
Groups
Operations
• GET /api/public/v1.0/groups/GROUP-ID - Get a single group by ID.
• GET /api/public/v1.0/groups - Get all groups for the current user.
• POST /api/public/v1.0/groups - Create a new group. Only the name field may be specified. The
publicApiEnabled field will be set to true for groups created with the API. The response entity will
include the agentApiKey for the group.
• GET /api/public/v1.0/groups/GROUP-ID/users - Get all users in a group.
• DELETE /api/public/v1.0/groups/GROUP-ID/users/USER-ID - Remove a user from a group.
• POST /api/public/v1.0/groups/GROUP-ID/users - Add existing user(s) to a group.
– You must send an array of entities, even if you’re only adding a single user.
– For each user being added, specify the user ID and role(s) to be assigned.
– If a user is specified that is already part of the group, then their existing role(s) will be overwritten.
• DELETE /api/public/v1.0/groups/GROUP-ID - Delete a group. Once a group is deleted, its name
cannot be reclaimed. Thus, if you create a group named My Group and then delete it, you will not be able to
create another group named My Group.
Sample Entity
{
"id": "xxx",
"name": "My Group",
"hostCounts": {
"arbiter": 2,
"config": 1,
"primary": 4,
"secondary": 8,
"mongos": 2.
"master": 0,
"slave": 0
},
"lastActiveAgent": ISODate("2014-02-05T07:23:34Z"),
"activeAgentCount": 1,
"replicaSetCount": 3,
"shardCount": 2,
"publicApiEnabled": true,
"agentApiKey": "cbd728abd6a6d6c6b6d7826345dbcff0e",
"links": [ ... ]
}
115
Entity Fields
Name
id
name
hostCounts
lastActiveAgent
activeAgentCount
replicaSetCount
shardCount
publicApiEnabled
agentApiKey
Type
string
string
object
date
Description
Unique identifier.
Display name for the group.
The total number of hosts by type. The embedded fields should be self-explanatory.
Date that a ping was last received from one of the group’s Monitoring Agents.
inNumber of Monitoring Agents sending regular pings to MMS.
teger
inTotal number of replica sets for this group.
teger
inTotal number of shards for this group.
teger
booleanIs the Public API enabled for this group? This is a read-only field that will always be true for
groups created with the API. Note that for groups created in the MMS UI, the only way to set
this flag to true is by enabling the Public API for the group in the Settings tab.
string The API key for your agent. This field is only present in the response entity to a POST
request. Thus, the API key will only be exposed at group creation time.
Links
Relation
self
hosts
users
clusters
alerts
alertConfigs
backupConfigs
Description
Me
All hosts in the group.
All users in the group.
All clusters in the group.
All open alerts for the group.
All alert configurations for the group.
All backup configurations for the group.
Examples
Get a Group
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db
HTTP/1.1 200 OK
{
"id" : "5196d3628d022db4cbc26d9e",
"name" : "API Example",
"hostCounts" : {
"arbiter" : 0,
"config" : 1,
"primary" : 3,
"secondary" : 4,
"mongos" : 2,
"master" : 0,
116
"slave" : 0
},
"lastActiveAgent" : "2014-04-03T18:18:12Z",
"activeAgentCount" : 1,
"replicaSetCount" : 3,
"shardCount" : 2,
"links" : [ ... ]
}
Get All Groups for Current User
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups"
HTTP/1.1 200 OK
{
"totalCount" : 6,
"results" : [ {
"id" : "5196d3628d022db4cbc26d9e",
"name" : "API Example",
"hostCounts" : {
"arbiter" : 0,
"config" : 1,
"primary" : 3,
"secondary" : 4,
"mongos" : 2,
"master" : 0,
"slave" : 0
},
"lastActiveAgent" : "2014-04-03T18:18:12Z",
"activeAgentCount" : 1,
"replicaSetCount" : 3,
"shardCount" : 2,
"links" : [ ... ]
}, {
// etc.
} ],
"links" : [ ... ]
}
Create a Group
curl -u "username:apiKey" -H "Content-Type: application/json" --digest -i -X POST "https://mms.mongod
{
"name": "API Example 2"
}'
HTTP/1.1 201 Created
Location: https://mms.mongodb.com/api/public/v1.0/groups/533daa30879bb2da07807696
{
"id" : "533daa30879bb2da07807696",
"name" : "API Example 2",
"activeAgentCount" : 0,
"replicaSetCount" : 0,
"shardCount" : 0,
"publicApiEnabled": true,
"agentApiKey": "cbd747d7b7b711de45aa3ff0e",
117
"hostCounts" : {
"arbiter" : 0,
"config" : 0,
"primary" : 0,
"secondary" : 0,
"mongos" : 0,
"master" : 0,
"slave" : 0
},
"links" : [ ... ]
}
Add Users to a Group
curl -u "username:apiKey" -H "Content-Type: application/json" --digest -i -X POST "https://mms.mongod
[
{
"id": "5329c8dfe4b0b07a83d67e7d",
"roles": [{
"roleName": "GROUP_READ_ONLY"
}]
},
{
"id": "5329c906e4b0b07a83d691ba",
"roles": [{
"roleName": "GROUP_MONITORING_ADMIN"
}, {
"roleName": "GROUP_BACKUP_ADMIN"
}]
}
]'
HTTP/1.1 200 OK
Delete a Group
curl -u "username:apiKey" --digest -i -X DELETE "https://mms.mongodb.com/api/public/v1.0/groups/533da
HTTP/1.1 200 OK
Get Users in a Group
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/5356823bc0edc27
HTTP/1.1 200 OK
{
"totalCount" : 2,
"results" : [ {
"id" : "5357e25a300490374243f425",
"username" : "[email protected]",
"emailAddress" : "[email protected]",
"firstName" : "User",
"lastName" : "One",
"roles" : [ {
"groupId" : "5356823bc0edc2788a835ed0",
"roleName" : "GROUP_USER_ADMIN"
118
} ],
"links" : [ ... ]
}, {
"id" : "5356823b3004dee37132bb7b",
"username" : "[email protected]",
"emailAddress" : "[email protected]",
"firstName" : "User",
"lastName" : "Deux",
"roles" : [ {
"groupId" : "5356823bc0edc2788a835ed0",
"roleName" : "GROUP_OWNER"
}, {
"groupId" : "5356823bc0edc2788a835ecd",
"roleName" : "GROUP_OWNER"
} ],
"links" : [ ... ]
} ],
"links" : [ ... ]
}
Delete a User from a Group
curl -u "username:apiKey" --digest -i -X DELETE "https://mms.mongodb.com/api/public/v1.0/groups/53568
HTTP/1.1 200 OK
Users
Operations
• GET /api/public/v1.0/users/USER-ID/xxx - Get a single user by ID. You can only retrieve a user
if you have at least one group in common.
• GET /api/public/v1.0/groups/GROUP-ID/users - Get all users in a group.
• POST /api/public/v1.0/users - Create a new user. All fields are required.
• PATCH /api/public/v1.0/users/USER-ID - Update an existing user using the fields provided. Unspecified fields will preserve their current values. You cannot specify the password for security reasons.
Sample Entity
{
"id": "xxx",
"username": "[email protected]",
"password": "abc123",
"emailAddress": "[email protected]",
"mobileNumber": "2125551234",
"firstName": "John",
"lastName": "Doe",
"roles": [
{
"groupId": "8491812938cbda83918c",
"roleName": "GROUP_OWNER"
},
119
{
"groupId": "4829cbda839cbdac3819",
"roleName": "GROUP_READ_ONLY"
}
],
"links": [ ... ]
}
Entity Fields
Name
id
username
password
Type
string
string
string
emailAddress
mobileNumber
string
string
firstName
lastName
roles
roles.groupId
string
string
object array
string
roles.roleName
enum
120
Description
Unique identifier.
MMS username.
Password. This field is NOT included
in the entity returned from the server.
It can only be sent in the entity body
when creating a new user.
Email address.
Mobile number. This field can only
be set or edited using the MMS UI
because it is tied to two factor authentication.
First name.
Last name.
Role assignments.
The groupId in which the user has
the specified role. Note that for
the “global” roles (those whose name
starts with GLOBAL_) there is no
groupId since these roles are not
tied to a group.
The name of the role. Possible values
are:
•
GLOBAL_AUTOMATION_ADMIN
• GLOBAL_BACKUP_ADMIN
•
GLOBAL_MONITORING_ADMIN
• GLOBAL_OWNER
• GLOBAL_READ_ONLY
• GLOBAL_USER_ADMIN
•
GROUP_AUTOMATION_ADMIN
• GROUP_BACKUP_ADMIN
•
GROUP_MONITORING_ADMIN
• GROUP_OWNER
• GROUP_READ_ONLY
• GROUP_USER_ADMIN
Links
Relation
self
whitelist
Description
Me
The user’s whitelist.
Examples
Get a User
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/users/533dc19ce4b00835
HTTP/1.1 200 OK
{
"id" : "533dc19ce4b00835ff81e2eb",
"username" : "[email protected]",
"emailAddress" : "[email protected]",
"firstName" : "Jane",
"lastName" : "D'oh",
"roles" : [ {
"groupId" : "533daa30879bb2da07807696",
"roleName" : "GROUP_USER_ADMIN"
} ],
"links": [ ... ]
}
Get All Users in a Group
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/533daa30879bb2d
HTTP/1.1 200 OK
{
"totalCount": 3,
"results": [ {
"id" : "5329c8dfe4b0b07a83d67e7d",
"username" : "[email protected]",
"emailAddress" : "[email protected]",
"firstName" : "John",
"lastName" : "Doe",
"roles" : [ {
"groupId" : "5329cb6e879bb2da07806511",
"roleName" : "GROUP_OWNER"
}, {
"groupId" : "5196d3628d022db4cbc26d9e",
"roleName" : "GROUP_READ_ONLY"
}, {
"groupId" : "533daa30879bb2da07807696",
"roleName" : "GROUP_READ_ONLY"
} ],
"links": [ ... ]
}, {
// etc.
} ],
"links": [ ... ]
}
121
Create a User
curl -u "username:apiKey" -H "Content-Type: application/json" --digest -i -X POST "https://mms.mongod
{
"username": "[email protected]",
"emailAddress": "[email protected]",
"firstName": "Jane",
"lastName": "Doe",
"password": "M0ng0D8!:)",
"roles": [{
"groupId": "533daa30879bb2da07807696",
"roleName": "GROUP_USER_ADMIN"
}]
}'
HTTP/1.1 201 Created
Location: https://mms.mongodb.com/api/public/v1.0/users/533dc19ce4b00835ff81e2eb
{
"id" : "533dc19ce4b00835ff81e2eb",
"username" : "[email protected]",
"emailAddress" : "[email protected]",
"firstName" : "Jane",
"lastName" : "Doe",
"roles" : [ {
"groupId" : "533daa30879bb2da07807696",
"roleName" : "GROUP_USER_ADMIN"
} ],
"links" : [ ... ]
}
Update a User
curl -u "username:apiKey" -H "Content-Type: application/json" --digest -i -X PATCH "https://mms.mongo
{
"emailAddress": "[email protected]",
"lastName": "D'oh"
}'
HTTP/1.1 200 OK
{
"id" : "533dc19ce4b00835ff81e2eb",
"username" : "[email protected]",
"emailAddress" : "[email protected]",
"firstName" : "Jane",
"lastName" : "D'oh",
"roles" : [ {
"groupId" : "533daa30879bb2da07807696",
"roleName" : "GROUP_USER_ADMIN"
} ],
"links" : [ ... ]
}
122
Alerts
Operations
• GET /api/public/v1.0/groups/GROUP-ID/alerts - Gets all alerts with the specified status. Use
the status query parameter with one of these possible values: OPEN CLOSED
• GET /api/public/v1.0/groups/GROUP-ID/alerts/ALERT-ID - Get a single alert by ID.
• GET /api/public/v1.0/groups/GROUP-ID/alerts/ALERT-ID/alertConfigs - Get the
alert configuration(s) that triggered this alert.
• PATCH /api/public/v1.0/groups/GROUP-ID/alerts/ALERT-ID - Update an existing alert.
The only field you may modify is the acknowledgedUntil field.
– To acknowledge an alert “forever” set the date to 100 years in the future.
– To unacknowledge a previously acknowledged alert, set the date in the past.
Sample Entity
{
"id": "yyy",
"groupId": "xxx",
"alertConfigId": "xxx",
"typeName": "HOST_METRIC",
"eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
"status": "OPEN",
"acknowledgedUntil": "2014-03-01T12:00:00Z",
"created": "2014-02-01T12:34:12Z",
"updated": "2014-02-02T01:23:45Z",
"resolved": null,
"lastNotified": "2014-02-04T02:43:13Z",
"currentValue": {
"number": 123.45,
"units": "MEGABYTES"
},
"links": [ ... ]
}
123
124
Entity Fields
Name
id
groupId
Type
string
string
Description
Unique identifier.
ID of the group that this alert was
opened for.
ID of the alert configuration that triggered this alert.
The type of alert. Possible values are:
• AGENT
• BACKUP
• HOST
• HOST_METRIC
• REPLICA_SET
alertConfigId
string
typeName
enum
eventTypeName
enum
The name of the event that triggered
the alert. The possible values here depend on the typeName:
• AGENT - Possible values:
–
MONITORING_AGENT_DOWN
–
BACKUP_AGENT_DOWN
• HOST - Possible values:
– HOST_DOWN
– HOST_RECOVERING
– VERSION_BEHIND
– HOST_EXPOSED
• HOST_METRIC - Possible
values:
–
OUTSIDE_METRIC_THRESHOLD
• BACKUP - Possible values:
– OPLOG_BEHIND
– RESYNC_REQUIRED
status
enum
The current state of the alert. Possible
values are:
• OPEN
• CLOSED
acknowledgedUntil
date
acknowledgementComment
string
acknowledgingUsername
string
created
updated
resolved
date
date
date
lastNotified
date
The date through which the alert has
been acknowledged. Will not be
present if the alert has never been acknowledged.
The comment left by the user who
acknowledged the alert. Will not be
present if the alert has never been acknowledged.
The username of the user who acknowledged the alert. Will not be
present if the alert has never been acknowledged.
When the alert was opened.
When the alert was last updated.
When the alert was closed. 125
Only
present if the status is CLOSED.
When the last notification was sent
for this alert. Only present if notifi-
Links
Relation
self
group
alertConfig
alertConfigs
host
Description
Me
The group that this alert was triggered for.
The alert configuration that triggered this alert.
A list of alert configurations that triggered this alert. This list will only contain a single element and is
present for backward compatibility. New code should use the alertConfig link instead.
The host that triggered this alert. Only present for alerts of type HOST.
Examples
Get an Alert
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db
HTTP/1.1 200 OK
{
"id" : "533cb4b8e4b0f1820cdabc7f",
"groupId" : "5196d3628d022db4cbc26d9e",
"typeName" : "BACKUP",
"eventTypeName" : "OPLOG_BEHIND",
"status" : "CLOSED",
"created" : "2014-04-03T01:09:12Z",
"updated" : "2014-04-03T01:14:12Z",
"resolved" : "2014-04-03T01:14:12Z",
"links" : [ ... ]
}
Get Open Alerts
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db
HTTP/1.1 200 OK
{
"totalCount": 1,
"results": [ {
"id" : "533dc45ee4b00835ff81ec2a",
"groupId" : "5196d3628d022db4cbc26d9e",
"typeName" : "HOST_METRIC",
"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
"status" : "OPEN",
"created" : "2014-04-03T20:28:14Z",
"updated" : "2014-04-03T20:28:14Z",
"lastNotified" : "2014-04-03T20:28:23Z",
"metricName": "ASSERTS_REGULAR",
"currentValue" : {
"number" : 0.0,
"units" : "RAW"
},
"links" : [ ... ]
126
} ],
"links" : [ ... ]
}
Get Alert Configurations that Triggered an Alert
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db
HTTP/1.1 200 OK
{
"totalCount": 3,
"results": [ {
"id" : "5271259ee4b00ece6b4754ef",
"groupId" : "5196d3628d022db4cbc26d9e",
"typeName" : "BACKUP",
"eventTypeName" : "RESYNC_REQUIRED",
"created" : "2013-10-30T15:28:30Z",
"updated" : "2014-02-12T16:11:05Z",
"enabled" : true,
"matchers" : [ ],
"notifications" : [ {
"typeName" : "EMAIL",
"intervalMin" : 60,
"delayMin" : 0,
"emailAddress" : "[email protected]"
} ],
"links" : [ ... ]
} ],
"links" : [ ... ]
}
Acknowledge an Alert
curl -u "username:apiKey" -H "Content-Type: application/json" --digest -i -X PATCH "https://mms.mongo
{
"acknowledgedUntil": "2014-04-15T00:00:00-0400",
"acknowledgementComment": "This is normal. Please ignore."
}'
HTTP/1.1 200 OK
{
"id" : "533dc45ee4b00835ff81ec2a",
"groupId" : "5196d3628d022db4cbc26d9e",
"typeName" : "HOST_METRIC",
"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
"status" : "OPEN",
"acknowledgedUntil" : "2014-04-15T04:00:00Z",
"acknowledgementComment" : "This is normal. Please ignore.",
"acknowledgingUsername" : "[email protected]",
"created" : "2014-04-03T20:28:14Z",
"updated" : "2014-04-03T20:33:14Z",
"lastNotified" : "2014-04-03T20:33:23Z",
"metricName": "ASSERTS_REGULAR",
"currentValue" : {
"number" : 0.0,
"units" : "RAW"
127
},
"links" : [ ... ]
}
Alert Configurations
Operations
• GET /api/public/v1.0/groups/GROUP-ID/xxx/alertConfigs/ALERT-CONFIG-ID - Get a
single alert configuration by ID.
• GET /api/public/v1.0/groups/GROUP-ID/xxx/alertConfigs - Get all alert configurations for
a group.
• GET /api/public/v1.0/groups/GROUP-ID/xxx/alertConfigs/ALERT-CONFIG-ID/alerts
- Get all open alerts that were triggered by an alert configuration.
• POST /api/public/v1.0/groups/GROUP-ID/xxx/alertConfigs - Create a new alert configuration. All fields are required except created and updated.
• PUT /api/public/v1.0/groups/GROUP-ID/xxx/alertConfigs - Update an existing alert configuration. Partial updates are not supported except for one field (see PATCH below), so you must send the entire
entity.
• PATCH /api/public/v1.0/groups/GROUP-ID/xxx/alertConfigs/ALERT-CONFIG-ID
Use to enable/disable an alert configuration by setting the enabled field.
-
• DELETE /api/public/v1.0/groups/GROUP-ID/xxx/alertConfigs/ALERT-CONFIG-ID Remove an alert configuration.
Sample Entity
{
"id": "yyy",
"groupId": "xxx",
"typeName": "HOST_METRIC",
"eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
"created": "2014-02-01T12:34:12Z",
"updated": "2014-02-02T01:23:45Z",
"enabled": true,
"matchers": [{
"fieldName": "HOSTNAME",
"operator": "STARTS_WITH",
"value": "my-host-prefix"
}, {
"fieldName": "PORT",
"operator": "EQUALS",
"value": "27017"
}],
"notifications": [{
"typeName": "EMAIL",
"intervalMin": 5,
"delayMin": 0,
"emailAddress": "[email protected]"
}, {
"typeName": "HIP_CHAT",
128
"intervalMin": 5,
"delayMin": 0,
"notificationToken": "123456abcdef",
"roomName": "|mms| Test Chat Room"
}, {
"typeName": "GROUP",
"intervalMin": 5,
"delayMin": 0,
"groupId": "2847387cd717dabc348a",
"groupName": "test1",
"emailEnabled": true,
"smsEnabled": true
}, {
"typeName": "USER",
"intervalMin": 5,
"delayMin": 0,
"username": "john.doe",
"emailEnabled": true,
"smsEnabled": true
}, {
"typeName": "SMS",
"intervalMin": 5,
"delayMin": 0,
"mobileNumber": "(212) 212-1212"
}, {
"typeName": "SNMP",
"intervalMin": 5,
"delayMin": 0,
"snmpAddress": "somedomain.com:161"
}, {
"typeName": "PAGER_DUTY",
"intervalMin": 5,
"delayMin": 0,
"serviceKey": "123456abcdef"
}],
"metricThreshold": {
"metricName": "MEMORY_RESIDENT",
"operator": "GREATER_THAN",
"threshold": 7,
"units": "GIGABYTES",
"mode": "TOTAL"
},
"links": [ ... ]
}
Entity Fields
Name
id
groupId
Type
string
string
typeName
enum
Description
Unique identifier.
ID of the group that owns this alert
configuration.
The type of this alert configuration. Supports the same values as
the typeName field of the alerts resource.
Continued on next page
129
Name
eventTypeName
created
updated
enabled
matchers
matchers.fieldName
matchers.operator
Table 2 – continued from previous page
Type
Description
enum
The type of event that will trigger an
alert. Supports the same values as the
eventTypeName field of the alerts
resource.
date
When this alert configuration was
created.
date
When this alert configuration was last
updated.
boolean
Is this alert configuration enabled?
object array
Rules to apply when matching an object against this alert configuration.
Only entities that match all these
rules will be checked for an alert condition.
string
The name of the field in the target object to match on. The available fields
depend on the typeName:
• AGENT - Not applicable.
• BACKUP - Not applicable.
• HOST and HOST_METRIC
- Possible values are:
– HOSTNAME
– PORT
–
HOSTNAME_AND_PORT
– REPLICA_SET_NAME
– TYPE_NAME
• REPLICA_SET - Possible
values are:
– REPLICA_SET_NAME
– SHARD_NAME
– CLUSTER_NAME
enum
The operator to test the field’s value.
Possible values are:
• EQUALS
• NOT_EQUALS
• CONTAINS
• NOT_CONTAINS
• STARTS_WITH
• ENDS_WITH
• REGEX
Continued on next page
130
Name
matchers.value
Table 2 – continued from previous page
Type
Description
string
The value to test with the specified operator. When matching on
the TYPE_NAME field for a HOST
or HOST_METRIC alert, the possible
typeName values are:
• PRIMARY
• SECONDARY
• STANDALONE
• CONFIG
• MONGOS
notifications
object array
notifications.typeName
enum
notifications.delayMin
integer
notifications.intervalMin
integer
notifications.emailAddress
string
notifications.notificationToken
string
notifications.roomName
string
notifications.emailEnabled
boolean
notifications.smsEnabled
boolean
notifications.username
string
notifications.mobileNumber
string
Notifications to send when an alert
condition is detected.
The type of alert notification. Possible values are:
• GROUP
• USER
• SMS (Only available to OnPrem MMS installations)
• EMAIL
• PAGER_DUTY
• HIPCHAT
• SNMP
The number of minutes to wait after
an alert condition is detected before
sending out the first notification.
The number of minutes to wait between succcessive notifications for
unacknowledged alerts that are not
resolved.
The email address to which to send
notification. Only present for notifications of type EMAIL.
A HipChat API token. Only present
for notifications of type HIP_CHAT.
HipChat room name. Only present
for notifications of type HIP_CHAT.
Should email notifications be sent?
Only present for notifications of type
GROUP and USER.
Should SMS notifications be sent?
Only present for notifications of type
GROUP and USER.
The name of an MMS user to which
to send notifications. Only a user in
the group that owns the alert configuration is allowed here.
Mobile number to send SMS messages to. Only present for notifications of type SMS.
Continued on next page
131
Name
notifications.snmpAddress
notifications.serviceKey
metricThreshold
metricThreshold.metricName
metricThreshold.operator
Table 2 – continued from previous page
Type
Description
string
Hostname and port to send SNMP
traps to. Note that SNMP is only supported for On-Prem MMS; also, at
this time MMS is only able to send
SNMP traps to the standard SNMP
port (161).
string
PagerDuty service key.
object
The threshold that will cause an alert
to be triggered. Only present for
alerts of the HOST_METRIC.
enum
The name of the metric to check.
Supports the same values as the
metricName field of the alerts resource.
enum
The operator to apply when checking
the current metric value against the
threshold value. Possible values are:
• GREATER_THAN
• LESS_THAN
metricThreshold.threshold
integer
metricThreshold.units
enum
metricThreshold.mode
enum
The threshold value outside of which
an alert will be triggered.
The units for the threshold value.
Supports the same values as the
currentValue.units field of
the alerts resource.
The mode to use when computing the
current metric value. Possible values
are:
• AVERAGE
• TOTAL
Links
Relation
self
group
alerts
Description
Me
The group that owns this alert configuration.
Open alerts triggered by this alert configuration.
Examples
Get All Alert Configurations in a Group
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db
HTTP/1.1 200 OK
{
"totalCount": 3,
"results": [ {
132
"id" : "5271259ee4b00ece6b4754ef",
"groupId" : "5196d3628d022db4cbc26d9e",
"typeName" : "BACKUP",
"eventTypeName" : "RESYNC_REQUIRED",
"created" : "2013-10-30T15:28:30Z",
"updated" : "2014-02-12T16:11:05Z",
"enabled" : true,
"matchers" : [ ],
"notifications" : [ {
"typeName" : "EMAIL",
"intervalMin" : 60,
"delayMin" : 0,
"emailAddress" : "[email protected]"
} ],
"links" : [ ... ]
}, {
"id" : "5329c8dfe4b0b07a83d67e7e",
"groupId" : "5196d3628d022db4cbc26d9e",
"typeName" : "AGENT",
"eventTypeName" : "MONITORING_AGENT_DOWN",
"created" : "2014-03-19T16:42:07Z",
"updated" : "2014-03-19T16:42:07Z",
"enabled" : true,
"matchers" : [ ],
"notifications" : [ {
"typeName" : "GROUP",
"intervalMin" : 5,
"delayMin" : 0,
"emailEnabled" : true,
"smsEnabled" : false
} ],
"links" : [ ... ]
}, {
"id" : "533dc40ae4b00835ff81eaee",
"groupId" : "5196d3628d022db4cbc26d9e",
"typeName" : "HOST_METRIC",
"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
"created" : "2014-04-03T20:26:50Z",
"updated" : "2014-04-03T20:26:50Z",
"enabled" : true,
"matchers" : [ {
"field" : "hostnameAndPort",
"operator" : "EQUALS",
"value" : "mongo.babypearfoo.com:27017"
} ],
"notifications" : [ {
"typeName" : "SMS",
"intervalMin" : 5,
"delayMin" : 0,
"mobileNumber" : "2343454567"
} ],
"metricThreshold" : {
"metricName" : "ASSERT_REGULAR",
"operator" : "LESS_THAN",
"threshold" : 99.0,
"units" : "RAW",
"mode" : "AVERAGE"
},
133
"links" : [ ... ]
} ]
}
Get an Alert Configuration
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db
HTTP/1.1 200 OK
{
"id" : "533dc40ae4b00835ff81eaee",
"groupId" : "5196d3628d022db4cbc26d9e",
"typeName" : "HOST_METRIC",
"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
"created" : "2014-04-03T20:26:50Z",
"updated" : "2014-04-03T20:26:50Z",
"enabled" : true,
"matchers" : [ {
"field" : "hostnameAndPort",
"operator" : "EQUALS",
"value" : "mongo.babypearfoo.com:27017"
} ],
"notifications" : [ {
"typeName" : "SMS",
"intervalMin" : 5,
"delayMin" : 0,
"mobileNumber" : "2343454567"
} ],
"metricThreshold" : {
"metricName" : "ASSERT_REGULAR",
"operator" : "LESS_THAN",
"threshold" : 99.0,
"units" : "RAW",
"mode" : "AVERAGE"
},
"links" : [ ... ]
}
Get All Open Alerts Triggered by an Alert Configuration
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db
HTTP/1.1 200 OK
{
"totalCount" : 2,
"results" : [ {
"id" : "53569159300495c7702ee3a3",
"groupId" : "4d1b6314e528c81a1f200e03",
"typeName" : "HOST_METRIC",
"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
"status" : "OPEN",
"acknowledgedUntil" : "2014-05-01T14:00:00Z",
"created" : "2014-04-22T15:57:13.562Z",
"updated" : "2014-04-22T20:14:11.388Z",
"lastNotified" : "2014-04-22T15:57:24.126Z",
"metricName" : "ASSERT_REGULAR",
134
"currentValue" : {
"number" : 0.0,
"units" : "RAW"
},
"links" : [ ... ]
}, {
"id" : "5356ca0e300495c770333340",
"groupId" : "4d1b6314e528c81a1f200e03",
"typeName" : "HOST_METRIC",
"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
"status" : "OPEN",
"created" : "2014-04-22T19:59:10.657Z",
"updated" : "2014-04-22T20:14:11.388Z",
"lastNotified" : "2014-04-22T20:14:19.313Z",
"metricName" : "ASSERT_REGULAR",
"currentValue" : {
"number" : 0.0,
"units" : "RAW"
},
"links" : [ ... ]
} ],
"links" : [ ... ]
}
Create a New Alert Configuration
curl -i -u "username:apiKey" -H "Content-Type: application/json" --digest -X POST "https://mms.mongod
{
"groupId" : "4d1b6314e528c81a1f200e03",
"typeName" : "REPLICA_SET",
"eventTypeName" : "RESYNC_REQUIRED",
"enabled" : true,
"notifications" : [ {
"typeName" : "GROUP",
"intervalMin" : 5,
"delayMin" : 0,
"smsEnabled" : false,
"emailEnabled" : true
} ]
}'
HTTP/1.1 201 Created
Location: https://mms.mongodb.com/api/public/v1.0/groups/4d1b6314e528c81a1f200e03/alertConfigs/5357ce
{
"id" : "5357ce3e3004d83bd9c7864c",
"groupId" : "4d1b6314e528c81a1f200e03",
"typeName" : "REPLICA_SET",
"created" : "2014-04-23T14:29:18Z",
"updated" : "2014-04-23T14:29:18Z",
"enabled" : true,
"matchers" : [ ],
"notifications" : [ {
"typeName" : "GROUP",
"intervalMin" : 5,
"delayMin" : 0,
"emailEnabled" : true,
"smsEnabled" : false
135
} ],
"links" : [ ... ]
}
Update an Existing Alert Configuration
curl -i -u "username:apiKey" -H "Content-Type: application/json" --digest -X PUT "https://mms.mongodb
{
"groupId" : "4d1b6314e528c81a1f200e03",
"typeName" : "REPLICA_SET",
"eventTypeName" : "RESYNC_REQUIRED",
"enabled" : true,
"matchers" : [ {
"fieldName" : "REPLICA_SET_NAME",
"operator" : "EQUALS",
"value" : "rs1"
} ],
"notifications" : [ {
"typeName" : "EMAIL",
"emailAddress" : "[email protected]",
"intervalMin" : 60,
"delayMin" : 5
}, {
"typeName" : "GROUP",
"intervalMin" : 120,
"delayMin" : 60,
"smsEnabled" : true,
"emailEnabled" : false
} ]
}'
HTTP/1.1 200 OK
{
"id" : "5357ce3e3004d83bd9c7864c",
"groupId" : "4d1b6314e528c81a1f200e03",
"typeName" : "REPLICA_SET",
"created" : "2014-04-23T14:52:29Z",
"updated" : "2014-04-23T14:52:29Z",
"enabled" : true,
"matchers" : [ {
"fieldName" : "REPLICA_SET_NAME",
"operator" : "EQUALS",
"value" : "rs1"
} ],
"notifications" : [ {
"typeName" : "EMAIL",
"intervalMin" : 60,
"delayMin" : 5,
"emailAddress" : "[email protected]"
}, {
"typeName" : "GROUP",
"intervalMin" : 120,
"delayMin" : 60,
"emailEnabled" : false,
"smsEnabled" : true
} ],
"links" : [ ... ]
136
}
Disable an Alert Configuration
curl -i -u "username:apiKey" -H "Content-Type: application/json" --digest -X PATCH "https://mms.mongo
{
"enabled" : false
}'
HTTP/1.1 200 OK
{
"id" : "5357ce3e3004d83bd9c7864c",
"groupId" : "4d1b6314e528c81a1f200e03",
"typeName" : "REPLICA_SET",
"created" : "2014-04-23T14:52:29Z",
"updated" : "2014-04-23T14:56:25Z",
"enabled" : false,
"matchers" : [ {
"fieldName" : "REPLICA_SET_NAME",
"operator" : "EQUALS",
"value" : "rs1"
} ],
"notifications" : [ {
"typeName" : "EMAIL",
"intervalMin" : 60,
"delayMin" : 5,
"emailAddress" : "[email protected]"
}, {
"typeName" : "GROUP",
"intervalMin" : 120,
"delayMin" : 60,
"emailEnabled" : false,
"smsEnabled" : true
} ],
"links" : [ ... ]
}
Delete an Alert Configuration
curl -i -u "username:apiKey" --digest -X DELETE "https://mms.mongodb.com/api/public/v1.0/groups/4d1b6
HTTP/1.1 200 OK
Backup Configurations
The resource modification operation PATCH only accepts requests from whitelisted IP addressses. You can only
modify a backup configuration if the request originates from an IP address on the API user’s whitelist.
Operations
• GET /api/public/v1.0/groups/GROUP-ID/backupConfigs/CLUSTER-ID - Get a single
backup configuration by cluster ID. CLUSTER-ID must be the ID of either a replica set or a sharded cluster.
137
• GET /api/public/v1.0/groups/GROUP-ID/backupConfigs - Get all backup configurations for
a group.
• PATCH /api/public/v1.0/groups/GROUP-ID/backupConfigs/CLUSTER-ID - Request a state
change to an existing backup configuration. Note that these changes are generally asynchronous and will result
in a response status code of 202 (Accepted). Additionally, if you issue a GET request for a backup configuration
after a successful PATCH, the returned entity may not immediately reflect the update given the asynchronous
nature of these state transitions.
When modifying the statusName property, these are the acceptable transitions:
– STARTED - Only valid if the current status is STOPPED or INACTIVE.
– STOPPED - Only valid if the current status is STARTED.
– TERMINATING - Only valid if the current status is STOPPED.
– You cannot change the statusName to these values: INACTIVE PROVISIONING.
Sample Entity
{
"groupId": "xxx",
"clusterId": "yyy",
"statusName": "STARTED",
"authMechanismName": "MONGODB_CR",
"username": "johnny5",
"password": "guess!",
"sslEnabled": false,
"syncSource": "PRIMARY",
"provisioned": true,
"excludedNamespaces:" [ "a", "b", "c.d" ]
}
138
139
Entity Fields
Name
groupId
Type
string
clusterId
string
statusName
enum
authMechanismName
enum
The name of the authentication mechanism to use when connecting to the
sync source database. Only present
when using authentication. Possible
values are:
• MONGODB_CR
• GSSAPI
username
string
password
string
sslEnabled
boolean
syncSource
string
provisioned
boolean
excludedNamespaces
string array
The username to use to connect to the
sync source database. Only present
when backing up mongod instances
that require clients to authenticate.
The password to use to connect to the
sync source database. Only present
when backup the mongod instances
that require clients to authenticate.
You may only send this field to MMS
when updating backup configuration.
GET request do not include this field.
Is SSL enabled for the sync source
database?
The mongod instance to get backup
data from. Possible values are either a specific hostname or one of:
PRIMARY and SECONDARY. This
field is only used when updating a
backup configuration. It is not returned by a GET request.
Reports if MMS has provisioned the
resources needed to store a backup.
This field is only present when the
amount of data to be backed up exceeds a certain threshold.
A list of database names and/or
collection names that to omit from
the back up. If a string has a dot
(e.g. .), then it is a fully qualified namespace in the form of
<database>.<collection>,
otherwise strings are database names.
140
Description
ID of the group that owns this backup
configuration.
ID of the cluster that this backup configuration is for.
The current (or desired) status of the
backup configuration. Possible values are:
• INACTIVE
• PROVISIONING
• STARTED
• STOPPED
• TERMINATING
Links
Relation
self
cluster
group
snapshotSchedule
Description
Me
The cluster that this backup configuration is for.
The group that owns this backup configuration.
The snapshot schedule for this backup configuration.
Examples
Get a Single Backup Configuration
curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db
HTTP/1.1 200 OK
{
"groupId" : "5196d3628d022db4cbc26d9e",
"clusterId" : "5196e5b0e4b0fca9cc88334a",
"statusName" : "STARTED",
"sslEnabled" : false,
"excludedNamespaces" : [ ],
"links" : [ ... ]
}
Get All Backup Configurations for a Group
curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db
HTTP/1.1 200 OK
{
"totalCount" : 3,
"results" : [ {
"groupId" : "5196d3628d022db4cbc26d9e",
"clusterId" : "5196e5b0e4b0fca9cc88334a",
"statusName" : "STARTED",
"sslEnabled" : false,
"excludedNamespaces" : [ ],
"links" : [ ... ]
}, {
"groupId" : "5196d3628d022db4cbc26d9e",
"clusterId" : "51a2ac88e4b0371c2dbf46ea",
"statusName" : "STARTED",
"sslEnabled" : false,
"excludedNamespaces" : [ ],
"links" : [ ... ]
}, {
"groupId" : "5196d3628d022db4cbc26d9e",
"clusterId" : "52d33abee4b0ca49bc6acd6c",
"statusName" : "STOPPED",
"sslEnabled" : false,
"excludedNamespaces" : [ ],
"links" : [ ... ]
} ],
"links" : [ ... ]
}
141
Update a Backup Configuration
curl -i -u "username:apiKey" -H "Content-Type: application/json" --digest -X PATCH "https://mms.mongo
{
"statusName": "STOPPED"
}'
HTTP/1.1 202 Accepted
{
"groupId" : "5196d3628d022db4cbc26d9e",
"clusterId" : "5196e5b0e4b0fca9cc88334a",
"statusName" : "STOPPED",
"sslEnabled" : false,
"excludedNamespaces" : [ ],
"links" : [ ... ]
}
Snapshot Schedule
This resource allows you to view and configure various properties of snapshot creation and retention for a replica set
or cluster. In order to modify this resource, the request must originate from an IP address on the API user’s whitelist.
Operations
• GET /api/public/v1.0/groups/GROUP-ID/backupConfigs/CLUSTER-ID/snapshotSchedule
- Get the snapshot schedule for a cluster. CLUSTER-ID must be the ID of either a replica set or a sharded
cluster.
• PATCH /api/public/v1.0/groups/GROUP-ID/backupConfigs/CLUSTER-ID/snapshotSchedule
- Change the parameters of snapshot creation and retention. Any combination of the snapshot schedule’s
attributes can be modified.
Sample Entity
{
"groupId": "xxx",
"clusterId": "yyy",
"snapshotIntervalHours": 6,
"snapshotRetentionDays": 3,
"clusterCheckpointIntervalMin": 15,
"dailySnapshotRetentionDays": 14,
"weeklySnapshotRetentionWeeks": 6,
"monthlySnapshotRetentionMonths": 12
}
142
Entity Fields
Name
groupId
clusterId
snapshotIntervalHours
snapshotRetentionDays
clusterCheckpointIntervalMin
dailySnapshotRetentionDays
weeklySnapshotRetentionWeeks
monthlySnapshotRetentionMonths
Type
string
string
integer
integer
integer
integer
integer
integer
Description
ID of the group that owns the backup configuration.
ID of the cluster to which this backup configuration applies.
Number of hours between snapshots. Supported values are 6, 8, 12, and 24.
Number of days to keep recent snapshots. Supported values are 1 - 5.
Number of minutes between successive cluster checkpoints. This only applies to
sharded clusters. This number determines the granularity of point-in-time restores for
sharded clusters.
Number of days to retain daily snapshots. Supported values are 1 - 365.
Number of weeks to retain weekly snapshots. Supported values are 1 - 52.
Number of months to retain monthly snapshots. Supported values are 1 - 36.
Links
Relation
self
cluster
group
backupConfig
Description
Me
The cluster that this backup configuration is for.
The group that owns this backup configuration.
The backup configuration that this schedule belongs to.
Examples
Get a Snapshot Schedule
curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/groups/525ec8394f5e625
HTTP/1.1 200 OK
{
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
"snapshotIntervalHours" : 6,
"snapshotRetentionDays" : 2,
"dailySnapshotRetentionDays" : 7,
"weeklySnapshotRetentionWeeks" : 4,
"monthlySnapshotRetentionMonths" : 13,
"links": [ ... ]
}
Update a Snapshot Schedule
143
curl -i -u "username:apiKey" -H "Content-Type: application/json" --digest -X PATCH "https://mms.mongo
{
"snapshotIntervalHours": 8,
"dailySnapshotRetentionDays": 14,
"monthlySnapshotRetentionMonths": 6
}'
HTTP/1.1 200 OK
{
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
"snapshotIntervalHours" : 8,
"snapshotRetentionDays" : 2,
"dailySnapshotRetentionDays" : 14,
"weeklySnapshotRetentionWeeks" : 4,
"monthlySnapshotRetentionMonths" : 6,
"links": [ ... ]
}
Snapshots
This resource allows you to view snapshot metadata and remove existing snapshots. A snapshot is a complete copy of
the data in a mongod instance at a point in time. In order to delete a resource, the request must originate from an IP
address on the API user’s whitelist.
Note that this resource is only meant to provide snapshot metadata. In order to retrieve the snapshot data (in order to
perform a restore, for example), you must create a Restore Job.
Operations
• GET /api/public/v1.0/groups/GROUP-ID/clusters/CLUSTER-ID/snapshots - Get all
snapshots for a cluster. CLUSTER-ID must be the ID of either a replica set or a sharded cluster.
• GET /api/public/v1.0/groups/GROUP-ID/clusters/CLUSTER-ID/snapshots/SNAPSHOT-ID
- Get a single snapshot.
• DELETE /api/public/v1.0/groups/GROUP-ID/clusters/CLUSTER-ID/snapshots/SNAPSHOT-ID
- Remove a single snapshot. Note that while the two above methods return metadata about the snapshot, this
will actually remove the underlying backed-up data.
Sample Entity
{
"id": "5875f665da588548965b",
"groupId": "2847387cd717dabc348a",
"clusterId": "348938fbdbca74718cba",
"created": {
"date": "2014-02-01T12:34:12Z",
"increment": 54
},
"expires": "2014-08-01T12:34:12Z",
"complete": true,
"isPossiblyInconsistent": false,
144
"missingShards": [
{
"id": "472837bcbd278abcd7",
"groupId": "2847387cd717dabc348a",
"typeName": "REPLICA_SET",
"clusterName": "Cluster 1",
"shardName": "shard002",
"replicaSetName": "rs3",
"lastHeartbeat": "2014-02-26T17:32:45Z"
}
],
"parts": [
{
"typeName": "REPLICA_SET",
"clusterId": "2383294dbcafa82928ad",
"replicaSetName": "rs0",
"mongodVersion": "2.4.8",
"dataSizeBytes": 489283492,
"storageSizeBytes": 489746352,
"fileSizeBytes": 518263456
}, {
"typeName": "REPLICA_SET",
"clusterId": "2383294dbcafa82928b3",
"replicaSetName": "rs1",
"mongodVersion": "2.4.8",
"dataSizeBytes": 489283492,
"storageSizeBytes": 489746352,
"fileSizeBytes": 518263456
}, {
"typeName": "CONFIG_SERVER",
"mongodVersion": "2.4.6",
"dataSizeBytes": 48928,
"storageSizeBytes": 48974,
"fileSizeBytes": 51826
}
]
}
145
146
Entity Fields
Name
groupId
Type
string
clusterId
string
created
BSON timestamp
expires
timestamp
complete
boolean
isPossiblyInconsistent
boolean
missingShards
array of clusters
parts
array of parts
parts.typeName
enum
parts.clusterId
string
parts.replicaSetName
string
parts.mongodVersion
string
parts.dataSizeBytes
integer
parts.storageSizeBytes
integer
Description
ID of the group that owns the snapshot.
ID of the cluster represented by the
snapshot.
The exact point-in-time at which the
snapshot was taken.
The date after which this snapshot is
eligible for deletion.
Is this snapshot complete? This will
be false if the snapshot creation job is
still in progress.
Could this snapshot be inconsistent?
isPossiblyInconsistent
is only present for sharded cluster
snapshots. In order to take a snapshot
of a sharded cluster in a consistent
state, the backup agent will temporarily turn off the balancer before
creating the snapshot. In some cases,
it will not be able to turn off the
balancer in a timely manner, so the
snapshot will be created with the balancer still running. If this happens,
the snapshot may be in an inconsistent state (e.g., because chunk
migrations may be in progress).
List of shards that are missing from
the snapshot. Only present for a
sharded cluster snapshot. In steady
state, this array will be empty. However, if the backup agent is unable to
connect to a shard when a snapshot
is created, it will be omitted from the
snapshot. Each document in the array is a cluster document containing
a self link.
The individual parts that comprise the
complete snapshot. For a replica set,
this array will contain a single element. For a sharded cluster, there will
be one element for each shard plus
one element for the config server.
The type of server represented by the
part. Possible values are:
• REPLICA_SET
• CONFIG_SERVER
ID of the replica set. Not present for
a config server.
Name of the replica set. Not present
for a config server.
The version of mongod that was running when the snapshot was created.
147
The total size of the data in the snapshot.
The total size of space allocated for
Links
Relation
self
cluster
group
Description
Me
The cluster that this snapshot belongs to.
The group that owns this snapshot.
Examples
Get All Snapshots
curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/groups/525ec8394f5e625
HTTP/1.1 200 OK
{
"totalCount" : 3,
"results" : [ {
"id" : "53bd5fb5e4b0774946a16fad",
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
"created" : {
"date" : "2014-07-09T15:24:37Z",
"increment" : 1
},
"expires" : "2014-07-11T15:24:37Z",
"complete" : true,
"parts" : [ {
"typeName" : "REPLICA_SET",
"clusterId" : "53bc556ce4b049c88baec825",
"replicaSetName" : "rs0",
"mongodVersion" : "2.6.3",
"dataSizeBytes" : 17344,
"storageSizeBytes" : 10502144,
"fileSizeBytes" : 67108864
} ],
"links" : [ ... ]
}, {
...
} ],
"links": [ ... ]
}
Get One Snapshot
curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/groups/525ec8394f5e625
HTTP/1.1 200 OK
{
"id" : "53bd5fb5e4b0774946a16fad",
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
"created" : {
"date" : "2014-07-09T15:24:37Z",
"increment" : 1
},
148
"expires" : "2014-07-11T15:24:37Z",
"complete" : true,
"parts" : [ {
"typeName" : "REPLICA_SET",
"clusterId" : "53bc556ce4b049c88baec825",
"replicaSetName" : "rs0",
"mongodVersion" : "2.6.3",
"dataSizeBytes" : 17344,
"storageSizeBytes" : 10502144,
"fileSizeBytes" : 67108864
} ],
"links" : [ ... ]
}
Remove a Snapshot
curl -i -u "username:apiKey" --digest -X DELETE "https://mms.mongodb.com/api/public/v1.0/groups/525ec
HTTP/1.1 200 OK
Restore Jobs
This resource allows you to manage restore jobs. A restore job is essentially a request to retrieve one of your existing
snapshots, or a snapshot for a recent specific point-in-time, in order to restore a mongod to a previous state. In order
to initiate a restore job, the request must originate from an IP address on the API user’s whitelist.
Operations
• GET /api/public/v1.0/groups/GROUP-ID/clusters/CLUSTER-ID/restoreJobs - Get all
restore jobs for a cluster. CLUSTER-ID must be the ID of either a replica set or a sharded cluster.
• GET /api/public/v1.0/groups/GROUP-ID/clusters/CLUSTER-ID/restoreJobs?batchId=BATCH-ID
- Get all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MMS creates a
separate job for each shard, plus another for the config server. Each of those jobs will be part of a batch. A
restore job for a replica set, however, will not be part of a batch.
• GET /api/public/v1.0/groups/GROUP-ID/clusters/CLUSTER-ID/restoreJobs/JOB-ID
- Get a single restore job.
• POST /api/public/v1.0/groups/GROUP-ID/clusters/CLUSTER-ID/restoreJobs - Create a restore job for the specified CLUSTER-ID. You can create a restore job for either an existing snapshot
or for a specific recent point-in-time. (The recency depends on the size of your “point-in-time window.”) See
below for examples of each. The response body includes an array of restore jobs. When requesting a restore of
a replica set, the array will contain a single element. For a sharded cluster, the array will contain one element for
each shard, plus one for the config server. Each element will also include the batchId representing the batch
to which the jobs belong.
Sample Entity
{
"id" : "53bd7f13e4b0a7304e226998",
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
149
"snapshotId" : "53bd439ae4b0774946a16490",
"created" : "2014-07-09T17:42:43Z",
"timestamp" : {
"date" : "2014-07-09T09:24:37Z",
"increment" : 1
},
"statusName" : "FINISHED",
"pointInTime" : false,
"delivery" : {
"methodName" : "HTTP",
"url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/ae6bc7a8bfdd5a99a0c118c73845dc75/5
"expires" : "2014-07-09T18:42:43Z",
"statusName" : "READY"
},
"links" : [ ... ]
}
150
Entity Fields
Name
groupId
Type
string
clusterId
string
snapshotId
batchId
string
string
created
timestamp
timestamp
BSON timestamp
statusName
enum
pointInTime
delivery
boolean
object
delivery.methodName
enum
delivery.url
string
delivery.expires
timestamp
delivery.statusName
enum
Description
ID of the group that owns the restore
job.
ID of the cluster represented by the
restore job.
ID of the snapshot to restore.
ID of the batch to which this restore
job belongs. Only present for a restore of a sharded cluster.
When the restore job was requested.
Timestamp of the latest oplog entry
in the restored snapshot.
Current status of the job. Possible
values are:
• FINISHED
• IN_PROGRESS
• BROKEN
• KILLED
Is this job for a point-in-time restore?
Additional details about how the restored snapshot data will be delivered.
How the data will be delivered. Possible values are:
• HTTP
The URL from which the restored snapshot data can be
downloaded.
Only present if
delivery.methodName
is
HTTP.
Date after which the URL will no
longer be available. Only present
if delivery.methodName is
HTTP.
Current status of the downloadable file.
Only present if
delivery.methodName
is
HTTP. Possible values are:
• READY
• EXPIRED
•
MAX_DOWNLOADS_EXCEEDED
151
Links
Relation
self
cluster
snapshot
group
Description
Me
The cluster to restore.
The snapshot to restore.
The group that owns the cluster.
Examples
Get All Restore Jobs
curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/groups/525ec8394f5e625
HTTP/1.1 200 OK
{
"totalCount" : 2,
"results" : [ {
"id" : "53bd7f38e4b0a7304e226b3f",
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
"snapshotId" : "53bd4356e4b0774946a16455",
"created" : "2014-07-09T17:43:20Z",
"timestamp" : {
"date" : "2014-07-08T21:24:37Z",
"increment" : 1
},
"statusName" : "FINISHED",
"pointInTime" : false,
"delivery" : {
"methodName" : "HTTP",
"url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/ae6bc7a8bfdd5a99a0c118c73845dc75
"expires" : "2014-07-09T18:43:21Z",
"statusName" : "READY"
},
"links" : [ ... ]
}, {
"id" : "53bd7f13e4b0a7304e226998",
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
"snapshotId" : "53bd439ae4b0774946a16490",
"created" : "2014-07-09T17:42:43Z",
"timestamp" : {
"date" : "2014-07-09T09:24:37Z",
"increment" : 1
},
"statusName" : "FINISHED",
"pointInTime" : false,
"delivery" : {
"methodName" : "HTTP",
"url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/ae6bc7a8bfdd5a99a0c118c73845dc75
"expires" : "2014-07-09T18:42:43Z",
"statusName" : "READY"
},
"links" : [ ... ]
} ],
152
"links": [ ... ]
}
Get a Single Restore Job
curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/groups/525ec8394f5e625
HTTP/1.1 200 OK
{
"id" : "53bd7f13e4b0a7304e226998",
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
"snapshotId" : "53bd439ae4b0774946a16490",
"created" : "2014-07-09T17:42:43Z",
"timestamp" : {
"date" : "2014-07-09T09:24:37Z",
"increment" : 1
},
"statusName" : "FINISHED",
"pointInTime" : false,
"delivery" : {
"methodName" : "HTTP",
"url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/ae6bc7a8bfdd5a99a0c118c73845dc75/5
"expires" : "2014-07-09T18:42:43Z",
"statusName" : "READY"
},
"links" : [ ... ]
}
Create a Restore Job for an Existing Snapshot
curl -i -u "username:apiKey" -H "Content-Type: application/json" --digest -X POST "https://mms.mongod
{
"snapshotId": "53bd439ae4b0774946a16490"
}'
HTTP/1.1 200 OK
{
"totalCount" : 1,
"results" : [ {
"id" : "53bd9f9be4b0a7304e23a8c6",
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
"snapshotId" : "53bd439ae4b0774946a16490",
"created" : "2014-07-09T20:01:31Z",
"timestamp" : {
"date" : "2014-07-09T09:24:37Z",
"increment" : 1
},
"statusName" : "IN_PROGRESS",
"pointInTime" : false,
"links" : [ ... ]
} ]
}
153
Create a Point-In-Time Restore Job
curl -i -u "username:apiKey" -H "Content-Type: application/json" --digest -X POST "https://mms.mongod
{
"timestamp": {
"date": "2014-07-09T09:20:00Z",
"increment": 0
}
}'
HTTP/1.1 200 OK
{
"totalCount" : 1,
"results" : [ {
"id" : "53bda0dfe4b0a7304e23b54a",
"groupId" : "525ec8394f5e625c80c7404a",
"clusterId" : "53bc556ce4b049c88baec825",
"created" : "2014-07-09T20:06:55Z",
"timestamp" : {
"date" : "2014-07-09T09:20:00Z",
"increment" : 0
},
"statusName" : "IN_PROGRESS",
"pointInTime" : true,
"links" : [ ... ]
} ]
}
Whitelist
The resource modification operations POST and DELETE are whitelisted. For example, you can only add an IP address
to a whitelist if the request originates from an IP address on the existing whitelist.
Operations
• GET /api/public/v1.0/users/USER-ID/whitelist - Gets the whitelist for the specified user. You
can only access your own whitelist, so the USER-ID in the URL must match the ID of the user associated with
the API Key.
• GET /api/public/v1.0/users/USER-ID/whitelist/IP-ADDRESS - Gets the whitelist entry for
a single IP address.
• POST /api/public/v1.0/users/USER-ID/whitelist - Add one or more IP addresses to the user’s
whitelist.
– The entity body must be an array of whitelist entities, even if there is only one. The only field you need to
specify for each entity is the ipAddress.
– If an IP address is already in the whitelist, it will be ignored.
• DELETE /api/public/v1.0/users/USER-ID/whitelist/IP-ADDRESS - Remove an IP address
from the whitelist.
– You cannot remove your current IP address from the whitelist.
154
Sample Entity
{
"ipAddress": "1.2.3.4",
"created": "2014-01-02T12:34:56Z",
"lastUsed": "2014-03-12T02:03:04Z",
"count": 1234
}
Entity Fields
Name
ipAddress
created
lastUsed
count
Type Description
string A whitelisted IP address.
date
The date this IP address was added to the whitelist.
date
The date of the most recent request that originated from this IP address. Note that this field is only
updated when a resource that is protected by the whitelist is accessed.
The total number of requests that originated from this IP address. Note that this field is only
updated when a resource that is protected by the whitelist is accessed.
integer
Links
Relation
self
user
Description
Me
The user that owns this whitelist.
Examples
Get a User’s Whitelist
curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/users/5356823b3004dee3
HTTP/1.1 200 OK
{
"totalCount" : 1,
"results" : [ {
"ipAddress" : "12.34.56.78",
"created" : "2014-04-23T16:17:44Z",
"count" : 482,
"links" : [ ... ]
} ],
"links" : [ ... ]
}
Get a Single Whitelist Entry
curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/users/5356823b3004dee3
HTTP/1.1 200 OK
155
{
"ipAddress" : "12.34.56.78",
"created" : "2014-04-23T16:17:44Z",
"count" : 482,
"links" : [ ... ]
}
Add Entries to a User’s Whitelist
curl -i -u "username:apiKey" -H "Content-Type: application/json" --digest -X POST "https://mms.mongod
[ {
"ipAddress" : "76.54.32.10"
}, {
"ipAddress" : "2.3.4.5"
} ]'
HTTP/1.1 201 Created
Location: https://mms.mongodb.com/api/public/v1.0/users/5356823b3004dee37132bb7b/whitelist
{
"totalCount" : 3,
"results" : [ {
"ipAddress" : "12.34.56.78",
"created" : "2014-04-23T16:17:44Z",
"count" : 0,
"links" : [ ... ]
}, {
"ipAddress" : "76.54.32.10",
"created" : "2014-04-23T16:23:44Z",
"count" : 0,
"links" : [ ... ]
}, {
"ipAddress" : "2.3.4.5",
"created" : "2014-04-23T16:23:44Z",
"count" : 0,
"links" : [ ... ]
} ],
"links" : [ ... ]
}
Delete an Entry from a User’s Whitelist
curl -i -u "username:apiKey" --digest -X DELETE "https://mms.mongodb.com/api/public/v1.0/users/535682
HTTP/1.1 200 OK
Automation Configuration
Overview
The Public API provides the automationConfig endpoint to let you manipulate a group’s automation configuration. The processes you specify in the configuration, define the deployment that your Automation Agents will attempt
to build. These processes can include clusters, replica sets and standalones, as well as Backup and Monitoring Agents.
Each Automation Agent resides on its own host and is responsible for the processes the configuration defines for
that host. The agent runs the processes as defined by the configuration. When a running process matches its defined
156
configuration, the process is in “goal state.” When all processes on all hosts are in goal state, the deployment itself is
in goal state.
Operations
• GET /api/public/v1.0/groups/GROUP-ID/automationConfig
Retrieve the current automation configuration for a group.
• PUT /api/public/v1.0/groups/GROUP-ID/automationConfig
Update a group’s automation configuration. For steps for updating an automation configuration, see Deploy a
Cluster through the API.
Updates To update the configuration through the automationConfig endpoint, send an object that contains a
specific subset of the configuration’s fields. This is the same subset as you receive when you retrieve the configuration
through the endpoint.
When you submit updates, MMS makes internal modifications to the data and then saves your new configuration
version. For example, MMS might add a field to each specified community MongoDB version to indicate where the
agents download them from.
The Automation Agents continuously poll MMS for changes to the configuration and fetch configuration updates when
they occur. The agents then adjust the states of their live processes to match. For a tutorial on updating a deployment
using the API, see Deploy a Cluster through the API.
Concurrent Modifications Warning There is no protection in the Public API to prevent concurrent modifications.
If two administrators both start with a configuration based on the current version, make their own modifications, and
then submit their modifications, the later modification wins.
Other Representations of the Automation Configuration
You can view the internal representation of the configuration through the Raw AutomationConfig page on the Deployment tab of the MMS interface. The raw configuration shows the internal representation of the configuration that MMS
stores, including fields that should not be updated through the API.
The Automation Agent also stores a copy of the configuration in the mms-cluster-config-backup.json file.
The agent stores the most recent version of configuration with which the agent was able to reach goal state. If an
agent is not able to process configuration changes, it continues to store an older version of the configuration.
Sample Automation Configuration Entity
{
"monitoringVersions": [
{
"hostname": "one.example.net",
"logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log",
"logRotate": {
"sizeThresholdMB": 1000,
"timeThresholdHrs": 24
}
}
],
157
"backupVersions": [
{
"hostname": "one.example.net",
"logPath": "/var/log/mongodb-mms-automation/backup-agent.log",
"logRotate": {
"sizeThresholdMB": 1000,
"timeThresholdHrs": 24
}
}
],
"processes": [
{
"name": "MyCLUSTER_MySHARD_0_0",
"processType": "mongod",
"version": "2.6.7",
"hostname": "testAutoAPI-0.dns.placeholder",
"logRotate": {
"sizeThresholdMB": 1000,
"timeThresholdHrs": 24
},
"authSchemaVersion": 1,
"args2_6": {
"net": {
"port": 27017
},
"storage": {
"dbPath": "/data/MyCLUSTER_MySHARD_0_0"
},
"systemLog": {
"path": "/data/MyCLUSTER_MySHARD_0_0/mongodb.log",
"destination": "file"
},
"replication": {
"replSetName": "MySHARD_0"
},
"operationProfiling": {}
}
},
...,
{
"name": "MyCLUSTER_MyCONFIG_SERVER_8",
"processType": "mongod",
"version": "2.6.7",
"hostname": "SERVER-8",
"logRotate": {
"sizeThresholdMB": 1000,
"timeThresholdHrs": 24
},
"authSchemaVersion": 1,
"args2_6": {
"net": {
"port": 27019
},
"storage": {
"dbPath": "/data/MyCLUSTER_MyCONFIG_SERVER_8"
},
158
"systemLog": {
"path": "/data/MyCLUSTER_MyCONFIG_SERVER_8/mongodb.log",
"destination": "file"
},
"sharding": {
"clusterRole": "configsvr"
},
"operationProfiling": {}
}
},
{
"name": "MyCLUSTER_MyMONGOS_9",
"processType": "mongos",
"version": "2.6.7",
"hostname": "SERVER-9",
"cluster": "myShardedCluster",
"logRotate": {
"sizeThresholdMB": 1000,
"timeThresholdHrs": 24
},
"authSchemaVersion": 1,
"args2_6": {
"net": {
"port": 27017
},
"systemLog": {
"path": "/data/MyCLUSTER_MyMONGOS_9/mongodb.log",
"destination": "file"
},
"operationProfiling": {}
}
}
],
"replicaSets": [
{
"_id": "MySHARD_0",
"members": [
{
"_id": 0,
"host": "MyCLUSTER_MySHARD_0_0",
"priority": 1,
"votes": 1,
"slaveDelay": 0,
"hidden": false,
"arbiterOnly": false
},
{
"_id": 1,
"host": "MyCLUSTER_MySHARD_0_1",
"priority": 1,
"votes": 1,
"slaveDelay": 0,
"hidden": false,
"arbiterOnly": false
},
{
"_id": 2,
"host": "MyCLUSTER_MySHARD_0_2",
159
"priority": 1,
"votes": 1,
"slaveDelay": 0,
"hidden": false,
"arbiterOnly": false
}
]
},
{
"_id": "MySHARD_1",
"members": [
{
"_id": 0,
"host": "MyCLUSTER_MySHARD_1_3",
"priority": 1,
"votes": 1,
"slaveDelay": 0,
"hidden": false,
"arbiterOnly": false
},
{
"_id": 1,
"host": "MyCLUSTER_MySHARD_1_4",
"priority": 1,
"votes": 1,
"slaveDelay": 0,
"hidden": false,
"arbiterOnly": false
},
{
"_id": 2,
"host": "MyCLUSTER_MySHARD_1_5",
"priority": 1,
"votes": 1,
"slaveDelay": 0,
"hidden": false,
"arbiterOnly": false
}
]
}
],
"sharding": [
{
"name": "myShardedCluster",
"configServer": [
"MyCLUSTER_MyCONFIG_SERVER_6",
"MyCLUSTER_MyCONFIG_SERVER_7",
"MyCLUSTER_MyCONFIG_SERVER_8"
],
"shards": [
{
"_id": "MySHARD_0",
"rs": "MySHARD_0"
},
{
"_id": "MySHARD_1",
"rs": "MySHARD_1"
}
160
],
"collections": [],
}
],
"mongoDbVersions": [
{"name": "2.4.12"},
{"name": "2.6.7"}
]
}
Entity Fields
Name
monitoringVersions
- hostname
- logPath
- logRotate
- - sizeThresholdMB
- - timeThresholdHrs
backupVersions
- hostname
- logPath
- logRotate
- - sizeThresholdMB
- - timeThresholdHrs
processes
- name
- processType
- version
- hostname
- cluster
- logRotate
- - sizeThresholdMB
- - timeThresholdHrs
- authSchemaVersion
- <args>
replicaSets
sharding
- name
- configServer
- shards
- - _id
- - rs
- collections
mongoDbVersions
- name
Type
array
string
string
object
number (integer or float)
integer
array
string
string
object
number (integer or float)
integer
array
string
string
string
string
string
object
number (integer or float)
integer
integer
object
array
array
string
array
array
string
string
array
array
string
Description
Optional. Objects that define version information for each Monitoring Agent.
The hostname of the machine that runs the Monitoring Agent. If the Monitoring A
Optional. The directory where the agent stores its logs. The default is to store logs
Optional. Enables log rotation for the MongoDB logs for a process.
The maximum size in MB for an individual log file before rotation.
The maximum time in hours for an individual log file before rotation.
Optional. Objects that define version information for each Backup Agent.
The hostname of the machine that runs the Backup Agent. If the Backup Agent is
Optional. The directory where the agent stores its logs. The default is to store logs
Optional. Enables log rotation for the MongoDB logs for a process.
The maximum size in MB for an individual log file before rotation.
The maximum time in hours for an individual log file before rotation.
The processes array contains objects that define the mongos and mongod ins
A unique name to identify the instance.
Either mongod or mongos.
The name of the mongoDbVersions specification used with this instance.
Optional. The name of the host this process should run on. This defaults to local
Optional. Required for a mongos. The name of the cluster. This must correspond
Optional. Enables log rotation for the MongoDB logs for a process.
The maximum size in MB for an individual log file before rotation.
The maximum time in hours for an individual log file before rotation.
Required if auth is turned on. Otherwise optional. The schema version of the user
This field is named either args2_6, for MongoDB versions 2.6 and higher (inclu
Optional. Objects that define the configuration of each replica set. The Automatio
Optional. Objects that define the configuration of each sharded cluster. Each obje
The name of the cluster. This must correspond with the value in processes.cl
String values that provide the names of each config server’s hosts. The host names
Objects that define the cluster’s shards.
The name of the shard.
The name of the shard’s replica set, as specified in the replicaSets._id field
Objects that define the sharded collections and their shard keys.
The mongoDbVersions array is required and defines versions of MongoDB use
The MongoDB version.
Examples
For configuration examples, please see the following page on GitHub: https://github.com/10gen-labs/mms-apiexamples/tree/master/automation/.
161
Automation Status
Overview
The Public API provides the automationStatus endpoint to let you see whether each MongoDB process is upto-date with the current automation configuration. The endpoint returns the goalVersion field to report the current
version of the automation configuration and the lastGoalVersionAchieved fields to report the versions of the
configuration running on each server.
Operation
• GET /api/public/v1.0/groups/GROUP-ID/automationStatus
Retrieve the status of each MongoDB process in the deployment.
Sample Entity
"goalVersion": 29,
"processes": [
{
"hostname": "AGENT_HOST_0",
"name": "BLUE_0",
"lastGoalVersionAchieved": 28,
"plan": ["Download", "Start", "WaitRsInit"]
},
{
"hostname": "AGENT_HOST_1",
"name": "BLUE_1",
"lastGoalVersionAchieved": 29,
"plan": []
}
]
Entity Fields
Name
goalVersion
processes
- hostname
- name
- lastGoalVersionAchieved
- plan
162
Type
integer
array
string
Description
The version of the most recently submitted automation configuration. If there is a conflict
in submissions of automation configurations, this field lists the winning configuration.
The group’s deployed MongoDB instances.
The fully qualified domain name (retrieved by issuing hostname -f) of the server on
which the MongoDB process and Automation Agent are hosted.
string The process name as specified in the automation configuration.
inThe last version of the automation configuration with which this process had deployed as
teconfigured. If the lastGoalVersionAchieved number is not equal to the
ger goalVersion number, the process has not yet deployed according to the current
configuration.
arDescribes how a process that is not yet up-to-date with the configuration will achieve the
ray goal state.
Example
Retrieve status:
curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/533c5895b910306
Response:
{
"processes": [
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_myShard_0_0",
"hostname": "testDeploy-0"
},
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_myShard_0_1",
"hostname": "testDeploy-1"
},
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_myShard_0_2",
"hostname": "testDeploy-2"
},
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_myShard_1_3",
"hostname": "testDeploy-3"
},
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_myShard_1_4",
"hostname": "testDeploy-4"
},
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_myShard_1_5",
"hostname": "testDeploy-5"
},
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_config_6",
"hostname": "testDeploy-6"
},
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_config_7",
"hostname": "testDeploy-7"
},
{
163
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_config_8",
"hostname": "testDeploy-8"
},
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "shardedCluster_mongos_9",
"hostname": "testDeploy-9"
}
],
"goalVersion": 2
}
7.3 Public API Tutorials
Enable the Public API Enable the Public API for group.
Deploy a Sharded Cluster Create a cluster using the Public API.
Upgrade a Deployment’s MongoDB Version Upgrade the version of MongoDB used by the deployment’s instances.
Enable the Public API
Overview
You enable the Public API on a per-group basis. To enable the Public API for a group, you must have the Owner or
Global Owner role.
Considerations
You can have up to ten keys associated to your account. Each key can be either enabled or disabled, but be aware that
they both count towards the ten key limit.
API Keys are associated to a user and therefore have the same level of access as that user.
Procedure
Step 1: Enable the Public API for each group. The Public API is enabled on a per-group basis, so make sure to
enable it for all groups that need to use it.
To enable the Public API for a group, select the Administration tab and then select Group Settings. Click the Enable
Public API button to toggle it ON.
Step 2: Generate an API key. An API Key is like a password. Keep it secret.
To generate a key, select the Administration tab and then API Keys & Whitelists. In the API Keys section, use the
Generate button to generate a new key. Follow the prompts, being sure to copy the key once it is generated. MMS
displays the full key one time only. MMS displays only the partial key in the key list and provides no access to the full
key.
164
Step 3: Define your whitelist. Certain API operations require a higher level of security and are protected by a
whitelist. Only client requests that originate from a whitelisted IP address will be permitted to invoke such operations.
To define your whitelist, select the Administration tab and then API Keys & Whitelists. In the API Whitelist section,
use the Add button to add a permitted IP address.
To delete an address, select the gear icon for the address and select Delete.
CIDR notation is not supported.
Additional Information
See the Public API Principles for a background on the use and operation of the Public API, and Public API Resources
for a complete reference of all resources available in the Public API.
Deploy a Cluster through the API
Overview
This tutorial manipulates the Public API’s automation configuration to deploy a sharded cluster that is owned by
another user. The tutorial first creates a new group, then a new user as owner of the group, and then a sharded cluster
owned by the new user. You can create a script to automate these procedures for use in routine operations.
To perform these steps, you must have access to MMS as a user with the Global Owner role.
The procedures install a cluster with two shards. Each shard comprises a three-member replica set. The tutorial
installs one mongos and three config servers. Each component of the cluster resides on its own server, requiring a
total of 10 servers.
The tutorial installs the Automation Agent on each server.
Prerequisites
MMS must have an existing user with Global Owner role. The first user you create has this role. Global owners can
perform any MMS action, both through the MMS interface and through the API.
Provision ten servers to host the components of the sharded cluster. For server requirements, see the Production Notes
in the MongoDB manual.
Each server must provide its Automation Agent with full networking access to the hostnames and ports of the Automation Agents on all the other servers. Each agent runs the command hostname -f to self-identify its hostname and
port and report them to MMS.
Tip
To ensure agents can reach each other, provision the servers using Automation. This installs the Automation Agents
with correct network access. Then use this tutorial to reinstall the Automation Agents on those machines.
Examples
As you work with the API, you can view examples on the following GitHub page: https://github.com/10gen-labs/mmsapi-examples/tree/master/automation/.
165
Procedures
Retrieve API Key This procedure displays the full API key just once. You must record the API key when it is
displayed.
Note that this API key for the Public API is different from the API key for a group, which is always visible in MMS
through the Group Settings tab.
Step 1: Log in as a Global Owner. Log into the MMS web interface as a user with the Global Owner role.
Step 2: Select the Administration tab and then API Keys & Whitelists.
Step 3: Generate a new API key.
Testing,” and click Generate.
In the API Keys section, click Generate. Then enter a description, such as “API
If prompted for a two-factor verification code, enter the code and click Verify. Then click Generate again.
Step 4: Copy and record the key. Copy the key immediately when it is generated. MMS displays the full key
one time only. You will not be able to view the full key again.
Record the key in a secure place. After you have successfully recorded the key, click Close.
Create the Group and the User through the API
Step 1: Use the API to create a group. Use the Public API to send a groups document to create the new group. Issue
the following command, replacing <[email protected]> with the credentials of the global owner, <api_key>
with your API key, <app-example.net> with the MMS URL, and <group_name> with the name of the new
group:
curl -u "<[email protected]>:<api_key>" -H "Content-Type: application/json" "http://<app-example.net>/
{
"name": "<group_name>"
}'
The API returns a document that includes the group’s agentApiKey and id. The API automatically sets the
publicApiEnabled field to true to allow subsequent API-based configuration.
Step 2: Record the values of agentApiKey and id in the returned document. Record these values for use in
this procedure and in other procedures in this tutorial.
Step 3: Use the API to create a user in the new group. Use the http://docs.mms.mongodb.com//users
endpoint to add a user to the new group.
The body of the request should contain a users document with the user’s information.
Set the user’s
roles.roleName to GROUP_OWNER, and the user’s roles.groupId set to the new group’s‘ id.
curl -u "<[email protected]>:<api_key>" -H "Content-Type: application/json" "http://<app-example.net>/
{
"username": "<[email protected]>",
"emailAddress": "<[email protected]>",
"firstName": "<First>",
"lastName": "<Last>",
166
"password": "<password>",
"roles": [{
"groupId": "<group_id>",
"roleName": "GROUP_OWNER"
}]
}'
Step 4: Remove global owner from the group. (Optional) The global owner that you used to create the group
is also automatically added to the group. You can remove the global owner from the group without losing the ability
to make changes to the group in the future. As long as you have the group’s agentApiKey and id, you have full
access to the group when logged in as the global owner.
GET the global owner’s ID. Issue the following command to request the group’s users, replace the credentials, API
key, URL, and group ID, with the relevant values:
curl -u "<[email protected]>:<api_key>" "http://<app-example.net>/api/public/v1.0/groups/<group_id>/us
The API returns a document that lists all the group’s users. Locate the user with roles.roleName set to
GLOBAL_OWNER. Copy the user’s id value, and issue the following to remove the user from the group, replacing
<user_id> with the user’s id value:
curl -u "<[email protected]>:<api_key>" "http://<app-example.net>/api/public/v1.0/groups/<group_id>/us
Upon successful removal of the user, the API returns the HTTP 200 OK status code to indicate the request has
succeeded.
Install the Automation Agent on each Provisioned Server
in the Prerequisites.
Your servers must have the networking access described
Step 1: Create the Automation Agent configuration file to be used on the servers. Create the following configuration file and enter values as shown below. The file uses your agentApiKey, group id, and the MMS URL.
Save this file as automation-agent.config. You will distribute this file to each of your provisioned servers.
# REQUIRED
# Enter your Group ID - It can be found at /settings
#
mmsGroupId=<Enter_the_value_you_retrieved_for_group_``id``>
# REQUIRED
# Enter your API key - It can be found at /settings
#
mmsApiKey=<Enter_the_value_you_retrieved_for_``agentApiKey``>
# Base url of the MMS web server.
#
mmsBaseUrl=<Enter_the_URL_of_the_|application|>
# Path to log file
#
logFile=/var/log/mongodb-mms-automation/automation-agent.log
# Path to backup automation configuration
#
mmsConfigBackup=/var/lib/mongodb-mms-automation/mms-cluster-config-backup.json
167
# Lowest log level to log.
#
logLevel=INFO
Can be (in order): DEBUG, ROUTINE, INFO, WARN, ERROR, DOOM
# Maximum number of rotated log files
#
maxLogFiles=10
# Maximum size in bytes of a log file (before rotating)
#
maxLogFileSize=268435456
# URL to proxy all HTTP requests through
#
#httpProxy=
Step 2: Retrieve the command strings used to download and install the Automation Agent. In the MMS web
interface, select the Administration tab and then select the Agents page. Under Automation at the bottom of the
page, select your operating system to display the install instructions. Copy and save the following strings from these
instructions:
• The curl string used to download the agent.
• The rpm or dpkg string to install the agent. For operating systems that use tar to unpackage the agent, no
install string is listed.
• The nohup string used run the agent.
Step 3: Download, configure, and run the Automation Agent on each server. Do the following on each of the
provisioned servers. You can create a script to use as a turn-key operation for these steps:
Use the curl string to download the Automation Agent.
Use rpm, dpkg, or tar to install the agent. Make the agent controllable by the new user you added to the group in
the previous procedure.
Replace the contents of the config file with the file you created in the first step. The config file is one of the following,
depending on the operating system:
• /etc/mongodb-mms/automation-agent.config
• <install_directory>/local.config
Check that the following directories exist and are accessible to the Automation Agent. If they do not, create them. The
first two are created automatically on RHEL, CentOS, SUSE, Amazon Linux, and Ubuntu:
• /var/lib/mongodb-mms-automation
• /var/log/mongodb-mms-automation
• /data
Use the nohup string to run the Automation Agent.
Step 4: Confirm the initial state of the automation configuration. When the Automation Agent first runs, it
downloads the mms-cluster-config-backup.json file, which describes the desired state of the automation
configuration.
168
On one of the servers,
navigate to /var/lib/mongodb-mms-automation/
mms-cluster-config-backup.json. Confirm that the file’s version field is set to 1.
matically increments this field as changes occur.
and open
MMS auto-
Deploy the New Cluster To add or update a deployment, retrieve the configuration document, make changes as
needed, and send the updated configuration though the API to MMS.
Tip
You can learn more about the configuration file by viewing it in MMS. Select the Deployment tab and then the Raw
AutomationConfig page. Note that the raw configuration contains fields you should not update with the configuration
document.
The following procedure deploys an updated automation configuration through the Public API:
Step 1: Retrieve the automation configuration from MMS. Use the automationConfig resource to retrieve the
configuration. Issue the following command, replacing <[email protected]> with the credentials of the global
owner, <api_key> with the previously retrieved API key, <app-example.net> with the URL of MMS, and
<group_id> with the previously retrieved group ID:
curl -u "<[email protected]>:<api_key>" "http://<app-example.net>/api/public/v1.0/groups/<group_id>/au
Confirm that the version field of the retrieved automation configuration matches the version field in the
mms-cluster-config-backup.json file.
Step 2: Create the top level of the new configuration document. Create a document with the following fields.
As you build the configuration document, refer the description of an automation configuration for detailed explanations of the settings. For examples, refer to the following page on GitHub: https://github.com/10gen-labs/mms-apiexamples/tree/master/automation/.
{
"options": {
"downloadBase": "/var/lib/mongodb-mms-automation"
},
"mongoDbVersions": [],
"monitoringVersions": [],
"backupVersions": [],
"processes": [],
"replicaSets": [],
"sharding": []
}
Step 3: Add MongoDB versions to the configuration document. In the mongoDbVersions array, add the
versions of MongoDB to have available to the deployment. Add only those versions you will use. For this tutorial, the
following array includes just one version, 2.4.12, but you can specify multiple versions. Using 2.4.12 allows this
deployment to later upgrade to 2.6, as described in Update the MongoDB Version of a Deployment.
"mongoDbVersions": [
{ "name": "2.4.12" }
]
169
Step
4:
Add
the
Monitoring
Agent
to
the
configuration
document. In
the
monitoringVersions.hostname field, enter the hostname of the server where MMS should install the
Monitoring Agent. Use the fully qualified domain name that running hostname -f on the server returns, as in the
following:
"monitoringVersions": [
{
"hostname": "<server_x.example.net>",
"logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log",
"logRotate": {
"sizeThresholdMB": 1000,
"timeThresholdHrs": 24
}
}
]
This configuration example also includes the logPath field, which specifies the log location, and logRotate,
which specifies the log thresholds.
Step 5: Add the servers to the configuration document. This sharded cluster has 10 MongoDB instances, as
described in the Overview, each running on its own server. Thus, the automation configuration’s processes array
will have 10 documents, one for each MongoDB instance.
The following example adds the first document to the processes array. Replace <process_name_1> with any
name you choose, and replace <server_1.example.net> with the FQDN of the server. You will need to add 9
documents: one for each MongoDB instance in your sharded cluster.
The example uses the args2_4 syntax for the processes.<args> field. For MongoDB versions 2.6 and later,
use the args2_6 syntax. See Supported MongoDB Options for Automation for more information.
"processes": [
{
"version": "2.4.12",
"name": "<process_name_1>",
"hostname": "<server_1.example.net>",
"logRotate": {
"sizeThresholdMB": 1000,
"timeThresholdHrs": 24
},
"authSchemaVersion": 1,
"processType": "mongod",
"args2_4": {
"port": 27017,
"replSet": "rs1",
"dbpath": "/data/",
"logpath": "/data/mongodb.log"
}
},
...
]
Step 6: Add the sharded cluster topology to the configuration document. Add two replica set documents to the
replicaSets array. Add three members to each document. The following example shows one replica set member
added in the first replica set document:
"replicaSets": [
{
170
"_id": "rs1",
"members": [
{
"_id": 0,
"host": "<process_name_1>",
"priority": 1,
"votes": 1,
"slaveDelay": 0,
"hidden": false,
"arbiterOnly": false
},
...
]
},
...
In the sharding array, add the replica sets to the shards, and add the three config servers, as in the following:
"sharding": [
{
"shards": [
{
"tags": [],
"_id": "shard1",
"rs": "rs1"
},
{
"tags": [],
"_id": "shard2",
"rs": "rs2"
}
],
"name": "sharded_cluster_via_api",
"configServer": [
"<process_name_7>",
"<process_name_8>",
"<process_name_9>"
],
"collections": []
}
]
Step 7: Send the configuration document. Use the groups/<group_id>/automationConfig endpoint to
to send the automation configuration document to MMS, as in the following. Replace <[email protected]> with
the credentials of the global owner, <api_key> with previously retrieved API key, <app-example.net> with
the MMS URL, and <group_id> with the previously retrieved group id.
Replace <configuration_document> with the configuration document you have created in the previous steps.
curl -u "<[email protected]>:<api_key>" -H "Content-Type: application/json" "http://<app-example.net>/
<configuration_document>
'
Upon successful update of the configuration, the API returns the HTTP/1.1 200 OK status code to indicate the
request has succeeded.
171
Step 8: Confirm successful update of the automation configuration. Retrieve the automation configuration to
compare it against the document you sent. In particular, confirm that the version field equals 2.
Issue a command similar to the following. Replace the credentials, API key, <app-example.net> URL, and group
id as in previous steps.
curl -u "<[email protected]>:<api_key>" "http://<app-example.net>/api/public/v1.0/groups/<group_id>/au
Step 9: Check the deployment status to ensure goal state is reached. Use the automationStatus resource to
retrieve the deployment status. Issue the following command, replacing the credentials, API key, URL, and group id
as in previous steps.
curl -u "<[email protected]>:<api_key>" "http://<app-example.net>/api/public/v1.0/groups/<group_id>/au
The command returns the processes array and the goalVersion field. The processes array contains a
document for each server that is to run a MongoDB instance, similar to the following:
{
"plan": [],
"lastGoalVersionAchieved": 2,
"name": "<process_name_1>",
"hostname": "<server_1.example.net>",
}
If any document has a lastGoalVersionAchieved field equal to 1, the configuration is in the process of deploying. The document’s plan field displays the remaining work. Wait several seconds and issue the curl command
again.
When all lastGoalVersionAchieved fields equal the value specified in the goalVersion field, the new
configuration has successfully deployed.
To view the new configuration in the MMS web interface, select the Deployment tab and then the Deployment page.
Next Steps
To make an additional version of MongoDB available in the cluster, follow the steps in Update the MongoDB Version
of a Deployment.
Update the MongoDB Version of a Deployment
Overview
This tutorial describes how to use the API to migrate a MongoDB deployment to a new version of MongoDB. These
steps assume you have an existing deployment that uses a 2.4.x version of MongoDB, as would be the case if you
used the tutorial to Deploy a Cluster through the API, that you will migrate to a 2.6 or later deployment.
Beginning with version 2.6, MongoDB implemented a new format for MongoDB configuration options. These steps
describe how to modify an existing 2.4 sharded cluster to conform to the 2.6 configuration format.
Consideration
The API supports the MongoDB options listed on the Supported MongoDB Options for Automation page.
172
Prerequisite
You must have credentials to access MMS as a user with the Global Owner role.
Procedure
Step 1: Retrieve the automation configuration from the |application|. Use the automationConfig resource to
retrieve the configuration. Issue the following command, replacing <[email protected]> with the credentials
of the global owner, <api_key> with the previously retrieved API key, <app-example.net> with the URL of
MMS, and <group_id> with the previously retrieved group ID:
curl -u "<[email protected]>:<api_key>" "http://<app-example.net>/api/public/v1.0/groups/<group_id>/au
Confirm that the version field of the retrieved automation configuration matches the version field in the
mms-cluster-config-backup.json file.
Step 2: Open the configuration document for editing. As you edit the configuration document in the next steps,
reference the description of an automation configuration for detailed descriptions of settings.
Step 3:
Add the new MongoDB version number to the configuration document. Update the
mongoDbVersions array to include {"name": "2.6.7"}:
"mongoDbVersions": [
{"name": "2.4.12"},
{"name": "2.6.7"}
]
Step 4: Update the MongoDB configuration options to the 2.6 syntax. Update each document in the
processes array as follows.
Update the processes.version field to specify 2.6.7:
"version": "2.6.7"
Change the processes.args2_4 field to processes.args2_6:
"args2_6": {
Edit the options in the processes.args2_6 field to conform with the MongoDB 2.6 structure described in Configuration File Options in the MongoDB manual. For example:
"args2_6": {
"net": {
"port": 27017
},
"storage": {
"dbPath": "/data/"
},
"systemLog": {
"path": "/data/mongodb.log",
"destination": "file"
},
"replication": {
"replSetName": "rs1"
},
173
"operationProfiling": {}
}
Step 5: Send the configuration document. Use the automationConfig resource to send the updated automation
configuration.
Issue the following command, replacing <[email protected]> with the credentials of the global owner,
<api_key> with the API key, <app-example.net> with the MMS URL, and <group_id> with the group
id. Replace <configuration_document> with the entire updated configuration document.
curl -u "<[email protected]>:<api_key>" -H "Content-Type: application/json" "http://<app-example.net>/
<configuration_document>
'
Upon successful update of the configuration, the API returns the HTTP 200 OK status code to indicate the request
has succeeded.
Step 6: Confirm successful update of the automation configuration. Retrieve the automation configuration from
MMS to compare it against the document you sent. Issue a command similar to the following. Replace the credentials,
API key, URL, and group id as in the previous step.
curl -u "<[email protected]>:<api_key>" "http://<app-example.net>/api/public/v1.0/groups/<group_id>/au
Step 7: Check the deployment status to ensure goal state is reached. Use the automationStatus resource to
retrieve the deployment status. Issue the following command, replacing the credentials, API key, URL, and group id
as in previous steps.
curl -u "<[email protected]>:<api_key>" "http://<app-example.net>/api/public/v1.0/groups/<group_id>/au
Confirm that the values of all the lastGoalVersionAchieved fields in the processes array match the
goalVersion field. For more information on deployment status, see Automation Status.
To view the new configuration in the MMS web interface, select the Deployment tab and then the Deployment page.
8 Troubleshooting
This document provides advice for troubleshooting problems with MMS.
8.1 Getting Started Checklist
To begin troubleshooting, complete these tasks to check for common, easily fixed problems:
1. Authentication Errors
2. Check Agent Output or Log
3. Confirm Only One Agent is Actively Monitoring
4. Ensure Connectivity Between Agent and Monitored Hosts
5. Ensure Connectivity Between Agent and MMS Server
6. Allow Agent to Discover Hosts and Collect Initial Data
174
Authentication Errors
If your MongoDB instances run with authentication enabled, ensure MMS has these credentials. For new hosts, click
the Add Host button on the Deployment page then specify credentials for every host with authentication enabled. For
hosts already listed in MMS, click the gear icon to the right of a host name on the Deployment page then select Edit
Host to provide credentials.
Please consult the Authentication Requirements documentation for details about how to use authentication.
Check Agent Output or Log
If you continue to encounter problems, check the agent’s output for errors. See Agent Logs for more information.
Confirm Only One Agent is Actively Monitoring
If you run multiple Monitoring Agents, make sure they are all the same version and that only one if actively monitoring.
When you upgrade a Monitoring Agent, do not forget to delete any old standby agents.
When you run multiple agents, one runs as the primary agent and the others as standby agents. Standby agents poll
MMS periodically to get the configuration but do not send data.
To determine which agent is the primary agent, look at the Status value on the Administration tab’s Agents page. If
there is no last ping value for a listed agent, the agent is a standby agent.
See Monitoring FAQs and Add Existing MongoDB Processes to Monitoring for more information.
Ensure Connectivity Between Agent and Monitored Hosts
Ensure the system running the agent can resolve and connect to the MongoDB instances. To confirm, log into the
system where the agent is running and issue a command in the following form:
mongo [hostname]:[port]
Replace [hostname] with the hostname and [port] with the port that the database is listening on.
Ensure Connectivity Between Agent and MMS Server
Verify that the Monitoring Agent can connect on TCP port 443 (outbound) to the MMS server (i.e.
“mms.mongodb.com”.)
Allow Agent to Discover Hosts and Collect Initial Data
Allow the agent to run for 5-10 minutes to allow host discovery and initial data collection.
8.2 Monitoring
Alerts
For information on creating and managing alerts, see Create an Alert Configuration and Manage Alerts.
175
Cannot Turn Off Email Notifications
There are at least two ways to turn off alert notifications:
• Remove the deployment from your MMS account. See Remove Processes from Monitoring.
• Disable or delete the alert in MMS. Click the Activity tab then click Alert Settings. To the right of an alert, select
the gear icon and select Disable or Delete.
Receive Duplicate Alerts
If the notification email list contains multiple email-groups, one or more people may receive multiple notifications of
the same alert.
Receive “Host has low open file limits” or “Too many open files” error messages
These error messages appear on the Deployment page, under a host’s name. They appear if the number of available
connections does not meet an MMS-defined minimum value. These errors are not generated by the mongos instance
and, therefore, will not appear in mongos log files.
On a host by host basis, the Monitoring Agent compares the number of open file descriptors and connections to the
maximum connections limit. The max open file descriptors ulimit parameter directly affects the number of available
server connections. The agent calculates whether or not enough connections exist to meet an MMS-defined minimum
value.
In ping documents, for each node and its serverStatus.connections values, if the sum of the current value
plus the available value is less than the maxConns configuration value set for a monitored host, the Monitoring
Agent will send a Host has low open file limits or Too many open files message to MMS.
Ping documents are data sent by Monitoring Agents to MMS. To view ping documents, click the Deployment page,
then click the host’s name, and then click Last Ping.
To prevent this error, we recommend you set ulimit open files to 64000. We also recommend setting the maxConns
command in the mongo shell to at least the recommended settings.
See the MongoDB ulimit reference page and the the MongoDB maxConns reference page for details.
Deployments
Deployment Hangs in In Progress
If you have added or restarted a deployment and the deployment remains in the In Progress state for several
minutes, click View Agent Logs and look for any errors.
If you diagnose an error and need to correct the deployment configuration:
1. Click Edit Configuration and then click Edit Configuration again.
2. Reconfigure the deployment.
3. When you complete your changes, click Review & Deploy and then Confirm & Deploy.
If you shut down the deployment and still cannot find a solution, unmanage the deployment.
176
Groups
Cannot Delete a Group
Please contact MMS support to remove a company or group from your MMS account.
Additional Information on Groups
Create a group to monitor additional segregated systems or environments for servers, agents, users, and other resources.
For example, your deployment might have two or more environments separated by firewalls. In this case, you would
need two or more separate MMS groups.
API and shared secret keys are unique to each group. Each group requires its own agent with the appropriate API and
shared secret keys. Within each group, the agent needs to be able to connect to all hosts it monitors in the group.
For information on creating and managing groups, see Manage Groups.
Munin
Install and configure the munin-node daemon on the monitored MongoDB server(s) before starting MMS monitoring. The MMS agent README file provides guidelines to install munin-node. However, new versions of
Linux, specifically Red Hat Linux (RHEL) 6, can generate error messages. See Configure Hardware Monitoring with
munin-node for details about monitoring hardware with munin-node.
Restart munin-node after creating links for changes to take effect.
“No package munin-node is available” Error
To correct this error, install the most current version of the Linux repos. Type these commands:
sudo yum install http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
Then type this command to install munin-node and all dependencies:
sudo yum install munin-node
Non-localhost IP Addresses are Blocked
By default,
munin blocks incoming connections from non-localhost IP addresses.
The
/var/log/munin/munin-node.log file will display a “Denying connection” error for your non-localhost IP
address.
To fix this error, open the munin-node.conf configuration file and comment out these two lines:
allow ^127\.0\.0\.1$
allow ^::1$
Then add this line to the munin-node.conf configuration file with a pattern that matches your subnet:
cidr_allow 0.0.0.0/0
Restart munin-node after editing the configuration file for changes to take effect.
177
Verifying iostat and Other Plugins/Services Returns “# Unknown service” Error
The first step is to confirm there is a problem. Open a telnet session and connect to iostat, iostat_ios, and
cpu:
telnet HOSTNAME 4949 <default/required munin port>
fetch iostat
fetch iostat_ios
fetch cpu
The iostat_ios plugin creates the iotime chart, and the cpu plugin creates the cputime chart.
If any of these telnet fetch commands returns an “# Unknown Service” error, create a link to the plugin or service
in /etc/munin/plugins/ by typing these commands:
cd /etc/munin/plugins/
sudo ln -s /usr/share/munin/plugins/<service> <service>
Replace <service> with the name of the service that generates the error.
Disk names are not listed by Munin
In some cases, Munin will omit disk names with a dash between the name and a numerical prefix, for example, dm-0
or dm-1. There is a documented fix for Munin’s iostat plugin.
8.3 Authentication
Two-Factor Authentication
Missed SMS Authentication Tokens
Unfortunately SMS is not a 100% reliable delivery mechanism for messages, especially across international borders.
The Google authentication option is 100% reliable. Unless you must use SMS for authentication, use the Google
Authenticator application for two-factor authentication.
If you do not receive the SMS authentication tokens:
1. Refer to the Administration page for more details about using two-factor authentication. This page includes any
limitations which may affect SMS delivery times.
2. Enter the SMS phone number with country code first followed by the area code and the phone number. Also try
011 first followed by the country code, then area code, and then the phone number.
If you do not receive the authentication token in a reasonable amount of time contact |mms| Support to rule out SMS
message delivery delays.
How to Delete or Reset Two-Factor Authentication
Contact |mms| Support to delete or reset any two-factor authentications you have configured.
Using MMS Provisioning (Amazon Web Services)
See Prerequisites.
178
All Deployments
Networking
All hosts must be able to allow communication between MongoDB ports. The default is 27017, but you can configure
alternate port ranges in the MMS interface.
The Automation Agent must be able to connect to mms.mongodb.com on port 443 (i.e. https). For more
information on access to ports and IP addresses, see Security.
Directory and File Permissions
The Automation Agent directories and files require the permissions describe here. Paths and filenames vary depending
on the operating system.
• Automation Agent Directory
The agent directory and the agent configuration file require Read and Execute permissions for the user that runs
the Automation Agent.
On RHEL, CentOS, Amazon Linux, & Ubuntu, the agent directory is /etc/mongodb-mms. The agent stores
its configuration in the automation-agent.config file in that directory:
On other Linux systems and on OS X, you will define the agent directory during installation. The agent stores
its configuration in the local.config file in that directory.
• Supporting Files
Supporting files include the Monitoring and Backup Agents, the MongoDB binaries, and a backup copy of
the JSON-based automation configuration file. The directory that stores these requires Read, Write, and
Execute permissions for the user that runs the Automation Agent. The agent requires write permissions are
so that the agent can write to the automation configuration file.
On RHEL, CentOS, Amazon Linux, & Ubuntu, Automation stores these in the same directory as the Automation
Agent.
On other Linux operating systems and on
/var/lib/mongodb-mms-automation directory.
OS
X,
Automation
stores
these
in
the
• Log File
The log file requires Write permission for the user that runs the Automation Agent. By default, the agent logs
events in the following log file:
/var/log/mongodb-mms-automation/automation-agent.log
The Automation Agent’s configuration file specifies the location of the log file, as well as the log level and
log-rotation settings.
Automation Configuration
After completing the automation configuration, always ensure that the deployment plan satisfies the needs of your
deployment. Always double check hostnames and ports before confirming the deployment.
179
Sizing
• Ensure that you provision machines with enough space to run MongoDB and support the requirements of your
data set.
• Ensure that you provision sufficient machines to run your deployment. Each mongod should run on its own
host.
Operating System
The Automation Agent only supports Linux and OS X hosts. The Automation Agent does not support Windows.
8.4 Automation Checklist
MMS Automation allows you to deploy, configure, and manage MongoDB deployments with the MMS UI. MMS Automation relies on an Automation Agent, which must be installed on every server in the deployment. The Automation
Agents periodically poll the MMS service to determine the current goal, and continually report their status to MMS.
There are two ways to install the Automation Agent on your servers. First, you can simply install the Automation
Agent on all existing hardware. Second, you can use MMS Provisioning to automatically create Amazon Web Services
(AWS) EC2 instances that have the Automation Agent pre-installed.
Using Own Hardware
• If you deploy Automation manually, ensure that you have one Automation Agent on every server.
• If you deploy the agent manually, you must create MongoDB’s dbpath and the directory for the MongoDB
binaries and ensure that the user running the agent has Write permissions on these directories.
If you install using the rpm or deb packages, the Automation Agent runs as the mongod user. If you install
using the tar.gz you can run the agent as any user.
9 Frequently Asked Questions
This document addresses common questions about MMS and its use.
9.1 Management FAQs
Can MMS Manage an Existing MongoDB Deployment?
Yes. See Import an Existing MongoDB Deployment.
How does MMS Manage MongoDB deployments?
After you provision servers in MMS or deploy the Automation Agent in the environment of the MongoDB deployment,
each agent periodically communicates with MMS and performs any required the work.
Agents constantly reassess their environment to adapt their work as necessary. If an agent encounters an issue, such as
network connectivity problems, MMS failure, or server failure, the agents adjust their work to compensate and safely
arrive at their goal state.
180
Agents create plans to move from their current state to a goal state. Plans execute in steps, where each step is autonomous and independent of other steps.
For example, for an installation, the plan involves downloading MongoDB, starting the process with the appropriate
command line options, initializing the replica set, waiting for a healthy majority. The configuration reaches goal state
when the replica set is active and has a healthy majority.
What versions of MongoDB can MMS Manage?
Automation supports all versions of MongoDB after 2.4.
How many Automation Agents do I need?
To use Automation, you must have an agent running on every host where a managed MongoDB instance runs.
Is any MongoDB data transferred by the Automation Agent?
Agents do not transmit any data from a MongoDB deployment. The agents only communicate deployment configuration information.
Will MMS handle failures during an upgrade, such as MMS going down or a network partition?
Generally speaking, yes. The design of the management and automation componets of MMS do not account for all
possible failures; however the architecture of the system can work around many types of failures.
What types of deployment can I create in MMS?
You can configure all MongoDB deployment types, including standalones, replica sets, and sharded clusters. You can
also configure replica set-member types, such as arbiter, hidden, and delayed secondary, and can configure replica set
options, such as priority level.
Can I deploy MongoDB to a cloud provider with MMS?
You can deploy MongoDB to Amazon Web Services (AWS). For more information, see Configure AWS Integration.
How does an AWS security group affect access to MongoDB instances?
The AWS security group affects whether MongoDB instances can communicate with each other within the deployment
and affects access to the deployment from MongoDB clients, such as the mongo shell or a driver. At minimum the
security group must have the inbound rules described in the Security Group section of this manual.
9.2 Monitoring FAQs
Host Configuration
How do I add a new host or server?
See Add Existing MongoDB Processes to Monitoring.
181
Can I monitor Kerberos-enabled instances?
Yes.
MMS Monitoring does support monitoring for Kerberos-enabled MongoDB instances.
See
http://docs.mms.mongodb.com//tutorial/connect-to-hosts-with-kerberos-authentication
for more information.
How does MMS gather database statistics?
In most instances, MMS Monitoring will scale its request cycle to limit more expensive statistics gathering. The
DB Stats information updates every 10 minutes, and the agent will throttle the frequency to reduce the impact on
the database. 1 Even so, the “DB stats” operation impacts the performance of your database, as is possible when
installations have a large number of databases and collections.
If the collection of database statistics impacts database performance, disable database stats collection before starting
your agent. Select the Administration tab, then the Group Settings page, and then set Collect Database Specific
Statistics to NO.
MMS Monitoring Agent
Do I need a Monitoring Agent for every MongoDB Instance?
No. A single Monitoring Agent can connect to all MongoDB databases in your MMS group. Unless you have multiple
groups, complete your initial Monitoring Agent setup with a single agent.
For redundancy, you may wish to run a second Monitoring Agent. See the Monitoring Agent Redundancy for more
information.
Can I use two Monitoring Agents to connect MongoDBs in different data centers?
No, not within the same group. The group’s Monitoring Agent must connect to every server in the MongoDB deployment. Configure firewalls to allow the Monitoring Agent to connect across data centers and servers.
Use multiple Monitoring Agents within a single MMS group only to provide redundancy. For each MMS group, the
agent must be able to connect to every monitored MongoDB. Unless you have multiple groups, complete your initial
Monitoring Agent setup with a single agent.
What happens if a Monitoring Agent becomes unavailable? How can I ensure my MongoDBs are always monitored?
You can run multiple Monitoring Agents. If one Monitoring Agent fails, another starts monitoring. As long as at least
one Monitoring Agent is available, MMS will not trigger a Monitoring Agent Down alert. To run multiple Monitoring
Agents, see Monitoring Agent Redundancy.
You also can create an alert to notify you when an agent is down. In MMS, click the Activity tab and then Alert
Settings. Click the Add Alert button then set the alert through the fields in the Create a New Alert window.
1
DB Stats will not appear until 30 minutes after you add the host to MMS Monitoring
182
Where should I run the Monitoring Agent?
The amount of resources the Monitoring Agent requires varies depending on infrastructure size, the number of servers
and the databases it’s monitoring. Run the agent on an existing machine with additional capacity that does not run a
mongod instance. You may also run the Monitoring Agent on a smaller dedicated instance.
The Monitoring Agent load scales with the number of monitored mongod plus mongos processes and the number of
databases in your MongoDB environment.
Never install the Monitoring Agent on the same server as a data bearing mongod instance. This will allow you to perform maintenance on a the mongod and its host without affecting the monitoring for your deployment. Additionally
a Monitoring Agent may contend for resources with the mongod
You can install the Monitoring Agent on the same system as an arbiter, a mongos, or an application server depending
on the requirements of these services and available resources.
Can I run the Monitoring Agent on an AWS micro server?
If you monitor five or fewer mongod instances, you can use a AWS micro server.
Why can’t the Monitoring Agent connect to my host?
The most common problem is that the agent is unable to resolve the hostname of the server. Check DNS and the
/etc/hosts file.
The second most common problem is that there are firewall rules in place that prohibit access to the server from the
agent.
To test the connection, login to the server running the agent and run: mongo hostname:port/test If you are
unable to connect, the agent will not be able to connect.
In addition, MMS Monitoring supports monitoring for Kerberos-enabled instances.
Why does the Monitoring Agent connect with hostnames instead of IP addresses?
By default, the Monitoring Agent tries to connect by resolving hostnames. If the agent cannot connect by resolving a
hostname, you can force the Monitoring Agent to prefer an IP address over its corresponding hostname for a specific
IP address.
To create a preferred hostname, select the Administration tab, then the Group Settings page, and then click the Add
button for the Preferred Hostnames setting. If your IP addresses have a common prefix, create a preferred hostname
with the ends-with button or click the regexp button to use a regular expression.
Preferred hostnames also allow you to specify the hostname to use for servers with multiple aliases. This prevents
servers from appearing multiple times under different names in the MMS interface.
How do I download the Monitoring Agent?
You can update the Monitoring Agent from the Agents page on the MMS Administration tab.
How do I setup and configure the agent?
See the README file included in the agent download.
183
Can I run the Backup and Monitoring Agents on a Single System?
There is no technical restriction that prevents the Backup Agent and the Monitoring Agent from running on a single
system or host. However, both agents have resource requirements, and running both on a single system can affect the
ability of these agents support your deployment in MMS.
The resources required by the Backup Agent depend on rate and size of new oplog entries (i.e. total oplog gigabyte/perhour produced.) The resources required by the Monitoring Agent depend on the number of monitored mongod
instances and the total number of databases provided by the mongod instances.
How do I delete a Monitoring Agent from MMS?
Monitoring Agents report their status to the MMS. When an agent does not report for more than 24 hours, the agent
no longer appears in MMS.
For more details, see Remove Monitoring Agents from MMS.
Can I run the MMS Monitoring Agent with On-Prem MMS Backup?
Yes. Both the MMS Monitoring Service and On-Prem MMS Backup can operate in the same environment. You will
need to install and configure two separate Monitoring Agents: configure one agent for the On-Prem MMS environment
and the other for the MMS Service.
Data Presentation
What are all those vertical bars in my charts?
A red bar indicates a server restart.
A orange bar indicates the server is now a primary.
A brown bar indicates the server is now a secondary.
Why is my Monitoring Agent highlighted in red?
Your agent is out of date.
You can update the Monitoring Agent from the Agents page on the MMS Administration tab.
Data Retention
What is the data retention policy for MMS?
MMS retains two distinct types of data: metrics, which describe usage; and snapshots, which back up your data.
Data-retention policies, as defined in the Terms of Service, are always subject to change.
As of this writing, MMS preserves:
• Minute-level metrics for 48 hours.
• Hourly metrics for 94 days.
• Snapshots according to their schedule. See the FAQ on snapshot retention policy.
184
9.3 Backup FAQs
MMS Backup creates backups of MongoDB replica sets and sharded clusters. After an initial sync to MongoDB’s
datacenters, MMS Backup tails the operation log (oplog) to provide a continuous backup with point-in-time recovery
of replica sets and consistent snapshots of sharded clusters. For more information, please review these frequently
asked questions or create an MMS Backup account.
Requirements
What version of MongoDB does MMS Backup require?
To back up a sharded cluster, MMS Backup requires version 2.4.3 or later.
To back up a replica set, MMS Backup requires version 2.2 or later.
What MongoDB permissions does the Backup Agent require?
If you are backing up a MongoDB instance that has authentication enabled, the Backup Agent requires elevated
privileges, as described in Required Access for Backup Agent.
See also:
User Privilege Roles in MongoDB.
Are there any limits to the types of deployments MMS Backup supports?
Yes. MMS Backup does not currently support standalone deployments. MMS Backup has full support for replica sets
and sharded clusters.
Why doesn’t MMS Backup support standalone deployments?
After an initial sync of your data to MMS, MMS Backup copies data from the oplog to provide a continuous backup
with point-in-time recovery. MMS Backup does not support standalone servers, which do not have an oplog. To
support backup with a single mongod instance, you can run a one-member replica set.
See also:
Convert a Standalone to a Replica Set.
How Does MMS Measure Data Size?
MMS uses the following conversions to measure snapshot size and to measure how much oplog data has been processed:
• 1 MB = 10242 bytes
• 1 GB = 10243 bytes
• 1 TB = 10244 bytes
185
Interface
How can I verify that I’m running the latest version of the Backup Agent?
If your Backup Agent is out of date, it will be highlighted in red on the Agents page of the Administration tab.
Why is my Backup Agent highlighted in red?
If your agent is highlighted in red on the Agents page of the Administration tab, your agent is out of date. For
instructions on updating the agent, see Install Backup Agent.
Operations
How does MMS Backup work?
You install the Backup Agent on a server in the same deployment with your MongoDB infrastructure. The agent
conducts an initial sync of your data to MMS. After the initial sync, the agent tails the oplog to provide a continuous
backup of your deployment.
Where should I run the Backup Agent?
The Backup Agent can run anywhere in your infrastructure that has access to your mongod instances. To avoid
contention for network and CPU resources, do not run the Backup Agent on the same hosts that provide your mongod
instances.
The Backup Agent has the same performance profile impact as a secondary. For the initial backup, the load scales
with the size of your data set. Once an initial backup exists, the load scales with oplog gigabytes used per hour.
Can I run the Backup and Monitoring Agents on a Single System?
There is no technical restriction that prevents the Backup Agent and the Monitoring Agent from running on a single
system or host. However, both agents have resource requirements, and running both on a single system can affect the
ability of these agents support your deployment in MMS.
The resources required by the Backup Agent depend on rate and size of new oplog entries (i.e. total oplog gigabyte/perhour produced.) The resources required by the Monitoring Agent depend on the number of monitored mongod
instances and the total number of databases provided by the mongod instances.
Can I run multiple Backup Agents to achieve high availability?
You can run multiple Backup Agents for high availability. If you do, the Backup Agents must run on different hosts.
When you run multiple Backup Agents, only one agent per group or environment is the primary agent. The primary
agent performs the backups. The remaining agents are completely idle, except to log their status as standbys and to
periodically ask MMS whether they should become the primary.
Does the Backup Agent modify my database?
The Backup Agent writes a small token into the oplog of the source database every hour. These tokens provide a
heartbeat for MMS Backup and have no effect on the source deployment. Each token is less than 100 bytes.
186
Will the MongoDB Backup Service impact my production databases?
MMS Backup will typically have minimal impact on production MongoDB deployments. This impact will be similar
to that of adding a new secondary to a replica set.
By default, the Backup Agent will perform its initial sync, the most resource intensive operation for MMS Backup,
against a secondary member of the replica set to limit its impact. You may optionally configure the Backup Agent
to perform the initial sync against the replica set’s primary, although this will increase the impact of the initial sync
operation.
Is my data safe?
Yes, MMS uses enterprise-grade hardware co-located in secure data centers to store all user data. The Backup Agent
transmits all data using SSL. The data is not encrypted at rest. MMS Backup requires two-factor authentication to
provide any data for restores.
Is there a limit to Backup size?
MMS Backup works optimally for deployments in which each replica set has a data size of less than 2 TB. Within a
sharded cluster, this means that MMS Backup is optimized for clusters where each shard has a data size of less than 2
TB.
There is currently no limit on the total size of snapshot storage.
If you wish to use MMS Backup for a larger deployment, please contact us for more information.
What is the load on the database during the initial Backup sync?
The impact of the initial backup synchronization should be similar to syncing a new secondary replica set member.
The Backup Agent does not throttle its activity, and attempts to perform the sync as quickly as possible.
Can I backup my standalone deployment?
No. MMS Backup does not currently support standalone deployments. To convert to a replica set, consult MongoDB’s
replication documentation.
How do I perform maintenance on a Replica Set with Backup enabled?
Most operations in a replica set are replicated via the oplog and are thus captured by the backup process. Some
operations, however, make changes that are not replicated: for these operations you must have the Backup service
resync from your current replica set to include the changes.
The following operations are not replicated and therefore require resync:
• Renaming or deleting a database by deleting the data files in the data directory. As an alternative, remove
databases using an operation that MongoDB will replicate, such as db.dropDatabase() from the mongo
shell.
• Changing any data while the instance is running as a standalone.
• Using compact or repairDatabase to reclaim a significant amount of space. This is not strictly necessary
but will ensure that the MMS copy of the data is resized, which means quicker restores and lower costs.
187
See also:
Maintenance Operations for Replica Set Members.
Does the Backup Agent Support SSL?
The Backup Agent always connects to the MMS servers using an SSL (HTTPS) connection.
The Backup Agent can connect to replica sets and shared clusters configured with SSL. See the Configure Backup
Agent for SSL documentation for more information.
How Do I Delete a Backup Snapshot?
You can delete replica set backup snapshots and snapshots for replica sets in a sharded cluster set if the snapshots are
not needed for point-in-time restores. See Delete Snapshots for Replica Sets and Sharded Clusters for details.
Configuration
What are “excluded namespaces”?
Excluded namespaces are databases and collections that MMS will not back up. This is useful for large databases or
collections that contain data that you will not need to restore: caches and logs, for example.
How can I prevent MMS Backup from backing up a collection?
MMS Backup allows you to specify “excluded namespaces”, which are collections or databases that you do not want
MMS to back up.
You can specify the namespaces to exclude when you initially enable backup on a replica set or sharded cluster, or can
edit the list at any time by selecting the “gear icon” in the Sharded Cluster Status or Replcia Set Status tables in MMS.
How can I change which namespaces are on the “excluded namespaces” list?
Click on the “gear icon” next to the name of the replica set or sharded cluster whose excluded namespaces you want
to modify in the Sharded Cluster Status or Replcia Set Status tables in MMS. A modal window will open, where you
can add databases or collections to the list, or remove list items by clicking on the red x icon.
Removing a namespace from the excluded namespaces list necessitates a re-sync. MMS Backup handles this re-sync.
Can I convert a replica set to a sharded cluster?
MMS does not support the conversion of one type of deployment to another. To convert a replica set to a sharded
cluster, see Convert Replica Set to Sharded Cluster in the MongoDB manual.
Can I convert a standalone to a replica set?
MMS does not support the conversion of one type of deployment to another. To convert a standalone deployment to a
replica set, see Convert Standalone to Replica Set in the MongoDB manual.
188
Restoration
MMS Backup produces a copy of your data files that you can use to seed a new deployment.
How can MMS provide point-in-time restores for any point in time?
Although it is faster to provide a restore for the time at which a snapshot was actually stored, this might not be ideal
when restoring a replica set or sharded cluster. In consequence, the Backup service can build a restore to any point in
time within a 24-hour period by replaying the oplog to the desired time.
For details, see the procedures for restoring replica sets and sharded clusters.
Can I take snapshots more or less often than every 6 hours?
No, MMS does not support a snapshot schedule with more frequent snapshots. See Activate |mms| Backup for more
information on configuring backup snapshot schedules.
Can I set my own snapshot retention policy?
Yes. Backup snapshot retention is configurable.
The default snapshot retention policy is to maintain:
• 6-hour interval snapshots for 2 days,
• Daily snapshots stored for 1 week,
• Weekly snapshots stored for 1 month, and
• Monthly snapshots stored for 1 year. If you terminate the service, MMS no longer saves snapshots after three
months from the date of termination.
You can customize both the frequency and schedule of snapshots that MMS captures. This allows you to tune your
backup strategy based on your requirements.
For example you may choose to capture more frequent snapshots for the most mission critical data, and capture
snapshots less frequently for less critical data.
Customizable snapshot retention polices give you greater control over your backup costs. The pricing for MMS
Backup is based on the data size of the most recent snapshot.
See Activate |mms| Backup for details about configuring snapshot retention frequency and excluding namespaces for
non-critical databases and collections.
How many copies of my data does the Backup Service store?
Although we only charge you for only one copy of the data, MMS Backup stores at least 3 copies of your data in at
least 2 geographic locations to ensure redundancy.
How long does it take to create a restore?
MMS transmits all backups in a compressed form from the MMS server to your infrastructure.
Within the US, MMS Backup sends snapshots at 50-100 Mbps. Assuming a compression factor of 4x and transmission
speeds of 50 Mbps, a 250 GB snapshot will take 2.5 hours.
189
In addition, point-in-time restores that require creating a new snapshot take additional time, which depends on the size
of the scheduled snapshot and the amount the oplog entries that MMS Backup must apply to the preceding snapshot
to roll forward to the requested point-in-time of the backup.
Does MMS Backup perform any data validation?
MMS Backup conducts basic corruption checks and provides an alert if any component (e.g., the agent) is down or
broken, but does not perform explicit data validation. When it detects corruption, MMS Backup errs on the side of
caution and invalidates the current backup and sends an alert.
How do I restore? What do I get when I restore?
You can request a restore via MMS, where you can then choose which snapshot to restore and how you want MMS
Backup to deliver the restore. All restores require 2-factor authentication. MMS will send an authorization code via
SMS code to your administrator. You must enter the authorization code into the backup interface to begin the restore
process.
Note: From India, use Google Authenticator for two-factor authentication. Google Authenticator is more reliable
than authentication with SMS text messages to Indian mobile phone numbers (i.e. country code 91).
MMS Backup delivers restores as tar.gz archives of MongoDB data files.
Restore delivery options are:
• SCP to your Infrastructure: MMS Backup will transmit the backup to your infrastructure over a secure channel. You must provide connection information for a host in your deployment.
• Download: MMS Backup will make your restore data available using a custom, one-time-use URL.
How do I know an SCP restore push has completed and is correct?
When you receive restoration files through an SCP push, MMS sends SHA-1 hash files, also called checksum files,
along with the restore files. The hash files have the .sha1 extension,
To ensure the restore files are complete and correct, use the Unix shasum utility:
shasum -c <checksum file>
What is the SCP public key for MMS?
MMS generates an SSH public key on a per user basis to use when delivering backups via SCP. To generate a public
key, select the Administration tab and then the Group Settings page. In the Public Key for SCP Restores section, type
in a Passphrase and click GENERATE A NEW PUBLIC KEY. The public key will generate an SSH key and display it.
Add this key to your authorized hosts file.
See the Public Key for SCP Restores setting on the Group Settings page for more information about granting access
via SSH public key.
How does Backup handle Rollbacks?
If your MongoDB deployment experiences a rollback, then MMS Backup also rolls back.
190
Backup detects the rollback when a tailing cursor finds a mismatch in timestamps or hashes of write operations.
Backup enters a rollback state and tests three points in the oplog of your replica set’s primary to locate a common point
in history. MMS rollback differs from MongoDB secondary rollback in that the common point does not necessarily
have to be the most recent common point.
When Backup finds a common point, the service invalidates oplog entries and snapshots beyond that point and rolls
back to the most recent snapshot before the common point. Backup then resumes normal operations.
If MMS cannot find a common point, a resync is required.
What conditions will require a resync?
If the Backup Agent’s tailing cursor cannot keep up with your deployment’s oplog, then you must resync the Backup
Service.
This scenario might occur, for example, if:
• Your application periodically generates a lot of data, shrinking the primary’s oplog window to the point that data
is written to the oplog faster than Backup can consume it.
• If the Backup Agent is running on an under-provisioned or over-used machine and cannot keep up with the
oplog activity.
• If the Backup Agent is down for a period of time longer than the oplog size allows. If you bring down your
agents, such as for maintenance, restart them in a timely manner. For more information on oplog size, see
Replica Set Oplog in the MongoDB manual.
• If all you delete all replica set data and deploy a new replica set with the same name, as might happen in a test
environment where deployments are regularly torn down and rebuilt.
• If there is a rollback, and Backup cannot find a common point in the oplog.
• If an oplog event tries to update a document that does not exist in the Backup replica set, as might happen if
syncing from a secondary that has inconsistent data with respect to the primary.
How much does it cost to use MMS Backup?
For information about MMS Backup pricing, please see the MMS pricing page.
9.4 Administration FAQs
User and Group Management
How do I reset my password?
You can reset your password using the password reset form.
How do I change my password?
You can change your password by resetting your password.
191
What are the password requirements?
Passwords must be at least 8 characters long and contain at least one letter, one digit, and one special character.
Passwords for the MongoDB Jira instance and MMS are the same, although the length and character requirements are
different for Jira and MMS.
How do I add a user to my company/group?
If the user already has a MongoDB Jira or MMS account, you can add their username to your group on the admin
page.
If the user does not have a Jira account then they can create a new account
After they have created an account, you can add their username to the company/group on the admin page.
How do I remove my company/group?
Please contact MMS support to remove a company or group from your MMS account.
How can I configure multiple Google Authenticator apps to use the same account?
By selecting the Can’t scan the barcode? option during the procedure to Configure Two-Factor Authentication with
Google Authenticator. The option provides a common key that multiple Google Authenticator apps can use.
Activity
My alert email says my host(s) are exposed to the public Internet. What does that mean?
Any alerts set to check if your host is exposed to the public internet will attempt to connect to your servers occasionally
as part of a vulnerability check to help test your firewall configuration. This is a weak security validation and should
not replace other auditing or intrusion detection system procedures.
If you configured a setting called Exposed Db Host Check, it is now an alert you can edit or disable. Newly created
groups have an exposed host alert created and activated automatically, along with a Monitoring Agent down alert.
Existing groups must set the exposed host alert manually.
When enabled, this alert runs twice a month, on the first and fifteenth. Once MMS finds an exposed host, the service
will try to connect to the exposed host every five minutes until the host is no longer accessible. The exposed host alert
email looks the same as other alert emails.
MMS attempts to connect with both the IP address and the non-canonical host identifier.
See Manage Alerts to disable or modify the exposed host alerts.
How do I modify my alert settings?
To enable, disable, or modify alerts, select the Activity tab and then the Alert Settings page. For more information, see
Manage Alert Configuration.
192
How frequently can alerts be set?
MMS processes alerts on a 5-minute interval. Therefore, the minimum frequency for an alert is 5 minutes. The default
frequency for new alert configurations is 60 minutes.
Operations
Do Web or Database Hosting Companies Integrate with MMS?
Web hosting companies can offer the ability to use MMS with their hosted MongoDB databases, for example, to set
up software agents to monitor and backup databases hosted on their servers. MongoDB has confirmed compatability
with MongoHQ, MongoLab, and Heroku. Implementation details depend on each hosting company.
MongoHQ offers MMS upon request as part of their Database as a Service (DaaS) business.
MongoLab offers MMS as part of their Database as a Service (DaaS) business. MongoLab offers the service on their
dedicated plans and shared replica set plan. They also provide instructions to tune MongoDB performance with MMS
on their servers.
MongoHQ and MongoLab are MongoDB Advanced Partners.
Heroku offers web hosting with a MongoHQ add-on and MongoLab add-on to use MongoDB databases from these
database hosting companies. Heroku also offers MMS monitoring of those databases with detailed setup instructions.
About MMS
What open source projects does MMS use?
• Database: MongoDB
• App framework: Google Guice
• Http server: Jetty
• Web framework: Jersey
• Misc server libs: Apache Commons
• UI lib: jQuery , Bootstrap
• Charts: dygraphs
• Graphics: Font-Awesome
10 Reference
Automation Agent Install the automation agent on existing hardware.
Monitoring Agent Install and configure the Monitoring Agent.
Backup Agent Install and configure the Backup Agent.
Monitoring Reference A reference sheet for the monitoring service.
Supported Browsers Browsers supported by MMS.
Advanced Options for MongoDB Deployments Describes the advanced deployment options for replica sets and
sharded clusters.
193
Automation Configuration Describes the settings available in the cluster configuration file used to determine the
desired state of the MongoDB deployment.
Supported MongoDB Options for Automation Supported options for a MongoDB process in an automation configuration.
AWS IAM Policy The AWS permissions required for the user associated with the AWS access keys configured in
MMS.
10.1 Automation Agent
The Automation Agent runs on every host that runs a monitored MongoDB deployment. The agent provides the
interface for starting and managing deployments. If you run MongoDB on hardware that you provision, you must
install the Automation Agent manually on each server. If you run MongoDB through the MMS integration with
Amazon Web Services (AWS), MMS automatically deploys the Automation Agents every time you provision an new
EC2 instance.
Install with RPM Packages Install and start the Automation Agent using an rpm package.
Install on Ubuntu Install and start the automation Agent on Ubuntu using a deb package.
Install on Other Linux Systems Install and start the Automation Agent on other Linux systems using the tar.gz
archive packages.
Install on OS X Install and start the Automation Agent on OS X.
Install the Automation Agent with rpm Packages
Overview
The Automation Agent runs on every host that runs a monitored MongoDB deployment. The agent provides the
interface for starting and managing deployments. If you run MongoDB on hardware that you provision, you must
install the Automation Agent manually on each server. If you run MongoDB through the MMS integration with
Amazon Web Services (AWS), MMS automatically deploys the Automation Agents every time you provision an new
EC2 instance.
Use this procedure to install the agent on RHEL, CentOS, SUSE, Amazon Linux, and other systems that use rpm
packages.
Prerequisites
Before installing the agent, review the Automation Checklist for considerations and prerequisites specific to the agent.
Procedures
This section includes procedures for both installing and updating the Automation Agent.
Install the Automation Agent with an rpm Package
194
Step 1: Download the latest version of the Automation Agent archive. On a system shell, issue a command that
resembles the following. Replace amd64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-manager-lates
Step 2: Install the Automation Agent Package
sudo rpm -U mongodb-mms-automation-agent-manager-latest.x86_64.rpm
Step 3: Edit the automation-agent.config file. Edit the automation-agent.config file.
sudo vi /etc/mongodb-mms/automation-agent.config
For mmsGroupId, enter your GroupID as the value. For mmsApiKey, enter your API key.
mmsGroupId=<Group ID>
mmsApiKey=<API Key>
For SUSE 11+ deployments only, configure the sslTrustedMMSServerCertificate setting. All other users
should omit this step.
sslTrustedMMSServerCertificate=/etc/ssl/certs/UTN_USERFirst_Hardware_Root_CA.pem
Step 4: Prepare a directory in which to store your MongoDB data. The directory must be owned by the mongod
user. For example, use a set of commands similar to the following:
sudo mkdir /data
sudo chown mongod:mongod /data
Step 5: Start the Automation Agent. Issue the following command:
sudo service mongodb-mms-automation-agent start
Update the Automation Agent with an rpm Package You do not need to stop the agent to install. The update
package automatically stops, unpacks, and then restarts the agent.
Step 1: Download the latest version of the Automation Agent archive. On a system shell, issue a command that
resembles the following. Replace amd64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-manager-lates
Step 2: Install the Automation Agent Package
sudo rpm -U mongodb-mms-automation-agent-manager-latest.x86_64.rpm
Step 3: Prepare a directory in which to store your MongoDB data. The directory must be owned by the mongod
user. For example, use a set of commands similar to the following:
sudo mkdir /data
sudo chown mongod:mongod /data
195
Install the Automation Agent with deb Packages
Overview
The Automation Agent runs on every host that runs a monitored MongoDB deployment. The agent provides the
interface for starting and managing deployments. If you run MongoDB on hardware that you provision, you must
install the Automation Agent manually on each server. If you run MongoDB through the MMS integration with
Amazon Web Services (AWS), MMS automatically deploys the Automation Agents every time you provision an new
EC2 instance.
Use this procedures to install the Automation Agent on Ubuntu with deb packages. For Debian systems, use the
Install the Automation Agent from an Archive procedure.
Prerequisites
Before installing the agent, review the Automation Checklist for considerations and prerequisites specific to the agent.
Procedures
This section includes procedures for both installing and updating the Automation Agent.
Install the Automation Agent with a deb Package
Step 1: Download the latest version of the Automation Agent archive. On a system shell, issue a command that
resembles the following. Replace amd64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-manager_lates
Step 2: Install the Automation Agent Package.
sudo dpkg -i mongodb-mms-automation-agent-manager_latest_amd64.deb
Step 3: Edit the automation-agent.config file. Edit the automation-agent.config file.
sudo vi /etc/mongodb-mms/automation-agent.config
For mmsGroupId, enter your GroupID as the value. For mmsApiKey, enter your API key.
mmsGroupId=<Group ID>
mmsApiKey=<API Key>
Step 4: Prepare a directory in which to store your MongoDB data. The directory must be owned by the
mongodb user. For example, use a set of commands similar to the following:
sudo mkdir /data
sudo chown mongodb:mongodb /data
Step 5: Start the Automation Agent. Issue the following command:
196
sudo start mongodb-mms-automation-agent
Update the Automation Agent with a deb Package You do not need to stop the agent to install. The update
package automatically stops, unpacks, and then restarts the agent.
Step 1: Download the latest version of the Automation Agent archive. On a system shell, issue a command that
resembles the following. Replace amd64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-manager_lates
Step 2: Install the Automation Agent Package.
sudo dpkg -i mongodb-mms-automation-agent-manager_latest_amd64.deb
Step 3: Prepare a directory in which to store your MongoDB data. The directory must be owned by the
mongodb user. For example, use a set of commands similar to the following:
sudo mkdir /data
sudo chown mongodb:mongodb /data
Install the Automation Agent from an Archive
Overview
The Automation Agent runs on every host that runs a monitored MongoDB deployment. The agent provides the
interface for starting and managing deployments. If you run MongoDB on hardware that you provision, you must
install the Automation Agent manually on each server. If you run MongoDB through the MMS integration with
Amazon Web Services (AWS), MMS automatically deploys the Automation Agents every time you provision an new
EC2 instance.
Use this procedure to install the Automation Agent on a Linux system not listed in the Agent Downloads list on the
Agents page in the Administration tab.
Prerequisites
Before installing the agent, review the Automation Checklist for considerations and prerequisites specific to the agent.
Procedure
This section includes procedures for both installing and updating the Automation Agent.
Install the Automation Agent from an Archive
Step 1: Download the latest version of the Automation Agent archive. On a system shell, issue a command that
resembles the following. Replace linux_x86_64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-latest.linux_
197
Step 2: Install the Automation Agent. To install the agent, extract the archive using a command that resembles the
following. Replace linux_x86_64 with your platform, as needed:
tar -xf mongodb-mms-automation-agent-latest.linux_x86_64.tar.gz
The Automation Agent is installed.
Step 3: Edit the local.config file to include your Group ID and MMS API key. In the directory where you
installed the Automation Agent, edit the local.config file.
• For mmsGroupId, enter your GroupID as the value.
• For mmsApiKey, enter your API key.
mmsGroupId=<Group ID>
mmsApiKey=<API Key>
Step 4: Create Automation Directory Create the directories /var/lib/mongodb-mms-automation,
/var/log/mongodb-mms-automation and /data and ensure that the user running the agent owns the directories.
Step 5: Start the Automation Agent. Issue the following command:
nohup ./mongodb-mms-automation-agent >> automation-agent.log 2>&1 &
Update the Automation Agent from an Archive
Step 1: Stop any currently running Automation Agents. Issue the following command:
pkill -f mongodb-mms-automation-agent
Step 2: Download the latest version of the Automation Agent archive. On a system shell, issue a command that
resembles the following. Replace linux_x86_64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-latest.linux_
Step 3: Install the Automation Agent. To install the agent, extract the archive using a command that resembles the
following. Replace linux_x86_64 with your platform, as needed:
tar -xf mongodb-mms-automation-agent-latest.linux_x86_64.tar.gz
The Automation Agent is installed.
Step 4: Edit the local.config file to include your Group ID and MMS API key. In the directory where you
installed the Automation Agent, edit the local.config file.
• For mmsGroupId, enter your GroupID as the value.
• For mmsApiKey, enter your API key.
mmsGroupId=<Group ID>
mmsApiKey=<API Key>
198
Step 5: Create Automation Directory Create the directories /var/lib/mongodb-mms-automation,
/var/log/mongodb-mms-automation and /data and ensure that the user running the agent owns the directories.
Step 6: Start the Automation Agent. Issue the following command:
nohup ./mongodb-mms-automation-agent >> automation-agent.log 2>&1 &
Install the Automation Agent on OS X
Overview
The Automation Agent runs on every host that runs a monitored MongoDB deployment. The agent provides the
interface for starting and managing deployments. If you run MongoDB on hardware that you provision, you must
install the Automation Agent manually on each server. If you run MongoDB through the MMS integration with
Amazon Web Services (AWS), MMS automatically deploys the Automation Agents every time you provision an new
EC2 instance.
Prerequisites
Before installing the agent, review the Automation Checklist for considerations and prerequisites specific to the agent.
Procedure
This section includes procedures for both installing and updating the Automation Agent.
Install the Automation Agent on OS X
Step 1: Download the latest version of the Automation Agent archive. On a system shell, issue a command that
resembles the following. Replace osx_x86_64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-latest.osx_x8
Step 2: Install the Automation Agent. To install the agent, extract the archive using a command that resembles the
following. Replace osx_x86_64 with your platform, as needed:
tar -xf mongodb-mms-automation-agent-latest.linux_x86_64.tar.gz
The Automation Agent is installed.
Step 3: Edit the local.config file to include your Group ID and MMS API key. In the directory where you
installed the Automation Agent, edit the local.config file.
• For mmsGroupId, enter your GroupID as the value.
• For mmsApiKey, enter your API key.
mmsGroupId=<Group ID>
mmsApiKey=<API Key>
199
Step 4: Create Automation Directory Create the directories /var/lib/mongodb-mms-automation,
/var/log/mongodb-mms-automation and /data and ensure that the user running the agent owns the directories.
Step 5: Start the Automation Agent. Issue the following command:
nohup ./mongodb-mms-automation-agent --config=local.config >> /var/log/mongodb-mms-automation/automat
Update the Automation Agent on OS X
Step 1: Stop any currently running Automation Agents. Issue the following command:
pkill -f mongodb-mms-automation-agent
Step 2: Download the latest version of the Automation Agent archive. On a system shell, issue a command that
resembles the following. Replace osx_x86_64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/automation/mongodb-mms-automation-agent-latest.osx_x8
Step 3: Install the Automation Agent. To install the agent, extract the archive using a command that resembles the
following. Replace osx_x86_64 with your platform, as needed:
tar -xf mongodb-mms-automation-agent-latest.linux_x86_64.tar.gz
The Automation Agent is installed.
Step 3: Edit the local.config file to include your Group ID and MMS API key. In the directory where you
installed the Automation Agent, edit the local.config file.
• For mmsGroupId, enter your GroupID as the value.
• For mmsApiKey, enter your API key.
mmsGroupId=<Group ID>
mmsApiKey=<API Key>
Step 4: Create Automation Directory Create the directories /var/lib/mongodb-mms-automation,
/var/log/mongodb-mms-automation and /data and ensure that the user running the agent owns the directories.
Step 6: Start the Automation Agent. Issue the following command:
nohup ./mongodb-mms-automation-agent --config=local.config >> /var/log/mongodb-mms-automation/automat
10.2 Monitoring Agent
Install or Update the Agent Procedures for installing and updating the Monitoring Agent.
Monitoring Agent Configuration Documentation of the settings available in the Monitoring Agent configuration file.
200
Required Access for Monitoring Agent Details the permissions required for Monitoring Agent to use with MongoDB
instances that enforce access control.
Configure the Agent for Access Control If MongoDB uses Access Control, create a MongoDB user for the Monitoring Agent to use to authenticate and to determine the agent’s access.
Configure the Agent for SSL Configure the Monitoring Agent for SSL.
Configure Hardware Monitoring Install and configure support for a munin-node plugin, for hardware monitoring.
Start or Stop the Agent Procedures to start and stop the Monitoring Agent.
Remove the Agent Remove the Monitoring Agent.
Install Monitoring Agent
The MMS Monitoring Agent is a lightweight component that runs within your infrastructure, connects to your MongoDB processes, collects data about the state of your deployment, and then sends the data to the MMS Monitoring
service which processes and renders this data.
Install or Update with RPM Packages Install or update the Monitoring Agent using an rpm package.
Install or Update on Ubuntu Install or update the Monitoring Agent on Ubuntu using a deb package.
Install or Update on OS X Install or update the Monitoring Agent on OS X systems.
Install or Update on Other Linux Systems Install or update the Monitoring Agent on Linux systems other than
RHEL or Ubuntu.
Install or Update on Windows Install or update the Monitoring Agent on windows
Install or Update the Monitoring Agent with rpm Packages
Overview The MMS Monitoring Agent is a lightweight component that runs within your infrastructure, connects
to your MongoDB processes, collects data about the state of your deployment, and then sends the data to the MMS
Monitoring service which processes and renders this data. The agent initiates all connections to the MMS Monitoring
service, and communications between the agent and the MMS Monitoring service are encrypted. A single agent can
collect data from multiple MongoDB processes.
This tutorial will guide you through the steps necessary to install or update the Monitoring Agent on your system.
See Monitoring FAQs for additional information.
Considerations
Connectivity You must configure the networking rules of your deployment so that:
• the Monitoring Agent can connect to all mongod and mongos instances that you want to monitor.
• the Monitoring Agent can connect to mms.mongodb.com on port 443 (i.e. https.)
The MMS Monitoring server does not make any outbound connections to the agents or to MongoDB instances. If
Exposed DB Host Check is enabled, the MMS Monitoring server will attempt to connect to your servers occasionally
as part of a vulnerability check.
Ensure all mongod and mongos instances are not accessible to hosts outside your deployment.
201
Monitoring Agent Redundancy A single Monitoring Agent is sufficient and strongly recommended. However, you
can run additional instances of the agent as hot standbys to provide redundancy. If the primary agent fails, a standby
agent starts monitoring.
When you run multiple agents, only one Monitoring Agent per group or environment is the primary agent. The
primary agent reports the cluster’s status to MMS. The remaining agents are completely idle, except to log their status
as standby agents and to periodically ask MMS whether they should become the primary.
To install additional agents, simply repeat the installation process.
Collection Interval If you are updating the agent, keep in mind that when the Monitoring Agent restarts, there
is a five-minute delay before that agent begins collecting data and sending pings to MMS Monitoring. If you have
multiple agents, this delay permits other agents in your infrastructure to become the primary agent and permits MMS
Monitoring to determine which agent will be primary.
During this interval, the restarted Monitoring Agent will not collect data.
Prerequisites If your MongoDB deployment enforces access control, you must create a user in MongoDB with the
appropriate access. See Configure Monitoring Agent for Access Control.
Procedures This section includes procedures for both installing and updating the Monitoring Agent.
Install the Monitoring Agent with an rpm Package Use this procedure to install the agent on RHEL, CentOS,
SUSE, Amazon Linux, and other systems that use rpm packages.
Step 1: Download the latest version of the Monitoring Agent package. With a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.x86_64
Step 2: Install the Monitoring Agent package. Issue the following command:
sudo rpm -U mongodb-mms-monitoring-agent-latest.x86_64.rpm
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, click the
link for your operating system. MMS will then display a procedure that includes a step to set your MMS API key. The
step displays the actual MMS API key used by your MMS group. Copy the key.
Step 4:
Edit the monitoring-agent.config file to include your MMS API key. In the
<install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.
Step 5: Optional: For SUSE deployments only, configure the sslTrustedMMSServerCertificate property. If you’re deploying on SUSE, you must configure the sslTrustedMMSServerCertificate setting. All
other users should omit this step.
Enter the following property and value in the /etc/mongodb-mms/monitoring-agent.config file:
sslTrustedMMSServerCertificate=/etc/ssl/certs/UTN_USERFirst_Hardware_Root_CA.pem
Save and close the file.
202
Step 6: Start the Monitoring Agent. Issue the following command:
sudo service mongodb-mms-monitoring-agent start
Remember, that you only need to run 1 Monitoring Agent for each MMS group. A single Monitoring Agent can
collect data from many MongoDB instances.
Update the Monitoring Agent with an rpm Package
Step 1: Download the latest version of the Monitoring Agent package. With a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.x86_64
Step 2: Install the Monitoring Agent package. Issue the following command:
sudo rpm -U mongodb-mms-monitoring-agent-latest.x86_64.rpm
Install or Update the Monitoring Agent with deb Packages
Overview The MMS Monitoring Agent is a lightweight component that runs within your infrastructure, connects
to your MongoDB processes, collects data about the state of your deployment, and then sends the data to the MMS
Monitoring service which processes and renders this data. The agent initiates all connections to the MMS Monitoring
service, and communications between the agent and the MMS Monitoring service are encrypted. A single agent can
collect data from multiple MongoDB processes.
This tutorial will guide you through the steps necessary to install or update the Monitoring Agent on your system.
See Monitoring FAQs for additional information.
Considerations
Connectivity You must configure the networking rules of your deployment so that:
• the Monitoring Agent can connect to all mongod and mongos instances that you want to monitor.
• the Monitoring Agent can connect to mms.mongodb.com on port 443 (i.e. https.)
The MMS Monitoring server does not make any outbound connections to the agents or to MongoDB instances. If
Exposed DB Host Check is enabled, the MMS Monitoring server will attempt to connect to your servers occasionally
as part of a vulnerability check.
Ensure all mongod and mongos instances are not accessible to hosts outside your deployment.
Monitoring Agent Redundancy A single Monitoring Agent is sufficient and strongly recommended. However, you
can run additional instances of the agent as hot standbys to provide redundancy. If the primary agent fails, a standby
agent starts monitoring.
When you run multiple agents, only one Monitoring Agent per group or environment is the primary agent. The
primary agent reports the cluster’s status to MMS. The remaining agents are completely idle, except to log their status
as standby agents and to periodically ask MMS whether they should become the primary.
To install additional agents, simply repeat the installation process.
203
Collection Interval If you are updating the agent, keep in mind that when the Monitoring Agent restarts, there
is a five-minute delay before that agent begins collecting data and sending pings to MMS Monitoring. If you have
multiple agents, this delay permits other agents in your infrastructure to become the primary agent and permits MMS
Monitoring to determine which agent will be primary.
During this interval, the restarted Monitoring Agent will not collect data.
Prerequisites If your MongoDB deployment enforces access control, you must create a user in MongoDB with the
appropriate access. See Configure Monitoring Agent for Access Control.
Procedures This section includes procedures for installing and updating the Monitoring Agent on Ubuntu with deb
packages.
For Debian systems, instead use the Install or Update the Monitoring Agent from Archive procedure.
Install the Monitoring Agent with a deb Package
Step 1: Download the latest version of the Monitoring Agent package.
system shell:
Issue the following command using the
curl -OL https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent_latest_amd64.
Step 2: Install the Monitoring Agent package. Issue the following command using the system shell:
sudo dpkg -i mongodb-mms-monitoring-agent_latest_amd64.deb
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, click the
link for your operating system. MMS will then display a procedure that includes a step to set your MMS API key. The
step displays the actual MMS API key used by your MMS group. Copy the key.
Step 4:
Edit the monitoring-agent.config file to include your MMS API key. In the
<install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.
Step 5: Start the Monitoring Agent. Issue the following command:
sudo start mongodb-mms-monitoring-agent
Remember, that you only need to run 1 Monitoring Agent for each MMS group. A single Monitoring Agent can
collect data from many MongoDB instances.
Update the Monitoring Agent with a deb Package
Step 1: Download the latest version of the Monitoring Agent package.
system shell:
Issue the following command using the
curl -OL https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent_latest_amd64.
204
Step 2: Install the Monitoring Agent package. Issue the following command using the system shell:
sudo dpkg -i mongodb-mms-monitoring-agent_latest_amd64.deb
Step 3: Start the Monitoring Agent. Issue the following command:
sudo start mongodb-mms-monitoring-agent
Remember, that you only need to run 1 Monitoring Agent for each MMS group. A single Monitoring Agent can
collect data from many MongoDB instances.
Install or Update the Monitoring Agent on OS X
Overview The MMS Monitoring Agent is a lightweight component that runs within your infrastructure, connects
to your MongoDB processes, collects data about the state of your deployment, and then sends the data to the MMS
Monitoring service which processes and renders this data. The agent initiates all connections to the MMS Monitoring
service, and communications between the agent and the MMS Monitoring service are encrypted. A single agent can
collect data from multiple MongoDB processes.
This tutorial will guide you through the steps necessary to install or update the Monitoring Agent on your system.
See Monitoring FAQs for additional information.
Considerations
Connectivity You must configure the networking rules of your deployment so that:
• the Monitoring Agent can connect to all mongod and mongos instances that you want to monitor.
• the Monitoring Agent can connect to mms.mongodb.com on port 443 (i.e. https.)
The MMS Monitoring server does not make any outbound connections to the agents or to MongoDB instances. If
Exposed DB Host Check is enabled, the MMS Monitoring server will attempt to connect to your servers occasionally
as part of a vulnerability check.
Ensure all mongod and mongos instances are not accessible to hosts outside your deployment.
Monitoring Agent Redundancy A single Monitoring Agent is sufficient and strongly recommended. However, you
can run additional instances of the agent as hot standbys to provide redundancy. If the primary agent fails, a standby
agent starts monitoring.
When you run multiple agents, only one Monitoring Agent per group or environment is the primary agent. The
primary agent reports the cluster’s status to MMS. The remaining agents are completely idle, except to log their status
as standby agents and to periodically ask MMS whether they should become the primary.
To install additional agents, simply repeat the installation process.
Collection Interval If you are updating the agent, keep in mind that when the Monitoring Agent restarts, there
is a five-minute delay before that agent begins collecting data and sending pings to MMS Monitoring. If you have
multiple agents, this delay permits other agents in your infrastructure to become the primary agent and permits MMS
Monitoring to determine which agent will be primary.
During this interval, the restarted Monitoring Agent will not collect data.
205
Prerequisites If your MongoDB deployment enforces access control, you must create a user in MongoDB with the
appropriate access. See Configure Monitoring Agent for Access Control.
Procedures This section includes procedures for both installing and updating the Monitoring Agent.
Install the Monitoring Agent on OS X Use this procedure to install the agent OS X systems.
Step 1: Download the latest version of the Monitoring Agent archive. With a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.osx_x8
Step 2: Install the Monitoring Agent. To install the agent, extract the archive by issue the following command:
tar -xf mongodb-mms-monitoring-agent-latest.osx_x86_64.tar.gz
The Monitoring Agent is installed.
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, click the
link for your operating system. MMS will then display a procedure that includes a step to set your MMS API key. The
step displays the actual MMS API key used by your MMS group. Copy the key.
Step 4:
Edit the monitoring-agent.config file to include your MMS API key. In the
<install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.
Step 5: Optional: Configure the agent to use a proxy server. If the agent will connect to MMS via a proxy
server, you must specify the server in the http_proxy environment variable. To specify the server, use the export
command, as in the following example:
export http_proxy="http://proxy.example.com:9000"
To connect through a proxy, you must install the agent from a .tar.gz file, not from a .deb or .rpm file.
Step 6: Start the Monitoring Agent. Issue the following command:
nohup ./mongodb-mms-monitoring-agent >> monitoring-agent.log 2>&1 &
Remember, that you only need to run 1 Monitoring Agent for each MMS group. A single Monitoring Agent can
collect data from many MongoDB instances.
Update the Monitoring Agent from a tar.gz Archive Use this procedure to update the agent on OS X systems.
Step 1: Stop any currently running Monitoring Agents. Issue the following command:
pkill -f mongodb-mms-monitoring-agent
206
Step 2: Download the latest version of the Monitoring Agent archive. With a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.osx_x8
Step 3: Install the Monitoring Agent. To install the agent, extract the archive by issue the following command:
tar -xf mongodb-mms-monitoring-agent-latest.osx_x86_64.tar.gz
The Monitoring Agent is installed.
Step 4: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, click the
link for your operating system. MMS will then display a procedure that includes a step to set your MMS API key. The
step displays the actual MMS API key used by your MMS group. Copy the key.
Step 5:
Edit the monitoring-agent.config file to include your MMS API key. In the
<install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.
Step 6: Start the Monitoring Agent. Issue the following command:
nohup ./mongodb-mms-monitoring-agent >> monitoring-agent.log 2>&1 &
Remember, that you only need to run 1 Monitoring Agent for each MMS group. A single Monitoring Agent can
collect data from many MongoDB instances.
Install or Update the Monitoring Agent from Archive
Overview The MMS Monitoring Agent is a lightweight component that runs within your infrastructure, connects
to your MongoDB processes, collects data about the state of your deployment, and then sends the data to the MMS
Monitoring service which processes and renders this data. The agent initiates all connections to the MMS Monitoring
service, and communications between the agent and the MMS Monitoring service are encrypted. A single agent can
collect data from multiple MongoDB processes.
This tutorial will guide you through the steps necessary to install or update the Monitoring Agent on your system.
See Monitoring FAQs for additional information.
Considerations
Connectivity You must configure the networking rules of your deployment so that:
• the Monitoring Agent can connect to all mongod and mongos instances that you want to monitor.
• the Monitoring Agent can connect to mms.mongodb.com on port 443 (i.e. https.)
The MMS Monitoring server does not make any outbound connections to the agents or to MongoDB instances. If
Exposed DB Host Check is enabled, the MMS Monitoring server will attempt to connect to your servers occasionally
as part of a vulnerability check.
Ensure all mongod and mongos instances are not accessible to hosts outside your deployment.
207
Monitoring Agent Redundancy A single Monitoring Agent is sufficient and strongly recommended. However, you
can run additional instances of the agent as hot standbys to provide redundancy. If the primary agent fails, a standby
agent starts monitoring.
When you run multiple agents, only one Monitoring Agent per group or environment is the primary agent. The
primary agent reports the cluster’s status to MMS. The remaining agents are completely idle, except to log their status
as standby agents and to periodically ask MMS whether they should become the primary.
To install additional agents, simply repeat the installation process.
Collection Interval If you are updating the agent, keep in mind that when the Monitoring Agent restarts, there
is a five-minute delay before that agent begins collecting data and sending pings to MMS Monitoring. If you have
multiple agents, this delay permits other agents in your infrastructure to become the primary agent and permits MMS
Monitoring to determine which agent will be primary.
During this interval, the restarted Monitoring Agent will not collect data.
Prerequisites If your MongoDB deployment enforces access control, you must create a user in MongoDB with the
appropriate access. See Configure Monitoring Agent for Access Control.
Procedures This section includes procedures for installing and updating the Monitoring Agent on a Linux system
not listed in the Agent Downloads list on the Agents page in the Administration tab.
Install the Monitoring Agent from a tar.gz Archive Use this procedure to install the agent on Linux systems:
Step 1: Download the latest version of the Monitoring Agent archive. With a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.linux_
Step 2: Install the Monitoring Agent. To install the agent, extract the archive by issue the following command:
tar -xf mongodb-mms-monitoring-agent-latest.linux_x86_64.tar.gz
The Monitoring Agent is installed.
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, click the
link for your operating system. MMS will then display a procedure that includes a step to set your MMS API key. The
step displays the actual MMS API key used by your MMS group. Copy the key.
Step 4:
Edit the monitoring-agent.config file to include your MMS API key. In the
<install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.
Step 5: Optional: Configure the agent to use a proxy server. If the agent will connect to MMS via a proxy
server, you must specify the server in the http_proxy environment variable. To specify the server, use the export
command, as in the following example:
export http_proxy="http://proxy.example.com:9000"
To connect through a proxy, you must install the agent from a .tar.gz file, not from a .deb or .rpm file.
208
Step 6: Start the Monitoring Agent. Issue the following command:
nohup ./mongodb-mms-monitoring-agent >> monitoring-agent.log 2>&1 &
Remember, that you only need to run 1 Monitoring Agent for each MMS group. A single Monitoring Agent can
collect data from many MongoDB instances.
Update the Monitoring Agent from a tar.gz Archive Use this procedure to update the agent on Linux systems:
Step 1: Stop any currently running Monitoring Agents. Issue the following command:
pkill -f mongodb-mms-monitoring-agent
Step 2: Download the latest version of the Monitoring Agent archive. With a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.linux_
Step 3: Install the Monitoring Agent. To install the agent, extract the archive by issue the following command:
tar -xf mongodb-mms-monitoring-agent-latest.linux_x86_64.tar.gz
The Monitoring Agent is installed.
Step 4: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, click the
link for your operating system. MMS will then display a procedure that includes a step to set your MMS API key. The
step displays the actual MMS API key used by your MMS group. Copy the key.
Step 5:
Edit the monitoring-agent.config file to include your MMS API key. In the
<install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.
Step 6: Start the Monitoring Agent. Issue the following command:
nohup ./mongodb-mms-monitoring-agent >> monitoring-agent.log 2>&1 &
Remember, that you only need to run 1 Monitoring Agent for each MMS group. A single Monitoring Agent can
collect data from many MongoDB instances.
Additional Information If you installed the Monitoring Agent from the tar.gz archives, see
http://docs.mms.mongodb.com//tutorial/rotate-agent-log-files to configure log rotation.
Install or Update the Monitoring Agent on Windows
Overview The MMS Monitoring Agent is a lightweight component that runs within your infrastructure, connects
to your MongoDB processes, collects data about the state of your deployment, and then sends the data to the MMS
Monitoring service which processes and renders this data. The agent initiates all connections to the MMS Monitoring
service, and communications between the agent and the MMS Monitoring service are encrypted. A single agent can
collect data from multiple MongoDB processes.
209
This tutorial will guide you through the steps necessary to install or update the Monitoring Agent on your system.
See Monitoring FAQs for additional information.
Considerations
Connectivity You must configure the networking rules of your deployment so that:
• the Monitoring Agent can connect to all mongod and mongos instances that you want to monitor.
• the Monitoring Agent can connect to mms.mongodb.com on port 443 (i.e. https.)
The MMS Monitoring server does not make any outbound connections to the agents or to MongoDB instances. If
Exposed DB Host Check is enabled, the MMS Monitoring server will attempt to connect to your servers occasionally
as part of a vulnerability check.
Ensure all mongod and mongos instances are not accessible to hosts outside your deployment.
Monitoring Agent Redundancy A single Monitoring Agent is sufficient and strongly recommended. However, you
can run additional instances of the agent as hot standbys to provide redundancy. If the primary agent fails, a standby
agent starts monitoring.
When you run multiple agents, only one Monitoring Agent per group or environment is the primary agent. The
primary agent reports the cluster’s status to MMS. The remaining agents are completely idle, except to log their status
as standby agents and to periodically ask MMS whether they should become the primary.
To install additional agents, simply repeat the installation process.
Collection Interval If you are updating the agent, keep in mind that when the Monitoring Agent restarts, there
is a five-minute delay before that agent begins collecting data and sending pings to MMS Monitoring. If you have
multiple agents, this delay permits other agents in your infrastructure to become the primary agent and permits MMS
Monitoring to determine which agent will be primary.
During this interval, the restarted Monitoring Agent will not collect data.
Prerequisites If your MongoDB deployment enforces access control, you must create a user in MongoDB with the
appropriate access. See Configure Monitoring Agent for Access Control.
Procedures This section includes procedures for both installing and updating the Monitoring Agent.
Install the Monitoring Agent on Windows Use this procedure to install the agent on Windows.
Step 1: Download and run the latest version of the Monitoring Agent MSI file. To download the 32-bit MSI file,
use the following URL:
https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.windows_i386.ms
To download the 64-bit MSI file, use the following URL:
https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.windows_x86_64.
During installation, the installer prompts you to specify the folder for storing configuration and log files. It is strongly
advised that you encrypt or restrict access to this folder.
210
Step 2: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, click the
link for your operating system. MMS will then display a procedure that includes a step to set your MMS API key. The
step displays the actual MMS API key used by your MMS group. Copy the key.
Step 3:
Edit the monitoring-agent.config file to include your MMS API key. In the
<install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.
The default location for the agent configuration file is C:\MMSData\Monitoring\monitoring-agent.config.
Step 5: Start the Monitoring Agent. Issue the following command:
In Windows Control Panel, open Administrative Tools, and then open Services.
In the list of services, select the MMS Monitoring Agent service. Select the Action menu and select Start.
Remember, that you only need to run 1 Monitoring Agent for each MMS group. A single Monitoring Agent can
collect data from many MongoDB instances.
Update the Monitoring Agent on Windows To update the agent on Windows systems:
Step 1:
Stop any currently running Monitoring Agents.
Administrative Tools and then Services.
In Windows Control Panel,
open
In the list of services, select the MMS Monitoring Agent service. Select the Action menu and select Stop.
Step 2: Download and run the latest version of the Monitoring Agent MSI file. To download the 32-bit MSI file,
use the following URL:
https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.windows_i386.ms
To download the 64-bit MSI file, use the following URL:
https://mms.mongodb.com/download/agent/monitoring/mongodb-mms-monitoring-agent-latest.windows_x86_64.
During installation, the installer prompts you to specify the folder for storing configuration and log files. It is strongly
advised that you encrypt or restrict access to this folder.
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, click the
link for your operating system. MMS will then display a procedure that includes a step to set your MMS API key. The
step displays the actual MMS API key used by your MMS group. Copy the key.
Step 4:
Edit the monitoring-agent.config file to include your MMS API key. In the
<install-directory>/monitoring-agent.config file, set the mmsApiKey property to your API key.
Step 5: Start the Monitoring Agent.
then open Services.
In Windows Control Panel, open Administrative Tools, and
In the list of services, select the MMS Monitoring Agent service. Select the Action menu and select Start.
Remember, that you only need to run 1 Monitoring Agent for each MMS group. A single Monitoring Agent can
collect data from many MongoDB instances.
211
Monitoring Agent Configuration
Configuration File
The location of the Monitoring Agent configuration file depends on your operating system:
• RHEL, CentOS, Amazon Linux, and Ubuntu all use a package manager to install the agent. The package
manager creates the following agent configuration file:
/etc/mongodb-mms/monitoring-agent.config
• OS X, Windows, and other Linux systems use either a tar or msi file for the installation. The Monitoring
Agent stores its configuration in the following file:
<installation directory>/monitoring-agent.config
Settings
Connection Settings For the Monitoring Agent communication with the MMS servers, the following connection
settings are required:
mmsApiKey
Type: string
The MMS agent API key for a MMS group. To retrieve the key from the MMS interface, click the Administration
tab, then the Agents page, and then the link for your operating system. MMS will display the MMS API key
used by your MMS group.
For example:
mmsApiKey=abc123
mmsBaseUrl
Type: string
The URL of the MMS Web Server.
HTTP Proxy Settings
httpProxy
New in version 2.3.1.
Type: string
To connect to the MMS HTTP Service via a proxy, specify the URL of the proxy. For example:
httpProxy=http://example-proxy.com:8080
MongoDB SSL Settings Specify these settings when the Monitoring Agent is connecting to MongoDB instances
with SSL.
useSslForAllConnections
Type: boolean
Set to true to enable SSL support globally and to use SSL for all MongoDB connections. Setting this to true
overrides any per-host SSL settings configured in the MMS interface.
When true, MMS requires that you also specify a value for the‘‘sslTrustedServerCertificates‘‘ setting.
212
sslClientCertificate
Type: string
The path to the private key, client certificate, and optional intermediate certificates in PEM format. The agent
will use the client certificate when connecting to any configured MongoDB that uses SSL and requires a client
certificate, i.e., that is running using the --sslCAFile option.
sslClientCertificatePassword
Type: string
The password needed to decrypt the private key in the file specified in sslClientCertificate. This
setting is necessary only if the client certificate PEM file is encrypted.
sslTrustedServerCertificates
Type: string
The path on disk that contains the trusted certificate authority certificates in PEM format. These certificates will
verify the server certificate returned from any MongoDB instances running with SSL. For example:
sslTrustedServerCertificates=/etc/mongodb-mms/mongodb-certs.pem
sslRequireValidServerCertificates
Type: boolean
Use this option to disable certificate verification by setting this value to false. That configuration is only
recommended for testing purposes as it makes connections susceptible to man-in-the-middle attacks.
MongoDB Kerberos Settings See http://docs.mms.mongodb.com//tutorial/connect-to-hosts-with-kerber
krb5Principal
Type: string
The Kerberos principal used by the agent. For example:
[email protected]
krb5Keytab
Type: string
The absolute path to Kerberos principal’s keytab file. For example:
krb5Keytab=/etc/mongodb-mms/mms-monitoring-agent.keytab
gsappiServiceName
Type: string
The default service name used by MongoDB is mongodb can specify a custom service name with the
gssapiServiceName option.
MMS Server SSL Settings
sslTrustedMMSServerCertificate
By default the Monitoring Agent will use the trusted root CAs installed on the system. If the agent cannot find
the trusted root CAs, configure these settings manually.
The path on disk that contains the trusted certificate authority certificates in PEM format. The agent will use
this certificate to verify that the agent is communicating with the designated MMS HTTP Service. For example:
sslTrustedMMSServerCertificate=/etc/mongodb-mms/mms-certs.pem
213
Munin Settings See Configure Hardware Monitoring with munin-node for information on configuring Munin-node.
enableMunin
Type: boolean
Set to false if you do not with the Monitoring Agent to collect hardware statistics via Munin-node. The
default is true. If the agent detects munin-node, MMS will collect hardware statistics.
Deprecated Settings
MongoDB Authentication Settings If all monitored MongoDB instances use the same MONGODB-CR credentials,
you may use these settings. Setting the username and password here will override any configuration in the MMS UI.
See Required Access for Monitoring Agent for information on the privileges needed for this user.
globalAuthUsername
Type: string
The MongoDB username that the Monitoring Agent will use to connect. This value overrides all other usernames configured for the Monitoring Agent.
Example:
globalAuthUsername=mms-monitoring-agent
globalAuthPassword
Type: string
The password for the globalAuthUsername user. This value overrides all other passwords configured
for the Monitoring Agent.
Example:
globalAuthPassword=somePassword
Required Access for Monitoring Agent
If your MongoDB deployment enforces access control, the MMS Monitoring Agent must authenticate to MongoDB
as a user with the proper access.
To authenticate, create a user with the appropriate roles in MongoDB. The following tutorials include instructions and
examples for creating the MongoDB user:
• Add Monitoring Agent User for MONGODB-CR.
• Configure Monitoring Agent for LDAP.
• Configure the Monitoring Agent for Kerberos.
MongoDB user roles are separate from MMS user roles and are described in the MongoDB manual beginning with
the Authorization page.
Considerations
To authenticate to sharded clusters, create shard-local users on each shard and create cluster-wide users:
• Create cluster users while connected to the mongos; these credentials persist to the config servers.
214
• Create shard-local users by connecting directly to the replica set for each shard.
There are additional authentication configuration requirements for MMS Monitoring when using MongoDB 2.4 with
authentication.
Prerequisites
Connect to the mongod or mongos instance as a user with access to create users in the database. See db.createUser()
method page for more information.
MongoDB 2.6
To monitor MongoDB 2.6 instances, including dbStats 2 and database profiling information 3 , the monitoring agent
must authenticate to the database as a user with the following access:
Required Role
clusterMonitor role on the admin database
For mixed MongoDB versions, the specified access is inadequate to monitor deployments of since the user cannot access the local database needed for mixed deployments. Monitoring a mixed deployment as a user with the specified
access will produce an authorization error that will appear in the mongod logs.
The monitoring agent can recover from this error, and you may safely ignore these messages in the mongod log.
MongoDB 2.4
Monitor without Database Profiling To monitor MongoDB 2.4 instances, including dbStats operations, the
agent must authenticate as a user with the following access:
Required Roles
clusterAdmin role on the admin database
readAnyDatabase role on the admin database
However, a user with the specified access cannot monitor with profiling. If this user tries to monitor with profiling, the
mongod log file may report the following message at the default logging level:
command denied: { profile: -1 }
You can ignore this message if you do not want MMS to collect profile data. If you want to collect profile data,
configure MMS monitoring as specified in Monitor with Database Profiling.
Monitor with Database Profiling To monitor MongoDB 2.4 databases with database profiling 1 , the agent must
authenticate as a user with the following access:
Required Roles
clusterAdmin role on the admin database
readAnyDatabase role on the admin database
dbAdminAnyDatabase roles in the admin database
2
3
Monitoring without dbStats excludes database storage, records, indexes, and other statistics.
Profiling captures in-progress read and write operations, cursor operations, and database command information about the database.
215
Monitor without dbStats To monitor MongoDB 2.4 databases without dbStats 2 , the agent must authenticate
as a user with the following access:
Required Role
clusterAdmin role on the admin database
Authentication Mechanisms
To authenticate, create the user in MongoDB with the appropriate access. The authentication method that the MongoDB deployment uses determines how to create the user as well as determine any additional agent configuration:
• For MONGODB-CR (MongoDB Challenge-Response) authentication, see Configure Backup Agent for
MONGODB-CR.
• For LDAP authentication, see Configure Backup Agent for LDAP Authentication.
• For Kerberos authentication, see Configure the Backup Agent for Kerberos.
Configure Monitoring Agent for Access Control
If your MongoDB deployment enforces access control, the Monitoring Agent must authenticate to MongoDB as a user
with the proper access.
Configure for MONGODB-CR Procedure to configure the Monitoring Agent for MongoDB deployments using MongoDB Challenge and Response authentication.
Configure for LDAP Procedure to configure the Monitoring Agent for MongoDB deployments using LDAP authentication.
Configure for Kerberos Procedure to configure the Monitoring Agent for MongoDB deployments using Kerberos
authentication.
Add Monitoring Agent User for MONGODB-CR
MMS Monitoring Agent can use the MongoDB Challenge-Response (MONGODB-CR) to authenticate to hosts that
enforce access control.
To authenticate using MONGODB-CR, create a user in the admin database with the appropriate roles in MongoDB.
Prerequisites There are additional authentication configuration requirements for MMS Monitoring when using
MongoDB 2.4 with authentication. See Required Access for Monitoring Agent for more information.
MongoDB 2.6 To monitor MongoDB 2.6 instances, create a user in the admin database with an operation that
resembles the following:
use admin
db.createUser(
{
user: "<username>",
pwd: "<password>",
roles: [ { role: "clusterMonitor", db: "admin" } ]
}
)
See Access Control for MongoDB 2.6 for more information on the required access.
216
MongoDB 2.4 To monitor MongoDB 2.4 instances, create a user in the admin database with an operation that
resembles the following:
use admin
db.addUser(
{
user: "<username>",
pwd: "<password>",
roles: [
"clusterAdmin",
"readAnyDatabase"
]
}
)
See Access Control for MongoDB 2.4 without Profiling for more information on the required access.
Monitor with Database Profiling To monitor MongoDB 2.4 databases with database profiling, create a user in the
admin database with an operation that resembles the following:
use admin
db.addUser(
{
user: "<username>",
pwd: "<password>",
roles: [
"clusterAdmin",
"readAnyDatabase",
"dbAdminAnyDatabase"
]
}
)
See Access Control for MongoDB 2.4 with Profiling for more information on the required access.
Monitor without dbStats To monitor MongoDB 2.4 instance without dbStats, create a user in the admin
database with an operation that resembles the following:
use admin
db.addUser(
{
user: "<username>",
pwd: "<password>",
roles: [ "clusterAdmin" ]
}
)
See Access Control for MongoDB 2.4 without dbStats for more information on the required access.
Host Settings In addition to adding the agent as a MongoDB user, you must also specify the host’s authentication
settings. You can specify the host’s authentication settings when adding the host, or you can edit the settings for an
existing host.
Configure Monitoring Agent for LDAP
217
Overview If your MongoDB deployment enforces access control, the Monitoring Agent must authenticate to MongoDB as a user with the proper access.
LDAP is a standard protocol for accessing user credential data. Starting in version 2.6, MongoDB Enterprise provides
an LDAP (plain) authentication mechanism that allows clients to authenticate to MongoDB deployments using LDAP.
Monitoring Agents support authenticating to MongoDB instances using LDAP.
If your MongoDB deployment uses LDAP to authenticate users, to authenticate the Monitoring Agent, create a user
in the $external database with the appropriate roles in MongoDB.
Considerations You must configure LDAP authentication separately for the Monitoring Agent and for the Backup
Agent.
You can configure LDAP authentication when adding a host or later by editing the host.
Prerequisites There are additional authentication configuration requirements for MMS Monitoring when using
MongoDB 2.4 with authentication. See Required Access for Monitoring Agent for more information.
Create User in MongoDB To monitor MongoDB 2.6 instances that are using LDAP authentication, add a user to
the $external database in MongoDB with the appropriate roles. The $external database allows mongod to
consult an external source (e.g. LDAP) to authenticate.
db.getSiblingDB("$external").createUser(
{
user : "<username>",
roles: [ { role: "clusterMonitor", db: "admin" } ]
}
)
See Access Control for MongoDB 2.6 for more information on the required access.
Host Settings In addition to adding the agent as a MongoDB user, you must also specify the host’s authentication
settings. You can specify the host’s authentication settings when adding the host, or you can edit the settings for an
existing host.
Configure the Monitoring Agent for Kerberos
Enterprise Feature
Only MongoDB Enterprise provides support for Kerberos.
Kerberos is a generic authentication protocol available starting from MongoDB Enterprise version 2.6. The Monitoring
Agents can authenticate to hosts using Kerberos.
Prerequisites You must configure the Kerberos Key Distribution Center (KDC) to grant tickets that are valid for at
least four hours. The Monitoring Agent takes care of periodically renewing the ticket. The KDC service provides
session tickets and temporary session keys to users and computers.
There are additional authentication configuration requirements for MMS Monitoring when using MongoDB 2.4 with
authentication. See Required Access for Monitoring Agent for more information.
218
Create Kerberos Principal If you are running both the Monitoring Agent and the Backup Agent on the same server,
then both agents must connect as the same Kerberos Principal.
Step 1: Create or choose a Kerberos principal. Create or choose a Kerberos principal for the MMS Monitoring
and/or MMS Backup agent.
Step 2: Generate a keytab for the Kerberos principal. Generate a keytab for the Kerberos principal and copy it to
the system where the agent runs. Ensure the user that will run the agent is the same user that owns the keytab file.
Create MongoDB User for the Principal If you are running both the Monitoring Agent and the Backup Agent on
the same server, then both agents must connect as the same Kerberos Principal.
Add a Kerberos principal, <username>@<KERBEROS REALM> or <username>/<instance>@<KERBEROS
REALM>, to MongoDB in the $external database. Specify the Kerberos realm in all uppercase. The $external
database allows mongod to consult an external source (e.g. Kerberos) to authenticate.
Kerberos Principal for the Monitoring Agent For example, to add the principal for just the Monitoring Agent:
use $external
db.createUser(
{
user: "<Kerberos Principal>",
roles: [ { role: "clusterMonitor", db: "admin" } ]
}
)
See MongoDB 2.6 for more information on the required access for the Monitoring Agent.
Kerberos Principal for the Monitoring Agent and Backup Agent For example, to add the same principal for both
the Monitoring Agent and the Backup Agent, specify required access for both agents. The following example specifies
access required to connect to MongoDB 3.0 or greater.
use $external
db.createUser(
{
user: "<Kerberos Principal>",
roles: [
{ role: "clusterMonitor", db: "admin" },
{ role: "backup", db: "admin" }
]
}
)
See MongoDB 2.6 and MongoDB 3.0 and Later for more information on the required access for the Monitoring Agent
and the Backup Agent.
Edit Agent Configuration File Edit the /etc/mongodb-mms/monitoring-agent.config file.
Step 1: Set the krb5Principal Set the krb5Principal to the name of the Kerberos principal. For example:
[email protected]
219
Step 2: Set the kerb5Keytab Set the kerb5Keytab value to the complete absolute path of the keytab file. For
example:
krb5Keytab=/etc/mongodb-mms/mmsagent.keytab
Step 3: Restart the agent.
Host Settings In addition to adding the agent as a MongoDB user, you must also specify the host’s authentication
settings. You can specify the host’s authentication settings when adding the host, or you can edit the settings for an
existing host.
Configure Monitoring Agent for SSL
Overview
MMS supports SSL for encrypting the following connections made by Monitoring Agents:
• Connections between the Monitoring Agents and MongoDB instances.
• Connections between the Monitoring Agents and MMS.
Prerequisite
To configure the agent to use SSL, you must have a trusted CA certificate that signed the MongoDB instance’s certificate.
Procedures
Connections between Agents and MongoDB Instances To use SSL for the Monitoring Agent’s connection to a
MongoDB host, specify the host’s SSL settings when adding the host or by editing the host’s settings.
Then configure the agent to use SSL:
Step 1: Specify path to trusted CA certificate. If your MongoDB deployment uses SSL, then you must configure
the Monitoring Agent to use SSL. To configure the agent to use SSL, you must have a trusted CA certificate that signed
the MongoDB instance’s certificate.
In
the
agent’s
install
directory,
edit
the
monitoring-agent.config
file
to
set
sslTrustedServerCertificates field to the path of a file containing one or more certificates in PEM
format. For example:
sslTrustedServerCertificates=/path/to/mongodb-certs.pem
By default, to connect to MongoDB instances using SSL requires a valid trusted certificate. For testing purposes,
however, you can set the sslRequireValidServerCertificates setting to False to bypass this check.
This configuration is not recommended for production use as it makes the connection insecure.
For additional information on these settings, see MongoDB SSL Settings.
Step 2: Restart agent.
220
Connections between Agents and MMS The Monitoring Agents always use SSL when connecting to MMS.
For the settings the Monitoring Agent uses to connect to MMS, see Configure mongod and mongos for SSL.
Configure Hardware Monitoring with munin-node
Overview
To chart the hardware statistics collected with Munin, MMS supports the following munin-node plugins:
• cpu plugin, which creates the cputime chart.
• iostat plugin, which creates the iostat chart.
• iostat_ios plugin, which creates the iotime chart.
Install the munin-node Package
You must install the munin-node package on all of the host systems that you wish to monitor. Ensure that the
Monitoring Agent can connect to the munin-node process on port 4949 of the monitored host to collect data.
Note: munin-node, and hardware monitoring is only available for MongoDB instances running on Linux hosts.
On Debian and Ubuntu systems, issue the following command to install munin-node:
sudo apt-get install munin-node
To install munin-node on Red Hat, CentOS, and Fedora systems, issue the following command:
yum install munin-node
Note: For Red Hat and CentOS 6.8 systems, you will need to install the EPEL repository before installing
munin-node. To install the EPEL repository, issue the following command:
rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
Configure munin-node
When installation is complete, ensure that munin-node:
• is running. Use the command, “ps -ef | grep "munin"” to confirm. If the process is not running, issue
the command “/etc/init.d/munin-node start”.
• will start following the next system reboot. This is the default behavior on most Debian-based systems. Red Hat
and related distributions should use the “chkconfig” command, to configure this behavior (i.e. “chkconfig
munin-node on”)
• is accessible from the system running the agent. munin-node uses port 4949, which needs to be open on the
monitored system, so the agent can access this data source. Use the following procedure to test access:
telnet [HOSTNAME] 4949
fetch iostat
fetch iostat_ios
fetch cpu
221
Replace [HOSTNAME] with the hostname of the monitored system. Run these commands from the system
where the Monitoring Agent is running. If these “fetch” commands return data, then munin-node is running
and accessible by the Monitoring Agent.
Note: On some platforms, munin-node does not have all required plugins enabled.
For CentOS and Ubuntu, the munin-node package does not have the iostat and iostat_ios plugins enabled.
Use the following operation to enable these plugins:
sudo ln -s /usr/share/munin/plugins/iostat /etc/munin/plugins/iostat
sudo ln -s /usr/share/munin/plugins/iostat_ios /etc/munin/plugins/iostat_ios
sudo /etc/init.d/munin-node restart
If munin-node is running but inaccessible, make sure that you have access granted for the system running the Monitoring Agent and that no firewalls block the port between munin-node and the Monitoring Agent. You may find the munin-node configuration at /etc/munin-node/munin-node.conf,
/etc/munin/munin-node.conf, or /etc/munin-node.conf, depending on your distribution.
Additional Considerations for munin-node
• If you have numbered disk devices (e.g.
/dev/sda1 and /dev/sda2) then you will need to
configure support for numbered disk in the munin iostat plugin.
Find the configuration file at
/etc/munin/plugin-conf.d/munin-node or a similar path, and add the following value:
[iostat]
env.SHOW_NUMBERED 1
• If you have Munin enabled and do not have iostat ios data in your Munin charts, your munin-node may
not have write access to required state files in its munin/plugin-state/ directory. See the munin-node
plugin log (i.e. /var/log/munin/munin-node.log or similar depending on your distribution) for more
information.
The full path of this state directory
/var/lib/munin/plugin-state/.
depends
on
the
system,
but
is
typically
Run the following command sequence to correct this issue. The last command in the sequence changes permissions for the /var/lib/munin/plugin-state/ directory to ensure access for the munin-node
plugins. Depending on your setup, you might have to use a different permission level:
touch /var/lib/munin/plugin-state/iostat-ios.state
chown -R [username]:[group] /var/lib/munin/plugin-state/
chmod -R 766 /var/lib/munin/plugin-state/
Replace [username] and [group] with the username and group that the munin-node process runs with.
• Add
the
host
running
the
Monitoring
Agent
to
the
allow
directive
in
the
/etc/munin-node/munin-node.conf file. The allow directive lists hosts allowed to query the
munin-node process. Otherwise, traffic from the MMS host will be allowed via firewall but will not be collected
by munin.
If you encounter any other problems, check the log files for munin-node to ensure that there are no errors with
Munin. munin-node writes logs files in the /var/log/ directory on the monitored system.
See also:
Munin Diagnostics.
222
Start or Stop the Monitoring Agent
Overview
For maintenance or troubleshooting purposes, you may want to temporarily shut down or restart MMS‘s Monitoring
Agent. However, for proper operation of MMS your MMS group must have at least one Monitoring Agent running.
The group needs only one Monitoring Agent running.
Procedures
Start the Monitoring Agent The procedure to Install the Monitoring Agent includes a step to start the agent. If you
must restart the agent, use the following procedure.
Start an Agent Installed with an rpm Package If you installed the Monitoring Agent using an rpm package, such
as on RHEL, CentOS, or SUSE, issue the following command to start the agent:
sudo service mongodb-mms-monitoring-agent start
Start an Agent Installed with a deb Package If you installed the Monitoring Agent using a deb package, as on
Ubuntu, issue the following command to start the agent:
sudo start mongodb-mms-monitoring-agent
Start an Agent Installed with a tar File Use this command if you installed to Linux or OSX using a tar file.
Issue the following command from the directory to which you installed the Monitoring Agent:
nohup ./mongodb-mms-monitoring-agent- >> monitoring-agent.log 2>&1 &
Start the Monitoring Agent on Windows In Windows Control Panel, open Administrative Tools and
then Services. In the list of services, select MMS Monitoring Agent. Select the Action menu and select
Start.
Stop the Monitoring Agent You must have at least one Monitoring Agent running to monitor your deployment.
Stop an Agent Installed with an rpm Package If you installed the Monitoring Agent using an rpm package, such
as on RHEL, CentOS, or SUSE, issue the following command to stop the agent:
sudo service mongodb-mms-monitoring-agent stop
Stop an Agent Installed with a deb Package If you installed the Monitoring Agent using a deb package, as on
Ubuntu, issue the following command to stop the agent:
sudo stop mongodb-mms-monitoring-agent
Stop an Agent Installed with a tar File If you installed to Linux or OSX using a tar file, issue the following
command to stop the Monitoring Agent:
223
pkill -f mongodb-mms-monitoring-agent
Stop the Monitoring Agent on Windows In Windows Control Panel, open Administrative Tools and
then Services. In the list of services, select MMS Monitoring Agent. Select the Action menu and select
Stop.
Remove Monitoring Agents from MMS
MMS displays active Monitoring Agents on the Agents page in the Administration tab. The page displays agents that
have been active in the last 24 hours. If an agent fails to report to MMS for more than 24 hours, MMS removes the
agent from the Agents page.
Remove from MMS
To remove a Monitoring Agent from MMS, stop the agent and then wait 24 hours.
Delete from the Server
To delete the Monitoring Agent from a Linux or OSX server, stop the agent and then remove the
mongodb-mms-monitoring-agent file from the /usr/bin directory. If you installed the agent using a
tar.gz file, the agent will be in the directory you chose during installation.
To delete the Monitoring Agent from a Windows server, stop the agent and then use the Windows program uninstaller
to remove the MMS Monitoring Agent program.
10.3 Backup Agent
Install or Update the Agent Procedures for installing and updating the Backup Agent.
Backup Agent Configuration Documentation of the settings available in the Backup Agent configuration file.
Required Access for Backup Agent Details the permissions required for Backup Agent to use with MongoDB instances that enforce access control.
Configure the Agent for Access Control If MongoDB uses Access Control, create a MongoDB user for the Backup
Agent to use to authenticate and to determine the agent’s access.
Configure the Agent for SSL Configure the Backup Agent to support SSL.
Start or Stop the Agent Procedures to start and stop the Backup Agent.
Remove the Agent Remove the Backup Agent.
Install Backup Agent
The MMS Backup Agent polls the primary MongoDB instance of every backup-enabled replica set and transmits the
operations to the MMS service.
The Backup Agent relies on the MMS Monitoring Agent to populate the list of sharded clusters and replica sets eligible
for backup. If the appropriate hosts are not added, or the Monitoring Agent is not being correctly run, the lists may
be incomplete or out-of-date. If you have not already installed and configured MMS Monitoring, please refer to the
Install Monitoring Agent documentation.
224
Install with RPM Packages Install and start the Backup Agent using an rpm package.
Install on Ubuntu Install and start the Backup Agent on Ubuntu using a deb package.
Install on Other Linux Systems Install and start the Backup Agent on other Linux systems using the tar.gz archive
packages.
Install on OS X Install and start the Backup Agent on OS X.
Install on Windows Install and start the Backup Agent on Windows.
Install or Update the Backup Agent with rpm Packages
Overview The MMS Backup Agent polls the primary MongoDB instance of every backup-enabled replica set and
transmits the operations to the MMS service.
The Backup Agent relies on the MMS Monitoring Agent to populate the list of sharded clusters and replica sets eligible
for backup. If the appropriate hosts are not added, or the Monitoring Agent is not being correctly run, the lists may
be incomplete or out-of-date. If you have not already installed and configured MMS Monitoring, please refer to the
Install Monitoring Agent documentation.
Considerations
MongoDB Requirements MMS only supports backing up replica sets and sharded cluster, and does not support
backing up standalone instances.
MMS only supports backup for replica sets that run MongoDB 2.0 or later.
MMS only supports backup for sharded clusters that run MongoDB 2.4 or later.
All backed up replica sets and config servers should maintain oplog entries for at least 1 hour over the last 24 hour
period.
Agent Architecture To avoid resource contention, run the agent on a host other than the hosts where the MongoDB
instances are running. Be sure the agent can access the MongoDB hosts.
Running on Amazon EC2 If you run the Backup Agent on Amazon EC2, do not use the t1.micro instance type,
which has a CPU scheduling policy that does not typically provide sufficient capacity to support a Backup Agent for
a production deployment. Use a larger instance type instead.
Prerequisites
Monitoring Agent
Install and configure the MMS Monitoring, as described in the Monitoring Agent documentation.
Firewall If your MongoDB instances operate within a firewall, configure your network infrastructure to allow outbound connections on port 443 (SSL) to api-backup.mongodb.com.
Access Control If you use MMS Backup with a MongoDB deployment that uses authentication, before installing
the MMS Backup Agent, you must create a user in MongoDB with the appropriate access. See Configure Backup
Agent for Access Control.
225
Backup Directory After you install the Backup Agent, do not use the agent’s directory location for anything other
than the agent itself. The Backup Agent periodically deletes the contents of its root directory.
Procedures This section includes procedures for both installing and updating the Backup Agent on RHEL, CentOS,
SUSE, Amazon Linux, and other systems that use rpm packages.
Install the Backup Agent with an rpm Package Use this procedure to install the agent on RHEL, CentOS, SUSE,
Amazon Linux, and other systems that use rpm packages.
Step 1: Download the latest version of the Backup Agent package. With a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.x86_64.rpm
Step 2: Install the Backup Agent package. Issue the following command:
sudo rpm -U mongodb-mms-backup-agent-latest.x86_64.rpm
Step 3: Retrieve the API key for your MMS group. In the Administration tab on the Agent page, click the box for
your operating system. MMS will then display a procedure that includes a step to set your API key. The step displays
the actual API key used by your MMS group. Copy the key.
Step 4:
Configure
the
backup-agent.config
file with
the API key. In
/etc/mongodb-mms/backup-agent.config file, set the mmsApiKey property to your API key.
the
Step 5: Optional: For SUSE 11+ deployments only, configure the sslTrustedMMSServerCertificate
property. If you are deploying on SUSE, you must configure the sslTrustedMMSServerCertificate setting. All other users should omit this step.
Enter the following property and value in the /etc/mongodb-mms/backup-agent.config file:
sslTrustedMMSServerCertificate=/etc/ssl/certs/UTN_USERFirst_Hardware_Root_CA.pem
Save and close the file.
Step 6: Start the Backup Agent. Issue the following command:
sudo service mongodb-mms-backup-agent start
Update the Backup Agent with an rpm Package Use this procedure to update the agent on RHEL, CentOS, SUSE,
Amazon Linux, and other systems that use rpm packages.
Step 1: Download the latest version of the Backup Agent package. With a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.x86_64.rpm
226
Step 2: Install the Backup Agent package. Issue the following command:
sudo rpm -U mongodb-mms-backup-agent-latest.x86_64.rpm
Step 3: Start the Backup Agent. Issue the following command:
sudo service mongodb-mms-backup-agent start
Next Steps After you have successfully installed the Backup Agent, see Activate Backup to enable backup for a
replica set.
Additional Information The README included with the downloaded package also provides information about the
Backup Agent.
For details about backup operations, see Backup FAQs.
Install or Update the Backup Agent with deb Packages
Overview The MMS Backup Agent polls the primary MongoDB instance of every backup-enabled replica set and
transmits the operations to the MMS service.
The Backup Agent relies on the MMS Monitoring Agent to populate the list of sharded clusters and replica sets eligible
for backup. If the appropriate hosts are not added, or the Monitoring Agent is not being correctly run, the lists may
be incomplete or out-of-date. If you have not already installed and configured MMS Monitoring, please refer to the
Install Monitoring Agent documentation.
Considerations
MongoDB Requirements MMS only supports backing up replica sets and sharded cluster, and does not support
backing up standalone instances.
MMS only supports backup for replica sets that run MongoDB 2.0 or later.
MMS only supports backup for sharded clusters that run MongoDB 2.4 or later.
All backed up replica sets and config servers should maintain oplog entries for at least 1 hour over the last 24 hour
period.
Agent Architecture To avoid resource contention, run the agent on a host other than the hosts where the MongoDB
instances are running. Be sure the agent can access the MongoDB hosts.
Running on Amazon EC2 If you run the Backup Agent on Amazon EC2, do not use the t1.micro instance type,
which has a CPU scheduling policy that does not typically provide sufficient capacity to support a Backup Agent for
a production deployment. Use a larger instance type instead.
Prerequisites
Monitoring Agent
Install and configure the MMS Monitoring, as described in the Monitoring Agent documentation.
227
Firewall If your MongoDB instances operate within a firewall, configure your network infrastructure to allow outbound connections on port 443 (SSL) to api-backup.mongodb.com.
Access Control If you use MMS Backup with a MongoDB deployment that uses authentication, before installing
the MMS Backup Agent, you must create a user in MongoDB with the appropriate access. See Configure Backup
Agent for Access Control.
Backup Directory After you install the Backup Agent, do not use the agent’s directory location for anything other
than the agent itself. The Backup Agent periodically deletes the contents of its root directory.
Procedures This section includes procedures for installing and updating the Backup Agent on Ubuntu with deb
packages. For Debian systems, use the Install or Update the Backup Agent from an Archive procedure.
Install the Backup Agent with a deb Package
Step 1: Download the latest version of the Backup Agent package. From a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent_latest_amd64.deb
Step 2: Install the Backup Agent package. Issue the following command:
sudo dpkg -i mongodb-mms-backup-agent_latest_amd64.deb
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, select
your the approriate link for the Backup agent and your operating system. MMS will then display a procedure that
includes a step to set your MMS API key. The step displays the actual MMS API key used by your MMS group. Copy
the key.
Step 4:
Configure
the
backup-agent.config
file with
the API key. In
/etc/mongodb-mms/backup-agent.config file, set the mmsApiKey property to your API key.
the
Step 5: Start the Backup Agent. Issue the following command:
sudo start mongodb-mms-backup-agent
Update the Backup Agent with a deb Package
Step 1: Download the latest version of the Backup Agent package. From a system shell, issue the following
command:
curl -OL https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent_latest_amd64.deb
228
Step 2: If your current Backup Agent has a version number earlier that 2.0, purge the existing agent. Perform
this step only if your current agent’s version is earlier than 2.0. To purge the existing Backup Agent, issue the following
command:
sudo dpkg -P mongodb-mms-backup-agent
Step 3: Install the Backup Agent package. Issue the following command:
sudo dpkg -i mongodb-mms-backup-agent_latest_amd64.deb
Step 4: Start the Backup Agent. Issue the following command:
sudo start mongodb-mms-backup-agent
Next Steps After you have successfully installed the Backup Agent, see Activate Backup to enable backup for a
replica set.
Additional Information The README included with the downloaded package also provides information about the
Backup Agent.
For details about backup operations, see Backup FAQs.
Install or Update the Backup Agent from an Archive
Overview The MMS Backup Agent polls the primary MongoDB instance of every backup-enabled replica set and
transmits the operations to the MMS service.
The Backup Agent relies on the MMS Monitoring Agent to populate the list of sharded clusters and replica sets eligible
for backup. If the appropriate hosts are not added, or the Monitoring Agent is not being correctly run, the lists may
be incomplete or out-of-date. If you have not already installed and configured MMS Monitoring, please refer to the
Install Monitoring Agent documentation.
Considerations
MongoDB Requirements MMS only supports backing up replica sets and sharded cluster, and does not support
backing up standalone instances.
MMS only supports backup for replica sets that run MongoDB 2.0 or later.
MMS only supports backup for sharded clusters that run MongoDB 2.4 or later.
All backed up replica sets and config servers should maintain oplog entries for at least 1 hour over the last 24 hour
period.
Agent Architecture To avoid resource contention, run the agent on a host other than the hosts where the MongoDB
instances are running. Be sure the agent can access the MongoDB hosts.
Running on Amazon EC2 If you run the Backup Agent on Amazon EC2, do not use the t1.micro instance type,
which has a CPU scheduling policy that does not typically provide sufficient capacity to support a Backup Agent for
a production deployment. Use a larger instance type instead.
229
Prerequisites
Monitoring Agent
Install and configure the MMS Monitoring, as described in the Monitoring Agent documentation.
Firewall If your MongoDB instances operate within a firewall, configure your network infrastructure to allow outbound connections on port 443 (SSL) to api-backup.mongodb.com.
Access Control If you use MMS Backup with a MongoDB deployment that uses authentication, before installing
the MMS Backup Agent, you must create a user in MongoDB with the appropriate access. See Configure Backup
Agent for Access Control.
Backup Directory After you install the Backup Agent, do not use the agent’s directory location for anything other
than the agent itself. The Backup Agent periodically deletes the contents of its root directory.
Procedures This section includes procedures for installing and updating the Backup Agent on a Linux system not
listed in the Agent Downloads list on the Agents page in the Administration tab.
Install the Backup Agent from a tar.gz Archive
Step 1: Download the latest version of the Backup Agent archive. On a system shell, issue a command that
resembles the following. Replace linux_x86_64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.linux_x86_64.t
Step 2: Install the Backup Agent. To install the agent, extract the archive using a command that resembles the
following. Replace linux_x86_64 with your platform, as needed:
tar -xf mongodb-mms-backup-agent-latest.linux_x86_64.tar.gz
The Backup Agent is installed.
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, select
your the approriate link for the Backup agent and your operating system. MMS will then display a procedure that
includes a step to set your MMS API key. The step displays the actual MMS API key used by your MMS group. Copy
the key.
Step 4: Edit the local.config file to include your MMS API key. In the directory where you installed the
Backup Agent, locate and open the local.config file. Enter your API key as the value for the mmsApiKey
setting.
Step 5: Optional: Configure the agent to use a proxy server. If the agent will connect to MMS via a proxy
server, you must specify the server in the http_proxy environment variable. To specify the server, use the export
command, as in the following example:
export http_proxy="http://proxy.example.com:9000"
To connect through a proxy, you must install the agent from a .tar.gz file, not from a .deb or .rpm file.
230
Step 6: Start the Backup Agent. Issue the following command:
nohup ./mongodb-mms-backup-agent >> backup-agent.log 2>&1 &
Update the Backup Agent from a tar.gz Archive
Step 1: Stop any currently running Backup Agents. Issue the following command with the system shell:
pkill -f mongodb-mms-backup-agent
Step 2: Download the latest version of the Backup Agent archive. On a system shell, issue a command that
resembles the following. Replace linux_x86_64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.linux_x86_64.t
Step 3: Install the Backup Agent. To install the agent, extract the archive using a command that resembles the
following. Replace linux_x86_64 with your platform, as needed:
tar -xf mongodb-mms-backup-agent-latest.linux_x86_64.tar.gz
The Backup Agent is installed.
Step 4: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, select
your the approriate link for the Backup agent and your operating system. MMS will then display a procedure that
includes a step to set your MMS API key. The step displays the actual MMS API key used by your MMS group. Copy
the key.
Step 5: Edit the local.config file to include your MMS API key. In the directory where you installed the
Backup Agent, locate and open the local.config file. Enter your API key as the value for the mmsApiKey
setting.
Step 6: Start the Backup Agent. Issue the following command:
nohup ./mongodb-mms-backup-agent >> backup-agent.log 2>&1 &
Next Steps After you have successfully installed the Backup Agent, see Activate Backup to enable backup for a
replica set.
Additional Information If you installed the Backup Agent from the tar.gz archives, see
http://docs.mms.mongodb.com//tutorial/rotate-agent-log-files to configure log rotation.
The README included with the downloaded package also provides information about the Backup Agent.
For details about backup operations, see Backup FAQs.
231
Install or Update the Backup Agent on OS X
Overview The MMS Backup Agent polls the primary MongoDB instance of every backup-enabled replica set and
transmits the operations to the MMS service.
The Backup Agent relies on the MMS Monitoring Agent to populate the list of sharded clusters and replica sets eligible
for backup. If the appropriate hosts are not added, or the Monitoring Agent is not being correctly run, the lists may
be incomplete or out-of-date. If you have not already installed and configured MMS Monitoring, please refer to the
Install Monitoring Agent documentation.
Considerations
MongoDB Requirements MMS only supports backing up replica sets and sharded cluster, and does not support
backing up standalone instances.
MMS only supports backup for replica sets that run MongoDB 2.0 or later.
MMS only supports backup for sharded clusters that run MongoDB 2.4 or later.
All backed up replica sets and config servers should maintain oplog entries for at least 1 hour over the last 24 hour
period.
Agent Architecture To avoid resource contention, run the agent on a host other than the hosts where the MongoDB
instances are running. Be sure the agent can access the MongoDB hosts.
Running on Amazon EC2 If you run the Backup Agent on Amazon EC2, do not use the t1.micro instance type,
which has a CPU scheduling policy that does not typically provide sufficient capacity to support a Backup Agent for
a production deployment. Use a larger instance type instead.
Prerequisites
Monitoring Agent
Install and configure the MMS Monitoring, as described in the Monitoring Agent documentation.
Firewall If your MongoDB instances operate within a firewall, configure your network infrastructure to allow outbound connections on port 443 (SSL) to api-backup.mongodb.com.
Access Control If you use MMS Backup with a MongoDB deployment that uses authentication, before installing
the MMS Backup Agent, you must create a user in MongoDB with the appropriate access. See Configure Backup
Agent for Access Control.
Backup Directory After you install the Backup Agent, do not use the agent’s directory location for anything other
than the agent itself. The Backup Agent periodically deletes the contents of its root directory.
Procedures
Install the Backup Agent On OS X Use the following procedure to install the agent on OS X:
232
Step 1: Download the latest version of the Backup Agent archive. On a system shell, issue a command that
resembles the following. Replace linux_x86_64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.osx_x86_64.tar
Step 2: Install the Backup Agent. To install the agent, extract the archive using a command that resembles the
following. Replace linux_x86_64 with your platform, as needed:
tar -xf mongodb-mms-backup-agent-latest.osx_x86_64.tar.gz
The Backup Agent is installed.
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, select
your the approriate link for the Backup agent and your operating system. MMS will then display a procedure that
includes a step to set your MMS API key. The step displays the actual MMS API key used by your MMS group. Copy
the key.
Step 4: Edit the local.config file to include your MMS API key. In the directory where you installed the
Backup Agent, locate and open the local.config file. Enter your API key as the value for the mmsApiKey
setting.
Step 5: Optional: Configure the agent to use a proxy server. If the agent will connect to MMS via a proxy
server, you must specify the server in the http_proxy environment variable. To specify the server, use the export
command, as in the following example:
export http_proxy="http://proxy.example.com:9000"
To connect through a proxy, you must install the agent from a .tar.gz file, not from a .deb or .rpm file.
Step 6: Start the Backup Agent. Issue the following command:
nohup ./mongodb-mms-backup-agent >> backup-agent.log 2>&1 &
Update the Backup Agent Use the following procedure to update the agent on OS X:
Step 1: Download the latest version of the Backup Agent archive. On a system shell, issue a command that
resembles the following. Replace linux_x86_64 with your platform, as needed:
curl -OL https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.osx_x86_64.tar
Step 2: Install the Backup Agent. To install the agent, extract the archive using a command that resembles the
following. Replace linux_x86_64 with your platform, as needed:
tar -xf mongodb-mms-backup-agent-latest.osx_x86_64.tar.gz
The Backup Agent is installed.
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, select
your the approriate link for the Backup agent and your operating system. MMS will then display a procedure that
includes a step to set your MMS API key. The step displays the actual MMS API key used by your MMS group. Copy
the key.
233
Step 4: Edit the local.config file to include your MMS API key. In the directory where you installed the
Backup Agent, locate and open the local.config file. Enter your API key as the value for the mmsApiKey
setting.
Step 5: Optional: Configure the agent to use a proxy server. If the agent will connect to MMS via a proxy
server, you must specify the server in the http_proxy environment variable. To specify the server, use the export
command, as in the following example:
export http_proxy="http://proxy.example.com:9000"
To connect through a proxy, you must install the agent from a .tar.gz file, not from a .deb or .rpm file.
Step 6: Start the Backup Agent. Issue the following command:
nohup ./mongodb-mms-backup-agent >> backup-agent.log 2>&1 &
Next Steps After you have successfully installed the Backup Agent, see Activate Backup to enable backup for a
replica set.
Additional Information The README included with the downloaded package also provides information about the
Backup Agent.
For details about backup operations, see Backup FAQs.
Install or Update the Backup Agent on Windows
Overview The MMS Backup Agent polls the primary MongoDB instance of every backup-enabled replica set and
transmits the operations to the MMS service.
The Backup Agent relies on the MMS Monitoring Agent to populate the list of sharded clusters and replica sets eligible
for backup. If the appropriate hosts are not added, or the Monitoring Agent is not being correctly run, the lists may
be incomplete or out-of-date. If you have not already installed and configured MMS Monitoring, please refer to the
Install Monitoring Agent documentation.
Considerations
MongoDB Requirements MMS only supports backing up replica sets and sharded cluster, and does not support
backing up standalone instances.
MMS only supports backup for replica sets that run MongoDB 2.0 or later.
MMS only supports backup for sharded clusters that run MongoDB 2.4 or later.
All backed up replica sets and config servers should maintain oplog entries for at least 1 hour over the last 24 hour
period.
Agent Architecture To avoid resource contention, run the agent on a host other than the hosts where the MongoDB
instances are running. Be sure the agent can access the MongoDB hosts.
234
Running on Amazon EC2 If you run the Backup Agent on Amazon EC2, do not use the t1.micro instance type,
which has a CPU scheduling policy that does not typically provide sufficient capacity to support a Backup Agent for
a production deployment. Use a larger instance type instead.
Prerequisites
Monitoring Agent
Install and configure the MMS Monitoring, as described in the Monitoring Agent documentation.
Firewall If your MongoDB instances operate within a firewall, configure your network infrastructure to allow outbound connections on port 443 (SSL) to api-backup.mongodb.com.
Access Control If you use MMS Backup with a MongoDB deployment that uses authentication, before installing
the MMS Backup Agent, you must create a user in MongoDB with the appropriate access. See Configure Backup
Agent for Access Control.
Backup Directory After you install the Backup Agent, do not use the agent’s directory location for anything other
than the agent itself. The Backup Agent periodically deletes the contents of its root directory.
Procedures
Install the Backup Agent On Windows
Step 1: Download and run the latest version of the Backup Agent MSI file. To download the 64-bit MSI file, use
the following URL:
https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.windows_x86_64.msi
To download the 32-bit MSI file, use the following URL:
https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.windows_i386.msi
During installation, the installer prompts you to specify the folder for storing configuration and log files. It is strongly
advised that you encrypt or restrict access to this folder.
Step 2: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, select
your the approriate link for the Backup agent and your operating system. MMS will then display a procedure that
includes a step to set your MMS API key. The step displays the actual MMS API key used by your MMS group. Copy
the key.
Step 3: Edit the local.config file to include your MMS API key. In the directory where you installed the
Backup Agent, locate and open the local.config file. Enter your API key as the value for the mmsApiKey
setting.
Step 4: Edit the local.config file to include the hostname of the Backup server. In the Backup Agent
installation directory, open the local.config file and set the mothership property to hostname of the Backup
server.
235
Step 5: Start the Backup Agent. In Windows Control Panel, open Administrative Tools, and then
open Services.
In the list of services, select the MMS Backup Agent service. Select the Action menu and select Start.
Update the Backup Agent on Windows
Step 1: Stop all currently running Backup Agents. In Windows Control Panel, open Administrative
Tools and then Services. In the list of services, select MMS Backup Agent. Select the Action menu and
select Stop.
If you receive a message that your Backup Agent is out of date, make sure you are running an upgradeable version of
the Backup Agent. If you are running the version of the Backup Agent named MongoDBBackup, you must remove it
before upgrading. To check if you are running MongoDBBackup, issue the following command in an Administrative
command prompt:
sc query MongoDBBackup
If the command returns a result, you must remove the MongoDBBackup agent. To remove it, issue the following:
sc delete MongoDBBackup
Step 2: Download and run the latest version of the Backup Agent MSI file. To download the 64-bit MSI file, use
the following URL:
https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.windows_x86_64.msi
To download the 32-bit MSI file, use the following URL:
https://mms.mongodb.com/download/agent/backup/mongodb-mms-backup-agent-latest.windows_i386.msi
During installation, the installer prompts you to specify the folder for storing configuration and log files. It is strongly
advised that you encrypt or restrict access to this folder.
Step 3: Retrieve the MMS API key for your MMS group. In the Administration tab on the Agents page, select
your the approriate link for the Backup agent and your operating system. MMS will then display a procedure that
includes a step to set your MMS API key. The step displays the actual MMS API key used by your MMS group. Copy
the key.
Step 4: Edit the local.config file to include your MMS API key. In the directory where you installed the
Backup Agent, locate and open the local.config file. Enter your API key as the value for the mmsApiKey
setting.
Next Steps After you have successfully installed the Backup Agent, see Activate Backup to enable backup for a
replica set.
Additional Information The README included with the downloaded package also provides information about the
Backup Agent.
For details about Backup operations, see Backup FAQs.
236
Backup Agent Configuration
Configuration File
The name and location of the Backup Agent configuration file depend on the operating system:
• RHEL, CentOS, Amazon Linux, and Ubuntu all use a package manager to install the agent. The package
manager creates the following agent configuration file:
/etc/mongodb-mms/backup-agent.config
• OS X, Windows, and other Linux systems use either a tar or msi file for the installation. The Backup Agent
stores its configuration in the following file:
<installation directory>/local.config
Settings
Connection Settings For the Backup Agent communication with the MMS servers, the following connection settings are required:
mmsApiKey
Type: string
The MMS agent API key for a MMS group. To retrieve the key from the MMS interface, click the Administration
tab, then the Agents page, and then the link for your operating system. MMS will display the MMS API key
used by your MMS group.
For example:
mmsApiKey=abc123
mothership
Type: string
The hostname of the MMS Backup Web Server.
https
Type: boolean
Toggles communication with the MMS Backup web server over HTTPS.
HTTP Proxy Settings
httpProxy
New in version 1.4.4.34-1.
Type: string
To connect to the MMS HTTP Service via a proxy, specify the URL of the proxy. For example:
httpProxy=http://example-proxy.com:8080
MongoDB SSL Settings
SSL.
Specify these settings when the Backup Agent is connecting to MongoDB instances with
sslClientCertificate
Type: string
237
The path to the private key, client certificate, and optional intermediate certificates in PEM format. The agent will
use the client certificate when connecting to a MongoDB instance that uses SSL and requires client certificates,
i.e. that is running using the --sslCAFile option.
sslClientCertificatePassword
Type: string
The password needed to decrypt the private key in the sslClientCertificate file. This setting is only necessary if
the client certificate PEM file is encrypted.
sslTrustedServerCertificates
Type: string
The path on disk that contains the trusted certificate authority certificates in PEM format. These certificates will
verify the server certificate returned from any MongoDBs running with SSL. For example:
sslTrustedServerCertificates=/etc/mongodb-mms/mongodb-certs.pem
sslRequireValidServerCertificates
Type: boolean
Use this option to disable certificate verification by setting this value to false. That configuration is only
recommended for testing purposes as it makes connections susceptible to man-in-the-middle attacks.
MongoDB Kerberos Settings Specify these settings if the Backup Agent authenticates to hosts using Kerberos. For
more information, see http://docs.mms.mongodb.com//tutorial/connect-to-hosts-with-kerberos-authent
krb5Principal
Type: string
The Kerberos principal used by the agent. For example:
[email protected]
krb5Keytab
Type: string
The absolute path to Kerberos principal’s keytab file. For example:
krb5Keytab=/etc/mongodb-mms/backup-agent.keytab
gsappiServiceName
Type: string
The default service name used by MongoDB is mongodb can specify a custom service name with the
gssapiServiceName option.
MMS Server SSL Settings Advanced SSL settings used by the Backup Agent when communicating to the MMS
Backup Service.
sslTrustedMMSBackupServerCertificate
By default the Backup Agent will use the trusted root CAs installed on the system. If the agent cannot find the
trusted root CAs, configure these settings manually.
The path on disk that contains the trusted certificate authority certificates in PEM format. The agent will use this
certificate to verify that the agent is communicating with the designated MMS Backup Server. For example:
sslTrustedMMSBackupServerCertificate=/etc/mongodb-mms/mms-certs.pem
238
Required Access for Backup Agent
If your MongoDB deployment enforces access control, the MMS Backup Agent must authenticate to MongoDB as
a user with the proper access. To authenticate, create a user with the appropriate roles in MongoDB. The following
tutorials include instructions and examples for creating the MongoDB user:
• Configure Backup Agent for MONGODB-CR.
• Configure Backup Agent for LDAP Authentication.
• Configure the Backup Agent for Kerberos.
MongoDB user roles are separate from MMS user roles.
Considerations
To authenticate to sharded clusters, create shard-local users on each shard and create cluster-wide users:
• Create cluster users while connected to the mongos; these credentials persist to the config servers.
• Create shard-local users by connecting directly to the replica set for each shard.
MongoDB 3.0 and Later To backup MongoDB instances running 3.0 and later, the Backup Agent must authenticate
as a user with the following role:
Required Role
backup role on the admin database
MongoDB 2.6
To backup MongoDB 2.6 release series instances, the Backup Agent must be able to authenticate to with the following
roles:
Required Role
clusterAdmin role on the admin database
readAnyDatabase role on the admin database
userAdminAnyDatabase role on the admin database
readWrite role on the admin database
readWrite role on the local database
MongoDB 2.4
To backup MongoDB 2.4 release series instances, the Backup Agent must be able to authenticate to the database with
a user that has specified roles and otherDBRoles. Specifically, the user must have the following roles:
Required Role
clusterAdmin role on the admin database
readAnyDatabase role on the admin database
userAdminAnyDatabase role on the admin database
And the following otherDBRoles:
Required Role
readWrite role on the local database
readWrite role on the admin database
readWrite role on the config database
239
Authentication Mechanisms
To authenticate, create the user in MongoDB with the appropriate access. The authentication method that the MongoDB deployment uses determines how to create the user as well as determine any additional agent configuration:
• For MONGODB-CR (MongoDB Challenge-Response) authentication, see Configure Backup Agent for
MONGODB-CR.
• For LDAP authentication, see Configure Backup Agent for LDAP Authentication.
• For Kerberos authentication, see Configure the Backup Agent for Kerberos.
Configure Backup Agent for Access Control
If your MongoDB deployment enforces access control, the Backup Agent must authenticate to MongoDB as a user
with the proper access.
Configure for MONGODB-CR Procedure to configure the Backup Agent for MongoDB deployments using
MONGODB-CR authentication.
Configure for LDAP Procedure to configure the Backup Agent for MongoDB deployments using LDAP authentication.
Configure for Kerberos Procedure to configure the Backup Agent for MongoDB deployments using Kerberos authentication.
Configure Backup Agent for MONGODB-CR
If your MongoDB deployment enforces access control, the MMS Backup Agent must authenticate to MongoDB as a
user with the proper access.
To authenticate using MONGODB-CR, create a user in the admin database with the appropriate roles in MongoDB.
MongoDB user roles are separate from MMS user roles and are described in the MongoDB manual beginning with
the Authorization page.
Considerations To authenticate to sharded clusters, create shard-local users on each shard and create cluster-wide
users:
• Create cluster users while connected to the mongos; these credentials persist to the config servers.
• Create shard-local users by connecting directly to the replica set for each shard.
Prerequisites Connect to the mongod or mongos instance as a user with access to create users in the database. See
db.createUser() method page for more information.
3.0 and Later To backup MongoDB instances running 3.0 and later, create a user in the admin database with an
operation that resembles the following:
use admin
db.createUser(
{
user: "<username>",
pwd: "<password>",
roles: [ { role: "backup", db: "admin" } ]
240
}
)
See Access Control for MongoDB 3.0 for more information on the required access.
MongoDB 2.6 To backup MongoDB 2.6 release series instances, create a user in the admin database with an
operation that resembles the following:
use admin
db.createUser(
{
user: "<username>",
pwd: "<password>",
roles: [
"clusterAdmin",
"readAnyDatabase",
"userAdminAnyDatabase",
{ role: "readWrite", db: "admin" },
{ role: "readWrite", db: "local" },
]
}
)
See Access Control for MongoDB 2.6 for more information on the required access.
MongoDB 2.4 To backup MongoDB 2.4 release series instances, create a user in the admin database with an
operation that resembles the following:
use admin
db.addUser(
{
user: "<username>",
pwd: "<password>",
roles: [
"clusterAdmin",
"readAnyDatabase",
"userAdminAnyDatabase"
],
otherDBRoles: {
local: ['readWrite'],
admin: ['readWrite']
config: ['readWrite']
}
}
)
See Access Control for MongoDB 2.4 for more information on the required access.
Host Settings In addition to adding the agent as a MongoDB user, you must also specify the host’s authentication
settings. You can specify the host’s authentication settings when adding the host, or you can edit the settings for an
existing host.
Configure Backup Agent for LDAP Authentication
241
Overview If your MongoDB deployment enforces access control, the Backup Agent must authenticate to MongoDB
as a user with the proper access.
Starting in version 2.6, MongoDB Enterprise provides an LDAP (plain) authentication mechanism that allows clients
to authenticate to MongoDB deployments using LDAP. Backup Agents support authenticating to MongoDB instances
using LDAP.
If your MongoDB deployment uses LDAP to authenticate users, to authenticate the Backup Agent, create a user in the
$external database with the appropriate roles in MongoDB.
Considerations You must configure LDAP authentication separately for the Backup Agent and for the Monitoring
Agent.
You can configure LDAP authentication when activating backup or later by editing the backup configuration.
Prerequisites There are additional authentication configuration requirements for MMS Backup when using MongoDB 2.4 with authentication. See Required Access for Backup Agent for more information.
Create User in MongoDB To monitor MongoDB 2.6 instances that are using LDAP authentication, add a user to
the $external database in MongoDB with the appropriate roles. The $external database allows mongod to
consult an external source (e.g. LDAP) to authenticate.
MongoDB 3.0 or later
db.getSiblingDB("$external").createUser(
{
user : "<username>",
roles: [ { role: "backup", db: "admin" } ]
}
)
MongoDB 2.6
db.getSiblingDB("$external").createUser(
{
user: "<username>",
roles: [
"clusterAdmin",
"readAnyDatabase",
"userAdminAnyDatabase",
{ role: "readWrite", db: "admin" },
{ role: "readWrite", db: "local" },
]
}
)
See Access Control for MongoDB 2.6 for more information on the required access.
Host Settings In addition to adding the agent as a MongoDB user, you must also specify the host’s authentication
settings. You can specify the host’s authentication settings when adding the host, or you can edit the settings for an
existing host.
242
Configure the Backup Agent for Kerberos
Enterprise Feature
Only MongoDB Enterprise provides support for Kerberos.
Kerberos is a generic authentication protocol available starting from MongoDB Enterprise version 2.6. The Monitoring
Agents can authenticate to hosts using Kerberos.
Prerequisites You must configure the Kerberos Key Distribution Center (KDC) to grant tickets that are valid for at
least four hours. The Backup Agent takes care of periodically renewing the ticket. The KDC service provides session
tickets and temporary session keys to users and computers.
There are additional authentication configuration requirements for MMS Backup when using MongoDB 2.4 with
authentication. See Required Access for Backup Agent for more information.
Create Kerberos Principal If you are running both the Monitoring Agent and the Backup Agent on the same server,
then both agents must connect as the same Kerberos Principal.
Step 1: Create or choose a Kerberos principal. Create or choose a Kerberos principal for the MMS Monitoring
and/or MMS Backup agent.
Step 2: Generate a keytab for the Kerberos principal. Generate a keytab for the Kerberos principal and copy it to
the system where the agent runs. Ensure the user that will run the agent is the same user that owns the keytab file.
Create MongoDB User for the Principal If you are running both the Monitoring Agent and the Backup Agent on
the same server, then both agents must connect as the same Kerberos Principal.
Kerberos Principal for the Backup Agent Add a Kerberos principal, <username>@<KERBEROS REALM> or
<username>/<instance>@<KERBEROS REALM>, to MongoDB in the $external database. Specify the
Kerberos realm in all uppercase. The $external database allows mongod to consult an external source (e.g. Kerberos) to authenticate.
MongoDB 3.0 or Later For MongoDB 3.0 or later, to add the principal for just the Backup Agent, use an operation
that resembles the following:
use $external
db.createUser(
{
user: "<Kerberos Principal>",
roles: [
{ role: "backup", db: "admin" }
]
}
)
See MongoDB 3.0 and Later for more information on the required access for the Backup Agent.
243
MongoDB 2.6 For the MongoDB 2.6 release series, to add the principal for just the Backup Agent, use an operation
that resembles the following:
use $external
db.createUser(
{
user: "<Kerberos Principal>",
roles: [
"clusterAdmin",
"readAnyDatabase",
"userAdminAnyDatabase",
{ role: "readWrite", db: "admin" },
{ role: "readWrite", db: "local" },
]
}
)
See MongoDB 2.6 for more information on the required access for the Backup Agent.
Kerberos Principal for the Monitoring Agent and Backup Agent Add a Kerberos principal,
<username>@<KERBEROS REALM> or <username>/<instance>@<KERBEROS REALM>, to MongoDB in the $external database. Specify the Kerberos realm in all uppercase. The $external database allows
mongod to consult an external source (e.g. Kerberos) to authenticate.
For example, to add the same principal for both the Monitoring Agent and the Backup Agent, specify required access
for both agents. The following example specifies access required to connect to MongoDB 3.0 or greater.
use $external
db.createUser(
{
user: "<Kerberos Principal>",
roles: [
{ role: "clusterMonitor", db: "admin" },
{ role: "backup", db: "admin" }
]
}
)
See MongoDB 2.6 and MongoDB 3.0 and Later for more information on the required access for the Monitoring Agent
and the Backup Agent.
Edit Agent Configuration File Edit the /etc/mongodb-mms/backup-agent.config file.
Step 1: Set the krb5Principal Set the krb5Principal to the name of the Kerberos principal. For example:
[email protected]
Step 2: Set the kerb5Keytab Set the kerb5Keytab value to the complete absolute path of the keytab file. For
example:
krb5Keytab=/etc/mongodb-mms/mmsagent.keytab
Step 3: Restart the agent.
244
Host Settings In addition to adding the agent as a MongoDB user, you must also specify the host’s authentication
settings. You can specify the host’s authentication settings when adding the host, or you can edit the settings for an
existing host.
Configure Backup Agent for SSL
Overview
If your MongoDB deployment uses SSL, then you must configure the Backup Agent to use SSL to connect to your
deployment’s mongod and mongos instances.
Configuring the agent to use SSL involves specifying which certificate to use to sign MongoDB certificates and turning
on the SSL option for the MongoDB instances in MMS.
Prerequisite
To configure the agent to use SSL, you must have a trusted CA certificate that signed the MongoDB instance’s certificate.
Procedures
Connections between Agents and MongoDB Instances To use SSL for the Backup Agent’s connection to a MongoDB host, specify the host’s SSL settings when adding the host or by editing the host’s settings.
Then configure the agent to use SSL:
Step 1: Specify path to trusted CA certificate. Edit the Backup Agent configuration file to set the
sslTrustedServerCertificates field to the path of a file containing one or more certificates in PEM format. For example:
sslTrustedServerCertificates=/path/to/mongodb-certs.pem
The agent configuration file is located in either the agent install directory or the /etc/mongodb-mms/ directory,
depending on your operating system.
By default, to connect to MongoDB instances using SSL requires a valid trusted certificate. For testing purposes,
however, you can set the sslRequireValidServerCertificates setting to False to bypass this check.
This configuration is not recommended for production use as it makes the connection insecure.
For additional information on these settings, see MongoDB SSL Settings.
Step 2: Restart agent.
Connections between Agents and MMS The Backup Agents always use SSL when connecting to the MMS servers.
For the settings used by the Backup Agent to connect to the MMS servers, see MMS Server SSL Settings.
245
Start or Stop the Backup Agent
Overview
For maintenance or troubleshooting purposes, you may want to temporarily shut down or restart MMS Backup’s
Backup Agent. However, for proper operation of MMS Backup your MMS group must have at least one Backup
Agent running. The group needs only one Backup Agent.
Procedures
Start the Backup Agent The procedure to Install the Backup Agent includes a step to start the agent. If you must
restart the agent, use the following procedure.
Start an Agent Installed with an rpm Package If you installed the Backup Agent using an rpm package, such as
on RHEL, CentOS, or SUSE, issue the following command to start the agent:
sudo service mongodb-mms-backup-agent start
Start an Agent Installed with a deb Package If you installed the Backup Agent using a deb package, as on
Ubuntu, issue the following command to start the agent:
sudo start mongodb-mms-backup-agent
Start an Agent Installed with a tar File Use this command if you installed to Linux or OSX using a tar file.
Issue the following command from the directory to which you installed the Backup Agent:
nohup ./mongodb-mms-backup-agent >> backup-agent.log 2>&1 &
Start the Backup Agent on Windows In Windows Control Panel, open Administrative Tools and
then Services. In the list of services, select MMS Backup Agent. Select the Action menu and select Start.
Stop the Backup Agent If you use MMS Backup, you must have a Backup Agent running to ensure up-to-date
backup data.
Stop an Agent Installed with an rpm Package If you installed the Backup Agent using an rpm package, such as
on RHEL, CentOS, or SUSE, issue the following command to stop the agent:
sudo service mongodb-mms-backup-agent stop
Stop an Agent Installed with a deb Package If you installed the Backup Agent using a deb package, as on
Ubuntu, issue the following command to stop the agent:
sudo stop mongodb-mms-backup-agent
Stop an Agent Installed with a tar File If you installed to a Linux system or OSX using a tar file, issue the
following command to stop the Backup Agent:
246
pkill -f mongodb-mms-backup-agent
Stop the Backup Agent on Windows In Windows Control Panel, open Administrative Tools and
then Services. In the list of services, select MMS Backup Agent. Select the Action menu and select Stop.
If you receive a message that your Backup Agent is out of date, make sure you are running an upgradeable version of
the Backup Agent. If you are running the version of the Backup Agent named MongoDBBackup, you must remove it
before upgrading. To check if you are running MongoDBBackup, issue the following command in an Administrative
command prompt:
sc query MongoDBBackup
If the command returns a result, you must remove the MongoDBBackup agent. To remove it, issue the following:
sc delete MongoDBBackup
Remove the Backup Agent from MMS
MMS displays active Backup Agents on the Agents page in in the Administration tab. The page displays agents that
have been active in the last 24 hours. If an agent fails to report to MMS for more than 24 hours, MMS removes the
agent from the Agents page.
To remove a Backup Agent from |mms|, stop the agent and then wait 24 hours.
To delete the Backup Agent from a Linux or OSX server, stop the agent and then remove the
mongodb-mms-backup-agent file from the /usr/bin directory. If you installed the agent using a tar.gz
file, the agent will be in the directory you chose during installation.
To delete the Backup Agent from a Windows server, stop the agent and then use the Windows program uninstaller
to remove the MMS Backup Agent program.
10.4 Monitoring Reference
This document contains references of the different types of hosts, databases, and other statuses that may occur in MMS
Monitoring.
Host Types
The possible values for the “Type” column in the Deployment page are:
• primary
• secondary
• standalone
• master
• slave
• unknown
• recovering
The “Host Type” selector on the advanced dashboard creator also includes:
• conf
247
• mongos
Note: The host type column may also have the value “no data,” which means that MMS Monitoring has not received
any data from the Monitoring Agent for this host. For possible causes, see Troubleshooting.
Host Process Types
MMS Monitoring can monitor the process types:
• mongod database processes
• mongod arbiter processes
• mongos
• Monitoring Agents
Event Types
Types of events in the Events section of the MMS console:
• new host
• restart
• upgrade
Alert Types
The available alert types are:
• Old Host Version
• Host Down
• Agent Down
• Now Secondary
• Now Primary
Chart Colors
• A red bar indicates a server restart.
• A purple bar indicates the server is now a primary.
• A yellow bar indicates the server is now a secondary.
Status Page
• cpu time
• db storage
• page faults
• repl lag
248
• replica
• network
• cursors
• queues
• connections
• background flush avg
• lock % 4
• btree
• non-mapped virtual memory
• memory
• asserts
• opcounters-repl
• opcounters
DB Stats Page
• collections
• objects
• average object size
• data size
• storage size
• num extents
• indexes
• index size
• file size
Database Commands Used by the Monitoring Agent
• serverStatus
• buildinfo
• getCmdLineOpts
• connPoolStats
• _isSelf
• getParameter
• ismaster
• getShardVersion
4 For versions of MongoDB after 2.1.1, this chart has a drop-down menu next to the tile that lists available databases, including “global” to
represent the global lock for this host. Select a database to see its lock utilization. See the documentation of lock reporting in serverStatus for more
information.
249
• netstat
• replSetGetStatus
• shards.find
• mongos.find
• config.chunks.group
• oplog.find
• collstats - oplog.rs
• sources.find (slave)
• config.settings.find
• dbstats
• db.locks
10.5 Supported Browsers
To use MMS, ensure that your browser is one of the following supported browsers, with Javascript enabled:
• Chrome 8 and greater.
• Firefox 12 and greater.
• IE 9 and greater.
• Safari 6 and greater.
MMS will display a warning on non-supported browsers.
10.6 Advanced Options for MongoDB Deployments
Overview
The following mongod and mongos configuration options are available through the MMS Advanced Options field
when you deploy MongoDB. You select advanced options when deploying replica sets, sharded clusters, and standalone instances.
Advanced Options
The MMS Advanced Options map to the MongoDB configuration options as described here.
Network and HTTP
• maxConns: net.maxIncomingConnections
• jsonp: net.http.JSONPEnabled
• nohttpinterface: net.http.enabled
• rest: net.http.RESTInterfaceEnabled
250
Operation Profiling
• profile: operationProfiling.mode
• slowms: operationProfiling.slowOpThresholdMs
Process Management
• pidfilepath: processManagement.pidFilePath
Replication
• oplogSize: replication.oplogSizeMB
Storage and Journal
• directoryperdb: storage.directoryPerDB
• noprealloc: storage.preallocDataFiles
• nssize: storage.nsSize
• smallfiles: storage.smallFiles
• syncdelay: storage.syncPeriodSecs
• journalCommitInterval: storage.journal.commitIntervalMs
• nojournal: storage.journal.enabled
System Log
• logappend: systemLog.logAppend
• quiet: systemLog.quiet
• syslog: systemLog.destination
10.7 Automation Configuration
Overview
The Automation Agent uses an automation configuration to determine the desired state of a MongoDB deployment
and to effect changes as needed. If you modify the deployment through the MMS web interface, you never need
manipulate this configuration.
If you are using the Automation Agent without MMS, you can construct and distribute the configuration file manually.
Fields
Optional fields are marked as such.
A field that takes a <number> as its value can take integers and floating point numbers.
251
version
"version" : <integer>
Name
version
Type
integer
Description
The version of the configuration file.
agentVersion
"agentVersion" : {
"name" : <string>,
"directoryUrl" : <string>
}
Name
Type Description
agentVer- ob- Optional The version of the Automation Agent to run. If the running version does not match this
sion
ject setting, the Automation Agent downloads the specified version, shuts itself down, and starts the
new version.
- name
string The desired version of the Automation Agent (e.g. “1.4.0”).
- direc- string The URL from which to download Automation Agent.
toryUrl
monitoringVersions
"monitoringVersions" : [
{
"name" : <string>,
"hostname" : <string>,
"urls" : {
<platform1> : {
<build1> : <string>,
...,
"default" : <string>
},
...
},
"baseUrl" : <string>,
"logPath" : <string>,
"logRotate" : {
"sizeThresholdMB" : <number>,
"timeThresholdHrs" : <integer>,
"numUncompressed": <integer>,
"percentOfDiskspace" : <number>
}
},
...
]
252
Name
monitoringVersions
- name
- hostname
Type
array
string
string
- urls
object
object
-<platform>
- baseUrl
- logPath
- logRotate
Description
Optional. Objects that define version information for each Monitoring Agent.
The desired version of the Monitoring Agent (e.g. “2.1.4.51-1”).
The hostname of the machine that runs the Monitoring Agent. If the Monitoring Agent is
not running on the machine, MMS installs the agent from the location specified in
monitoringVersions.urls.
The platform- and build-specific URLs from which to download the Monitoring Agent.
This field has a name that identifies an operating system and optionally a version. The field
contains an object with key-value pairs, where each key is either the name of a build or
default and each value is a URL for downloading the Monitoring Agent. The object
must include the default key set to the default download URL for the platform.
string The base URL used for the mmsBaseUrl setting in the Monitoring Agent Configuration.
string Optional. The directory where the agent stores its logs. The default is to store logs in
/dev/null.
obOptional. Enables log rotation for the MongoDB logs for a process.
ject
num- The maximum size in MB for an individual log file before rotation.
ber
-sizeThresholdMB
-intimeThresh- teoldHrs
ger
- - nuinmUncomtepressed
ger
- - pernumcentOfDiskspace
ber
The maximum time in hours for an individual log file before rotation.
Optional. The maximum number of total log files to leave uncompressed, including the
current log file. The default is 5.
Optional. The maximum percentage of total disk space all log files should take up before
deletion. The default is .02.
backupVersions
"backupVersions" : [
{
"name" : <string>,
"hostname" : <string>,
"urls" : {
<platform1> : {
<build1> : <string>,
...,
"default" : <string>
},
...
},
"baseUrl" : <string>,
"logPath" : <string>,
"logRotate" : {
"sizeThresholdMB" : <number>,
"timeThresholdHrs" : <integer>,
"numUncompressed": <integer>,
"percentOfDiskspace" : <number>
}
},
...
],
253
Name
backupVersions
- name
- hostname
Type
array
string
string
- urls
object
object
-<platform>
- baseUrl
- logPath
- logRotate
Description
Optional. Objects that define version information for each Backup Agent.
The desired version of the Backup Agent (e.g. “1.5.1.83-1”).
The hostname of the machine that runs the Backup Agent. If the Backup Agent is not
running on the machine, MMS installs the agent from the location specified in
backupVersions.urls.
The platform- and build-specific URLs from which to download the Backup Agent.
This field has a name that identifies an operating system and optionally a version. The field
contains an object with key-value pairs, where each key is either the name of a build or
default and each value is a URL for downloading the Backup Agent. The object must
include the default key set to the default download URL for the platform.
string The base URL used for the mothership and https settings in the Backup Agent
Configuration. For example, for "baseUrl"=https://mms-qa.mongodb.com, the
backup configuration fields would have these values:
mothership=api-backup-qa.mongodb.com and https"=true.
string Optional. The directory where the agent stores its logs. The default is to store logs in
/dev/null.
obOptional. Enables log rotation for the MongoDB logs for a process.
ject
num- The maximum size in MB for an individual log file before rotation.
ber
-sizeThresholdMB
-intimeThresh- teoldHrs
ger
- - nuinmUncomtepressed
ger
- - pernumcentOfDiskspace
ber
The maximum time in hours for an individual log file before rotation.
Optional. The maximum number of total log files to leave uncompressed, including the
current log file. The default is 5.
Optional. The maximum percentage of total disk space all log files should take up before
deletion. The default is .02.
processes
"processes" : [
{
"name" : <string>,
"processType" : <string>,
"version" : <string>,
"<args>" : <object>,
"disabled" : <Boolean>,
"manualMode" : <Boolean>,
"hostname" : <string>,
"cluster": <string>,
"numCores": <integer>,
"logRotate" : {
"sizeThresholdMB" : <number>,
"timeThresholdHrs" : <integer>,
"numUncompressed": <integer>,
"percentOfDiskspace" : <number>
},
254
"authSchemaVersion": <integer>,
"alias": <string>
},
...
]
Name
processes
- name
processType
- version
- <args>
- disabled
- manualMode
- hostname
- cluster
- numCores
- logRotate
Type
array
string
string
Description
The processes array contains objects that define the mongos and mongod instances
that MMS monitors. Each object defines a different instance.
A unique name to identify the instance.
Either mongod or mongos.
string The name of the mongoDbVersions specification used with this instance.
obThis field is named either args2_6, for MongoDB versions 2.6 and higher (including 3.0
ject
and higher), or args2_4, for versions 2.4 and earlier. The field contains a MongoDB
configuration object in the format appropriate to the version. For information on format
and supported MongoDB options, see supported configuration options.
BooleanOptional. Set to true to shut down the process.
BooleanOptional. Set to true to operate this process in manual mode. The Automation Agent
will take no actions on the process.
string Optional. The name of the host this process should run on. This defaults to localhost.
string Optional. Required for a mongos. The name of the cluster. This must correspond to the
sharding.name field in the sharding array for the mongos.
inOptional. The number of cores the process should be bound to. The Automation Agent
tewill spread processes out across the cores as evenly as possible.
ger
obOptional. Enables log rotation for the MongoDB logs for a process.
ject
num- The maximum size in MB for an individual log file before rotation.
ber
-sizeThresholdMB
-intimeThresh- teoldHrs
ger
- - nuinmUncomtepressed
ger
- - pernumcentOfDiskspace
ber
- authinSchemaVer- tesion
ger
- alias
string
The maximum time in hours for an individual log file before rotation.
Optional. The maximum number of total log files to leave uncompressed, including the
current log file. The default is 5.
Optional. The maximum percentage of total disk space all log files should take up before
deletion. The default is .02.
Optional. The schema version of the user credential objects. This should match all other
elements of the processes array that belong to the same cluster. The possible values are
1, 3, and 5. The default is 3 for 2.6 clusters and 1 for 2.4 clusters.
Optional. A hostname alias (often a DNS CNAME) for the server on which the process
runs. If an alias is specified, the Automation Agent prefers the alias over the host specified
in processes.hostname when connecting to the server. You can also specify this
alias in replicaSets.host and sharding.configServer.
replicaSets
"replicaSets" : [
{
"_id" : <string>,
"members" : [
255
{
"_id" : <integer>,
"host" : <string>
},
...
]
},
...
]
Name
replicaSets
Type Description
arOptional. Objects that define the configuration of each replica set. The Automation Agent uses
ray the values in this array to create valid replica set configuration documents. The agent regularly
checks that replica sets are configured correctly. If a problem occurs, the agent reconfigures the
replica set according to its configuration document. The array can contain the following fields
from a replica set configuration document: _id; version; and members. The
members.host field must specify the host’s name as listed in processes.name. The
Automation Agent expands the host field to create a valid replica set configuration.
sharding
"sharding" : [
{
"name" : <string>,
"configServer" : [ <string>, ... ],
"collections" : [
{
"_id" : <string>,
"key" : [
[ shard key ],
[ shard key ],
...
]
},
...
],
"shards" : [
{
"_id" : <string>,
"rs" : <string>
},
...
]
},
...
]
256
Name
sharding
Type Description
arOptional. Objects that define the configuration of each sharded cluster. Each object in the array
ray contains the specifications for one cluster. The Automation Agent regularly checks each
cluster’s state against the specifications. If the specification and cluster don’t match, the agent
will change the configuration of the cluster, which might cause the balancer to migrate chunks.
- name
string The name of the cluster. This must correspond with the value in processes.cluster for a
mongos.
- conarString values that provide the names of each config server’s hosts. The host names are the same
figServer ray names as are used in each host’s processes.name field.
- colarObjects that define the sharded collections and their shard keys.
lections ray
- - _id
string The namespace of the sharded collection. The namespace is the combination of the database
name and the name of the collection. For example, testdb.testcoll.
- - key
arThe collection’s shard keys. This “array of arrays” contains a single array if there is a single
ray shard key and contains multiple arrays if there is a compound shard key.
- shards arObjects that define the cluster’s shards.
ray
- - _id
string The name of the shard.
- - rs
string The name of the shard’s replica set, as specified in the replicaSets._id field.
balancer
"balancer": {
"<clusterName1>": <object>,
"<clusterName2>": <object>,
...
}
Name Type Description
balob- Optional. This object contains fields named according to clusters, each field containing an object
ancer ject with the desired balancer settings for the cluster. The object uses the stopped and
activeWindow fields, as described in the procedure to schedule the balancing window in this
tutorial in the MongoDB manual.
auth
"auth" : {
"autoUser": <string>,
"autoPwd": <string>,
"key" : <string>,
"keyfile" : <string>,
"usersDeleted" : [
{
"user" : <string>,
"dbs" : [ <string>, ... ],
"allDbs" : <Boolean>
},
...
],
"usersWanted" : [
{
"db" : <string>,
"user" : <string>,
"roles" : [ <string>, ... ],
257
"pwd" : <32-character hex string>,
"initPwd" : <string>,
"userSource" : <string>,
"otherDBRoles" : {
<string> : [ <string>, ....],
...
}
},
...
]
}
258
Name
auth
autoUser
autoPwd
disabled
- key
Type
object
string
Description
Optional. Defines authentication-related settings.
The username that the Automation agent uses when connecting to an instance.
string
The password that the Automation agent uses when connecting to an instance.
boolean
Optional. Indicates if auth is disabled. If not specified, disabled defaults to false.
string
- keyfile
string
- usersDeleted
array
- - user
- - dbs
string
array
-allDbs
- usersWanted
Boolean
- - db
- - user
- - roles
string
string
array
- - pwd
32character
hex string
string
The contents of the key file that MMS uses to authenticate to the MongoDB processes.
The key is not required if disabled is true.
The path and name of the key file that MMS uses to authenticate to the MongoDB
processes. The keyfile is not required if disabled is true.
Optional. Objects that define the authenticated users to be deleted from specified
databases or from all databases. This array must contain two fields: the
auth.usersDeleted.user field and then either the
auth.usersDeleted.dbs or the auth.usersDeleted.allDbs field.
The user’s name.
String values that list the names of the databases from which the authenticated user is
to be deleted. If you use this field, do not use the auth.usersDeleted.allDbs
field.
If set to true, the authenticated user is deleted from all databases. If you use this field,
do not use the auth.usersDeleted.dbs field.
Optional. Contains objects that define authenticated users to add to specified databases.
Each object must have the auth.usersWanted.db,
auth.usersWanted.user, and auth.usersWanted.roles fields, and then
have exactly one of the following fields: auth.usersWanted.pwd,
auth.usersWanted.initPwd, or auth.usersWanted.userSource.
The database to which to add the user.
The name of the user.
String values that list the roles to be assigned the user from the user’s database, which
is specified in auth.usersWanted.db.
The MONGODB-CR hash of the password assigned to the user. If you set this field, do
not set the auth.usersWanted.initPwd or
auth.usersWanted.userSource fields.
An initial cleartext password assigned to the user. If you set this field, do not set the
auth.usersWanted.pwd or auth.usersWanted.userSource fields.
If you use MongoDB version 2.4, you can use this field to specify the database that
contains the user’s credentials. See the Privilege Documents page in the MongoDB 2.4
manual. If you set this field, do not set the auth.usersWanted.pwd or
auth.usersWanted.initPwd fields.
Optional. If the auth.usersWanted.db field specifies admin as the user’s
database, then this object can assign to the user roles from other databases as well. The
object contains key-value pairs where the key is the name of the database and the value
is an array of string values that list the roles be assigned from that database.
-initPwd
- - userSource
-otherDBRoles
array
string
object
ssl
SSL is available only in MongoDB Enterprise or a build of MongoDB compiled with SSL support.
"ssl" : {
"CAFilePath" : <string>,
}
259
Name
ssl
Type
object
string
CAFilePath
Description
Optional. Enables SSL for encrypting connections. SSL is available only in MongoDB
Enterprise or a build of MongoDB compiled with SSL support.
The path to the certificate used to authenticate through SSL.
roles
"roles" : [
{
"role" : <string>,
"db" : <string>,
"privileges" : [
{
"resource" : { ... },
"actions" : [ <string>, ... ]
},
...
],
"roles" : [
{
"role" : <string>,
"db" : <string>
}
]
},
...
]
Name Type Description
roles arOptional. The roles array contains objects that describe the cluster’s user-defined roles. Each
ray object describes a different user-defined role. Objects in this array contain the same fields as
documents in the :manual:‘ system roles collection </reference/system-roles-collection>‘, except
for the _id field, which is not included here.
mongoDbVersions
The mongoDbVersions array defines specification objects for the MongoDB instances found in the processes
array. Each MongoDB instance in the processes array must have a specification object in this array.
"mongoDbVersions" : [
{
"name" : <string>,
"builds" : [
{
"platform" : <string>,
"url" : <string>,
"gitVersion" : <string>,
"bits" : <integer>,
"win2008plus" : <Boolean>,
"winVCRedistUrl" : <string>,
"winVCRedistOptions" : [ <string>, ... ],
"winVCRedistDll" : <string>,
"winVCRedistVersion" : <string>
260
},
...
],
},
...
]
Name
mongoDbVersions
- name
- builds
- - platform
- - url
- - gitVersion
- - bits
-win2008plus
- - winVCRedistUrl
-winVCRedistOptions
- - winVCRedistDll
-winVCRedistVersion
Type Description
arThe mongoDbVersions array is required and defines specification objects for the
ray
MongoDB instances found in the processes array. Each MongoDB instance in
processes must have a specification object in mongoDbVersions.
string The name of the specification object. The specification object is attached to a MongoDB
instance through the instance’s processes.version field in this configuration file.
arObjects that define the builds for this MongoDB instance.
ray
string The platform for this MongoDB instance.
string The URL from which to download MongoDB for this instance.
string The commit identifier that identifies the state of the code used to build the MongoDB
process. The MongoDB buildInfo command returns the gitVersion identifier.
inThe processor’s bus width. Specify either 64 or 32.
teger
BooleanOptional. Set to true if this is a Windows build that requires either Windows 7 later or
Windows Server 2008 R2 or later.
string Optional. The URL from which the required version of the Microsoft Visual C++
redistributable can be downloaded.
arOptional. String values that list the command-line options to be specified when running
ray
the Microsoft Visual C++ redistributable installer. Each command-line option is a separate
string in the array.
string Optional. The name of the Microsoft Visual C++ runtime DLL file that the agent will
check to determine if a new version of the Microsoft Visual C++ redistributable is needed.
string Optional. The minimum version of the Microsoft Visual C++ runtime DLL that must be
present to skip over the installation of the Microsoft Visual C++ redistributable.
options
"options" : {
"downloadBase" : <string>
}
Name
options
- downloadBase
Type Description
object
string The path to the directory where automatic version downloads are targeted and scripts for
starting processes are created.
10.8 Supported MongoDB Options for Automation
Overview
The processes.<args> object in an automation configuration specifies the configuration options for each MongoDB instance. The supported options depend on the version of MongoDB.
261
MongoDB 2.6 and Later Configuration Options
The processes.args2_6 object applies to MongoDB versions 2.6 and higher (including 3.0 and higher) and
supports the following MongoDB options. The object uses the MongoDB configuration format.
The processes.args2_6 object supports the following:
• config
• net.bindIp
• net.http.JSONPEnabled
• net.http.RESTInterfaceEnabled
• net.http.enabled
• net.maxIncomingConnections
• net.port
• noscripting
• notablescan
• operationProfiling.mode
• operationProfiling.slowOpThresholdMs
• processManagement.fork
• processManagement.pidFilePath
• replication.oplogSizeMB
• replication.replSet
• replication.replSetName
• replication.secondaryIndexPrefetch
• security.authorization
• security.keyFile
• setParameter.connPoolMaxConnsPerHost
• setParameter.connPoolMaxShardedConnsPerHost
• setParameter.enableTestCommands
• setParameter.enableLocalhostAuthBypass
• setParameter.failIndexKeyTooLong
• setParameter.internalQueryPlannerEnableIndexIntersection
• setParameter.logLevel
• setParameter.newCollectionsUsePowerOf2Sizes
• setParameter.releaseConnectionsAfterResponse
• setParameter.textSearchEnabled
• setParameter.ttlMonitorEnabled
• sharding.clusterRole
• sharding.configDB
262
• storage.dbPath
• storage.directoryPerDB
• storage.journal.commitIntervalMs
• storage.journal.enabled
• storage.nsSize
• storage.preallocDataFiles
• storage.quota.maxFilesPerDB
• storage.quota.enforced
• storage.smallFiles
• storage.syncPeriodSecs
• systemLog.destination
• systemLog.logAppend
• systemLog.path
• systemLog.quiet
• systemLog.timeStampFormat
• systemLog.verbosity
• processManagement.fork
MongoDB 2.4 and Earlier Configuration Options
The processes.args2_4 object applies to MongoDB versions 2.4 and earlier and supports the following MongoDB options. The object uses the 2.4 MongoDB configuration format.
The processes.args2_4 object supports the following:
• auth
• bind_ip
• config
• configdb
• configsvr
• dbpath
• directoryperdb
• fork
• journal
• journalCommitInterval
• jsonp
• keyFile
• logappend
• logpath
263
• maxConns
• nohttpinterface
• nojournal
• noprealloc
• noscripting
• nssize
• oplogSize
• pidfilepath
• port
• profile
• quiet
• quota
• quotaFiles
• replSet
• rest
• shardsvr
• slowms
• smallfiles
• syncdelay
• syslog
• v
• vv
• vv
10.9 AWS IAM Policy
When MMS deploys and manages MongoDB instances on AWS infrastructure, MMS accesses AWS by way of a user’s
access keys. The user associated with the keys must have an attached IAM policy with the following permissions. For
information on attaching the policy, see Configure AWS Integration.
{
"Statement": [
{
"Effect": "Allow",
"Action": ["iam:*AccessKey*", "iam:GetUser"],
"Resource": ["*"]
},
{
"Effect": "Allow",
"Action": [
"ec2:AttachVolume",
"ec2:AuthorizeSecurityGroupIngress",
"ec2:CreateKeyPair",
264
"ec2:CreateSecurityGroup",
"ec2:CreateTags",
"ec2:CreateVolume",
"ec2:DeleteKeyPair",
"ec2:DeleteSecurityGroup",
"ec2:DeleteTags",
"ec2:DeleteVolume",
"ec2:DescribeAccountAttributes",
"ec2:DescribeAvailabilityZones",
"ec2:DescribeInstanceAttribute",
"ec2:DescribeInstanceStatus",
"ec2:DescribeInstances",
"ec2:DescribeKeyPairs",
"ec2:DescribeRegions",
"ec2:DescribeSecurityGroups",
"ec2:DescribeSubnets",
"ec2:DescribeTags",
"ec2:DescribeVpcs",
"ec2:DescribeVpcAttribute",
"ec2:DescribeVolumeStatus",
"ec2:DescribeVolumes",
"ec2:DescribeVolumeAttribute",
"ec2:ImportKeyPair",
"ec2:RunInstances",
"ec2:StartInstances",
"ec2:StopInstances",
"ec2:RebootInstances",
"ec2:TerminateInstances"
],
"Resource": [
"*"
]
}
]
}
11 Release Notes
Automation Agent Changelog A record of changes to the Automation Agent.
Monitoring Agent Changelog A record of changes to the Monitoring Agent.
Backup Agent Changelog A record of changes to the Backup Agent.
11.1 Automation Agent Changelog
Automation Agent 1.7.0.992
Released: 2015-03-16
• Improves algorithm for balancing mongod processes across cores
• Fixed issue with configuring oplog sizes greater than 1 TB
• Improvements that make auto-upgrades more reliable
265
Automation Agent 1.6.2.960
Released 2015-02-23
• Ability to import an existing deployment into Automation, which allows you to use Automation to manage the
deployment. See Add Monitored Processes to Automation.
• The Deployment tab now displays all deployment information, for both servers and processes, on one page, with
icons for selecting view options.
Automation Agent 1.3.0.718
Released 2014-11-12
• Support for MongoDB 2.8
• Fixed issues with upgrades for 2.6-series minor version with auth enabled.
Automation Agent 0.4.0
Released 2014-05-08
Initial release for Automation beta program.
11.2 Monitoring Agent Changelog
Monitoring Agent 3.1.0.173
Released 2015-02-23
• Ability to monitor and back up deployments without managing them through Automation. Specifically, you can
import an existing deployment into Monitoring, which allows you to use MMS to monitor and optionally back
up the deployment. See Add Existing MongoDB Processes to Monitoring.
• Support for x.509 certificate authentication.
• Improved support for collecting database staistics from secondaries as well as primaries.
• The Deployment tab now displays all deployment information, for both servers and processes, on one page, with
icons for selecting view options.
Monitoring Agent 3.0.0.167
Released 2015-01-28
Stagger the timing of DNS look-ups, to avoid triggering a rare issue in glibc 2.19 on Ubuntu 14.04.
Monitoring Agent 2.9.0.164
Released 2015-01-08
Improved error handling on Windows.
266
Monitoring Agent 2.8.0.143
Released 2014-11-12
• The Monitoring Agent will now identify itself to the MMS servers using the fully qualified domain name
(FQDN) of the server on which it is running.
• Improved connection management for monitored MongoDB processes.
Monitoring Agent 2.7.0.136
Released 2014-10-29
• Improve correctness of database statics collection by moving data collection into separate internal thread.
• Adds support for non-default Kerberos service names.
• Adds support for RHEL7.
Monitoring Agent 2.6.0.123
Released 2014-09-30
Now uses the listDatabases to retrieve a list of databases.
Monitoring Agent 2.5.0
Released 2014-09-10
Added support for authentication using MongoDB 2.4 style client certificates.
Monitoring Agent 2.4.1.108
Released 2014-08-25
The default value for sslTrustedServerCertificates is now true. Users upgrading from 2.4.0 and using SSL will need to set the value of sslTrustedServerCertificates in their configuration file. See
sslTrustedServerCertificates for more information.
Monitoring Agent 2.4.0.101
Released 2014-07-29
• Upgraded agent to use Go 1.3.
• Updated mgo driver, which includes fix for MGO-34. All DNS lookups should now timeout appropriately.
• Added support for connecting to hosts using LDAP authentication.
• Added support for version and -version.
• Agent now displays git commit hash of Monitoring Agent in the log file.
• Updates to the configuration file format.
267
Monitoring Agent 2.3.1.89-1
Released 2014-07-08
• Fixes issues with connecting to replica set members that use auth with an updated Go client library.
• Added support for HTTP proxy configuration in the agent configuration file.
• Agent includes support for an Offline data collection mode.
Monitoring Agent 2.2.0.70-1
Released 2014-05-28
Improved logging for MongoDB 2.6 config servers when connecting with a user that has the built-in
clusterMonitor role.
Monitoring Agent 2.1.4.51-1
Released 2014-05-09
• Reduce log spam when a mongod connection attempt fails, or the when connecting to a 2.0 mongod.
• Prevent high CPU use when monitoring unreachable mongod.
Monitoring Agent 2.1.2.43-1
Released 2014-04-15
Reduction in unnecessary log messages for unsupported operations on monitored MongoDB 2.2 instances.
Monitoring Agent 2.1.0
Released 2014-03-26
• Added Kerberos support for the new 2.x Monitoring Agent.
• Windows click to install MSI agent installer.
• Fixed duplicated profiling data error.
Monitoring Agent 2.0.1
Released 2014-03-18
• Enhanced ability to stay connected when network connections become unstable due to firewalls and other factors.
• Included HTTP network proxy support for new 2.x Monitoring Agent with same environment variable mechanism available to the Python version of the Monitoring Agent.
Monitoring Agent 2.0.0
Released 2014-03-11
A new 2.x Monitoring Agent with no Python dependencies for deployments not using Kerberos authentication or
connecting to the internet via proxy.
268
Monitoring Agent 1.6.8
Released 2014-01-06
• Added a periodic diagnostic log message to the Agent that includes active host count.
• Removed deprecated agent auto-update.
Monitoring Agent 1.6.7
Released 2013-12-16
• Added optional support for validating MongoDB SSL certificates and custom CA certificate paths.
• Improved robustness of host IP address detection.
Monitoring Agent 1.6.6
Released 2013-11-30
• Added kerberos support for agents running on Python 2.4.x.
• Added logging when the dbstats command fails.
Monitoring Agent 1.6.5
Internal release only, not released.
Monitoring Agent 1.6.4
Released 2013-11-18
• Added support for the agent to connect to MongoDB deployments that use Kerberos.
• Allowed the Monitoring Agent to send data to the MMS server after detecting changes, such as adding a new
host.
Monitoring Agent 1.6.3
Internal Release Only - not published
Monitoring Agent 1.6.2
Released 2013-11-05
• Fixed bug that led to high CPU service with log collection and the agent’s connection to a mongod instance
failed.
Monitoring Agent 1.6.1
Released 2013-10-21
• Added options in the agent’s ‘settings.py to suppress database specific statics at the agent level.
• Improved error messages in agent logs.
269
Monitoring Agent 1.6.0
Released 2013-10-07
For monitored instances on MongoDB 2.4.x series, fixed a bug that reported monitored mongod instances as down
during foreground index builds.
Monitoring Agent 1.5.9
Released 2013-08-12
Agent now collects timestamps associated with hardware metrics, so that MMS can display more accurate minute-level
charts.
Monitoring Agent 1.5.8
Released 2013-07-15
Increased collection of data on shard names.
Monitoring Agent 1.5.7
Released 2013-04-23
Removed the writeBacksQueued queued call.
Monitoring Agent 1.5.6
Released 2013-03-20
Removed an error from the log if the agent is unable to collect profiling stats.
11.3 Backup Agent Changelog
Backup Agent 3.3.0.261
Released 2015-03-10
Logging improvements.
Backup Agent 3.2.0.262
Released 2015-02-23
Ability to monitor and back up deployments without managing them through Automation. Specifically, you can import
an existing deployment into Monitoring and then use MMS to back up the deployment.
• Support for x.509 certificate authentication.
• Fixes a race condition which could result in inconsistent clustershots for MongoDB 3.0+ sharded clusters using
the backup role.
270
Backup Agent 3.1.0.250
Released 2015-01-08
Logging improvements for Windows.
Backup Agent 3.0.0.246
Released 2015-01-08
Enhancements to support backup of MongoDB 3.0.
Backup Agent 2.9.1.235-1
Released 2014-12-17
Agent now encodes all collection meta-data. Avoids edge-case issues with unexpected characters in collection settings.
Backup Agent 2.9.0.223
Released 2014-12-04
Can now explicitly pass collections options for the WiredTiger storage engine from the backed up mongod to MMS.
Backup Agent 2.8.0.204
Released 2014-11-12
The Backup Agent will now identify itself to the MMS servers using the fully qualified domain name (FQDN) of the
server on which it is running.
Backup Agent 2.7.1.206
Released 2014-11-06
Use no-timeout cursors to work around MGO-53.
Backup Agent 2.7.0.193
Released 2014-10-29
• When tailing the oplog, the agent no longer pre-fetches the next batch of oplog entries before exhausting the
current batch.
• Adds support for non-default Kerberos service names.
• Adds support for RHEL7.
Backup Agent 2.6.0.176
Released 2014-09-30
Minor logging change, clarifying when stopping the balancer if there is no balancer settings document.
271
Backup Agent 2.5.0
Released 2014-09-10
Added support for authentication using MongoDB 2.4 style client certificates.
Backup Agent 2.4.0.156
Released 2014-08-19
The Backup Agent will now capture a checkpoint even if it is unable to stop the balancer. These checkpoints are not
guaranteed to be consistent, because of in-progress chunk migrations. The user interface identifies these checkpoints.
Backup Agent 2.3.0.149
Released 2014-07-29
• Upgraded agent to use to Go 1.3
• Added support for version and -version.
• Added support for connecting to hosts using LDAP authentication.
• Agent now provides additional logging information when the Backup Agent manipulates the balancer.
• Agent now supports configuring HTTP with the config file.
Backup Agent 2.2.2.125
Released 2014-07-09
Fixes issue with agent on Windows using the MONGODB-CR authentication mechanism.
Backup Agent 2.2.1.122
Released 2014-07-08
• Fixes issues with connecting to replica set members that use auth with an updated Go client library.
• Agent is now able to send a stack trace of its current state to MMS.
• Fixes regression in the Agent’s rollback handling.
Backup Agent 2.1.0.106-1
Released 2014-06-17
Support for a new API t hat allows MMS to ingest oplog entries before the entire payload has reached the MMS
servers.
Backup Agent 2.0.0.90-1
Released 2014-05-28
• Agent supports deployment architectures with multiple active (i.e. primary) Backup Agents.
• Improved stability around oplog tokens for environments with unstable networks.
272
Backup Agent 1.6.1.87-1
Released 2014-05-19
Critical update for users running the MongoDB 2.6 series that use authorization.
The Backup Agent now includes system.version and system.role collections from the admin database in
the initial sync.
Backup Agent 1.6.0.55-1
Released 2014-05-09
The agent now sends oplog slices to MMS in batches to increase throughout and stability.
Backup Agent 1.4.6.43-1
• Major stability update.
• Prevent a file descriptor leak.
• Correct handling of timeouts for connections hung in the SSL handshaking phase.
Backup Agent 1.4.4.34-1
Support for using the Backup Agent via an HTTP proxy
Backup Agent 1.4.3.28-1
• Allow upgrading the agent using the Windows MSI installer
• Improved logging
• Fix an open files leak on bad HTTP responses
Backup Agent 1.4.2.23-1
• Added support for Windows MSI installer
• For sharded clusters, less aggressive polling to determine if balancer has been stopped
• Fail fast on connections to mongods that are not responding
Backup Agent 1.4.0.17
Added support for sharded cluster checkpoints that add additional points-in-time, in between scheduled snapshots,
that MMS can use to create restores. Configure checkpoints using the Edit Snapshot Schedule link and interface.
This version marks a change in the numbering scheme of Backup Agents to support improved packaging options for
the Backup Agent.
273
Backup Agent v20131216.1
• Added support for connecting to MongoDB instances running SSL. See the Configure Backup Agent for SSL
documentation for more information.
• The agent will try to use additional MongoS instances to take a cluster snapshot if the first MongoS is unavailable.
Backup Agent v20131118.0
• Significantly reduced the amount of time needed by the agent to detect situations that require a resync.
• Allow automatic resync operations for config servers in sharded clusters. The agent can now resync automatically from these servers.
Backup Agent v20130923.0
When the agent sends the initial meta-data about the data to back up (e.g. the list of databases, collections,and indexes,)
to the MMS API, the agent will not include any databases or collections in the “excluded namespace” configuration.
Backup Agent v20130826.0
Adds support for managing excluded namespaces: Backup Agent will no longer send data for excluded collections or
databases.
Backup Agent v20130812.1
Major stability update
If the communication between the Backup Agent and the MMS Backup API is interrupted, the Backup Agent can
more reliably recover the current state. This results in fewer “resync required” errors.
274

Similar documents

×

Report this document