Auto Pausing Inactive Clusters

1
✗ realm-cli login --api-key="<Public API Key>" --private-api-key="<Private API Key>"
2
Successfully logged in

1
realm-cli push --remote="<Your App ID>"
2
3
...
4
A summary of changes
5
...
6
7
? Please confirm the changes shown above Yes
8
Creating draft
9
Pushing changes
10
Deploying draft
11
Deployment complete
12
Successfully pushed app up:

1
   if (!is_active) {
2
              console.log(`Pausing ${project.name}:${cluster.name} because it has been inactive for more then ${minutesInactive} minutes`);  
3
              //await context.functions.execute("pauseCluster", project.id, cluster.name, pause);

1
  /*
2
   * These project names are just an example. 
3
   * The same concept could be used to exclude clusters or even 
4
   * configure different inactivity intervals by project or cluster.
5
   * These configuration options could also be stored and read from 
6
   * and Atlas database.
7
   */
8
  excludeProjects = ['PROD1', 'PROD2'];   

1
/*
2
 * Returns an array of the projects in the organization
3
 * See https://docs.atlas.mongodb.com/reference/api/project-get-all/
4
 *
5
 * Returns an array of objects, e.g.
6
 *
7
 * {
8
 * "clusterCount": {
9
 *      "$numberInt": "1"
10
 *    },
11
 *    "created": "2021-05-11T18:24:48Z",
12
 *    "id": "609acbef1b76b53fcd37c8e1",
13
 *    "links": [
14
 *      {
15
 *        "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/609acbef1b76b53fcd37c8e1",
16
 *        "rel": "self"
17
 *      }
18
 *    ],
19
 *    "name": "mg-training-sample",
20
 *    "orgId": "5b4e2d803b34b965050f1835"
21
 *  }
22
  *
23
 */
24
exports = async function() {
25
  
26
  // Get stored credentials...
27
  const username = await context.values.get("AtlasPublicKey");
28
  const password = await context.values.get("AtlasPrivateKey");
29
  
30
  const arg = { 
31
    scheme: 'https', 
32
    host: 'cloud.mongodb.com', 
33
    path: 'api/atlas/v1.0/groups', 
34
    username: username, 
35
    password: password,
36
    headers: {'Content-Type': ['application/json'], 'Accept-Encoding': ['bzip, deflate']}, 
37
    digestAuth:true,
38
  };
39
  
40
  // The response body is a BSON.Binary object. Parse it and return.
41
  response = await context.http.get(arg);
42
43
  return EJSON.parse(response.body.text()).results; 
44
};

1
/*
2
 * Returns an array of the clusters for the supplied project ID.
3
 * See https://docs.atlas.mongodb.com/reference/api/clusters-get-all/
4
 *
5
 * Returns an array of objects. See the API documentation for details.
6
 * 
7
 */
8
exports = async function(project_id) {
9
  
10
  if (project_id == "Hello world!") { // Easy testing from the console
11
    project_id = "5e8f8268d896f55ac04969a1"
12
  }
13
  
14
  // Get stored credentials...
15
  const username = await context.values.get("AtlasPublicKey");
16
  const password = await context.values.get("AtlasPrivateKey");
17
  
18
  const arg = { 
19
    scheme: 'https', 
20
    host: 'cloud.mongodb.com', 
21
    path: `api/atlas/v1.0/groups/${project_id}/clusters`, 
22
    username: username, 
23
    password: password,
24
    headers: {'Content-Type': ['application/json'], 'Accept-Encoding': ['bzip, deflate']}, 
25
    digestAuth:true,
26
  };
27
  
28
  // The response body is a BSON.Binary object. Parse it and return.
29
  response = await context.http.get(arg);
30
31
  return EJSON.parse(response.body.text()).results; 
32
};

1
   Wed Nov 03 2021 19:52:31 GMT+0000 (UTC) - job is being run
2
   Wed Nov 03 2021 18:52:31 GMT+0000 (UTC) - cluster inactivity before this time will be reported inactive
3
   Wed Nov 03 2021 19:48:45 GMT+0000 (UTC) - last logged database access
4
Cluster is Active: Username 'brian' was active in cluster 'SA-SHARED-DEMO' 4 minutes ago.

1
/*
2
 * Used the database access history to determine if the cluster is in active use.
3
 * See https://docs.atlas.mongodb.com/reference/api/access-tracking-get-database-history-clustername/
4
 * 
5
 * Returns true (active) or false (inactive)
6
 * 
7
 */
8
exports = async function(project_id, clusterName, minutes) {
9
  
10
  if (project_id == 'Hello world!') { // We're testing from the console
11
    project_id = "5e8f8268d896f55ac04969a1";
12
    clusterName = "SA-SHARED-DEMO";
13
    minutes = 60;
14
  } /*else {
15
    console.log (`project_id: ${project_id}, clusterName: ${clusterName}, minutes: ${minutes}`)
16
  }*/
17
  
18
  // Get stored credentials...
19
  const username = await context.values.get("AtlasPublicKey");
20
  const password = await context.values.get("AtlasPrivateKey");
21
  
22
  const arg = { 
23
    scheme: 'https', 
24
    host: 'cloud.mongodb.com', 
25
    path: `api/atlas/v1.0/groups/${project_id}/dbAccessHistory/clusters/${clusterName}`, 
26
    //query: {'authResult': "true"},
27
    username: username, 
28
    password: password,
29
    headers: {'Content-Type': ['application/json'], 'Accept-Encoding': ['bzip, deflate']}, 
30
    digestAuth:true,
31
  };
32
  
33
  // The response body is a BSON.Binary object. Parse it and return.
34
  response = await context.http.get(arg);
35
  
36
  accessLogs = EJSON.parse(response.body.text()).accessLogs; 
37
38
  now = Date.now();
39
  const MS_PER_MINUTE = 60000;
40
  var durationInMinutes = (minutes < 30, 30, minutes);   // The log granularity is 30 minutes.
41
  var idleStartTime = now - (durationInMinutes * MS_PER_MINUTE);
42
  
43
  nowString = new Date(now).toString();
44
  idleStartTimeString = new Date(idleStartTime).toString();
45
  console.log(`Checking if cluster '${clusterName}' has been active in the last ${durationInMinutes} minutes`)
46
  console.log(`   ${nowString} - job is being run`);
47
  console.log(`   ${idleStartTimeString} - cluster inactivity before this time will be reported inactive`);
48
  
49
  clusterIsActive = false;
50
  
51
  accessLogs.every(log => {
52
    if (log.username != 'mms-automation' && log.username != 'mms-monitoring-agent') {
53
      
54
      // Convert string log date to milliseconds 
55
      logTime = Date.parse(log.timestamp);
56
57
      logTimeString = new Date(logTime);
58
      console.log(`   ${logTimeString} - last logged database access`);
59
      
60
      var elapsedTimeMins = Math.round((now - logTime)/MS_PER_MINUTE, 0);
61
      
62
      if (logTime > idleStartTime ) {
63
        console.log(`Cluster is Active: Username '${log.username}' was active in cluster '${clusterName}' ${elapsedTimeMins} minutes ago.`);
64
        clusterIsActive = true;
65
        return false;
66
      } else {
67
        // The first log entry is older than our inactive window
68
        console.log(`Cluster is Inactive: Username '${log.username}' was active in cluster '${clusterName}' ${elapsedTimeMins} minutes ago.`);
69
        clusterIsActive = false;
70
        return false;
71
      }
72
    }
73
    return true;
74
75
  });
76
77
  return clusterIsActive;
78
79
};

1
/*
2
 * Pauses the named cluster 
3
 * See https://docs.atlas.mongodb.com/reference/api/clusters-modify-one/
4
 *
5
 */
6
exports = async function(projectID, clusterName, pause) {
7
  
8
  // Get stored credentials...
9
  const username = await context.values.get("AtlasPublicKey");
10
  const password = await context.values.get("AtlasPrivateKey");
11
  
12
  const body = {paused: pause};
13
  
14
  const arg = { 
15
    scheme: 'https', 
16
    host: 'cloud.mongodb.com', 
17
    path: `api/atlas/v1.0/groups/${projectID}/clusters/${clusterName}`, 
18
    username: username, 
19
    password: password,
20
    headers: {'Content-Type': ['application/json'], 'Accept-Encoding': ['bzip, deflate']}, 
21
    digestAuth:true,
22
    body: JSON.stringify(body)
23
  };
24
  
25
  // The response body is a BSON.Binary object. Parse it and return.
26
  response = await context.http.patch(arg);
27
28
  return EJSON.parse(response.body.text()); 
29
};

1
/*
2
 * Iterates over the organizations projects and clusters, 
3
 * pausing clusters inactive for the configured minutes.
4
 */
5
exports = async function() {
6
  
7
  minutesInactive = 60;
8
  
9
  /*
10
   * These project names are just an example. 
11
   * The same concept could be used to exclude clusters or even 
12
   * configure different inactivity intervals by project or cluster.
13
   * These configuration options could also be stored and read from 
14
   * and Atlas database.
15
   */
16
  excludeProjects = ['PROD1', 'PROD2'];   
17
  
18
  const projects = await context.functions.execute("getProjects");
19
  
20
  projects.forEach(async project => {
21
    
22
    if (excludeProjects.includes(project.name)) {
23
      console.log(`Project '${project.name}' has been excluded from pause.`)
24
    } else {
25
      
26
      console.log(`Checking project '${project.name}'s clusters for inactivity...`);
27
28
      const clusters = await context.functions.execute("getProjectClusters", project.id);
29
      
30
      clusters.forEach(async cluster => {
31
        
32
        if (cluster.providerSettings.providerName != "TENANT") {   // It's a dedicated cluster than can be paused
33
        
34
          if (cluster.paused == false) {
35
        
36
            is_active =  await context.functions.execute("clusterIsActive", project.id, cluster.name, minutesInactive);
37
            
38
            if (!is_active) {
39
              console.log(`Pausing ${project.name}:${cluster.name} because it has been inactive for more then ${minutesInactive} minutes`);  
40
              //await context.functions.execute("pauseCluster", project.id, cluster.name, true);
41
            } else {
42
              console.log(`Skipping pause for ${project.name}:${cluster.name} because it has active database users in the last ${minutesInactive} minutes.`);
43
            }
44
          }
45
        }
46
      });
47
     }
48
    });
49
50
  return true;
51
};