Free Monitoring¶

Monitored Data¶

Free monitoring provides information about your deployment, including:

• Operation Execution Times
• Memory Usage
• CPU Usage
• Operation Counts

The data expires 24 hours after being uploaded. For more information on the data upload and expiration, see Monitored Data and Expiration.

Enable/Disable Free Monitoring¶

By default, you can enable/disable free monitoring during runtime using db.enableFreeMonitoring() and db.disableFreeMonitoring().

You can also enable or disable free monitoring during mongod startup using either:

• the configuration file setting cloud.monitoring.free.state or
• the command-line option --enableFreeMonitoring

Once you enable free monitoring, it remains enabled until you disable it.

To view the state of your free monitoring,

• Use the db.getFreeMonitoringStatus() method.
• The serverStatus and the helper db.serverStatus() also includes free monitoring statistics in the freeMonitoring field.

Access Control¶

When running with access control, the user must have the following privileges to enable free monitoring and get status:

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

The built-in role clusterMonitor role provides this privilege.

Monitored Data and Expiration¶

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.

If you disable free monitoring and later re-enable free monitoring, you can access your previous metrics that have not expired within the past 24 hours.

Monitoring URL¶

When you enable free monitoring, you are provided with a unique URL where you can access your monitored data.