Navigation
This version of the documentation is archived and no longer supported.

Free Monitoring

Warning

Free monitoring is deprecated

Free monitoring will be deprecated in April 2023 and decommissioned in August 2023.

Beginning in April 2023, new users can’t enable free monitoring on MongoDB Community instances. Deployments currently using free monitoring can continue to access the free monitoring UI until August 2023.

You can choose another monitoring option for your deployment:

  • Deploy a MongoDB Atlas dedicated cluster. Migrate your data to a MongoDB Atlas dedicated cluster sized M10 or greater, which includes several advanced monitoring and alerting features:

    Get $100 in Atlas credits by applying the code FREE-MONITORING-100. Limited to the first 300 users.

  • Deploy a MongoDB Atlas free cluster. A free Atlas cluster includes basic monitoring and alerting capabilities. After you create a free cluster, use mongodump and mongorestore to manually create a backup of your database and import your data from your MongoDB Community instance.

  • Use MongoDB Cloud Manager. The MongoDB Cloud Manager free tier includes basic monitoring capabilities.

New in version 4.0.

Starting in version 4.0, MongoDB (Community Edition) offers free Cloud monitoring for standalones and replica sets.

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:

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

To view the state of your free monitoring,

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.

Important

Anyone with whom you share this unique URL can access your monitored data.