Navigation
This is an upcoming (i.e. in progress) version of the manual.

db.enableFreeMonitoring()

db.enableFreeMonitoring()

New in version 4.0: Available for MongoDB Community Edition.

Enables free monitoring for standalones and replica sets and returns the free monitoring status.s

Important

To run db.enableFreeMonitoring(), you must have specified --enableFreeMonitoring command-line option or cloud.monitoring.free.state configuration file set to runtime.

Otherwise, you can only enable or disable at startup. See --enableFreeMonitoring command-line option or cloud.monitoring.free.state for details.

The db.enableFreeMonitoring() method is a wrapper around the setFreeMonitoring command.

Behavior

Once enabled, the free monitoring state remains enabled until explicitly disabled. That is, you do not need to re-enable each time you start the server.

Once enabled, you are provided with a unique URL where you can access your monitored data.

When enabled, the monitored data is uploaded periodically. The monitored data expires after 24 hours. That is, you can only access monitored data that has been uploaded within the past 24 hours.

For the frequency with which data is uploaded, see freeMonitoring.retryIntervalSecs.

Access Control

When running with access control, the user must have the setFreeMonitoring and checkFreeMonitoringStatus privilege actions on the cluster. That is, a user must have a role that grants the following privilege:

{ resource: { cluster : true }, actions: [ "setFreeMonitoring" , "checkFreeMonitoringStatus"] }

The built-in role clusterMonitor role provides this privilege.

Example

To enable free monitoring, run the following from the mongo shell:

db.enableFreeMonitoring()

This starts the registration process for free monitoring. The method returns your free monitoring status:

{
   "state" : "enabled",
   "message" : "To see your monitoring data, navigate to the unique URL below.\nAnyone you share the URL with will also be able to view this page.\n\nhttps://cloud.mongodb.com/freemonitoring/mongo/MSBjZTZhNTJmOS0yODg1\n\nYou can disable monitoring at any time by running db.disableFreeMonitoring().",
   "url" : "https://cloud.mongodb.com/freemonitoring/mongo/MSBjZTZhNTJmOS0yODg1",
   "userReminder" : "",
   "ok" : 1
}

Tip

You can also use db.getFreeMonitoringStatus() any time to check your free monitoring status.