getFreeMonitoringStatus

On this page

Definition

Syntax
Access Control
Output

Warning

Free monitoring is deprecated

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

Beginning in April 2023, you 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:
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.

Definition

getFreeMonitoringStatus: New in version 4.0.
Returns the status of whether free Cloud monitoring is enabled for standalone or replica sets (including shards).

Syntax

The command has the following syntax:

db.adminCommand(
   {
     getFreeMonitoringStatus: 1
   }
)

mongosh provides the db.getFreeMonitoringStatus() helper for the command.

Access Control

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

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

The built-in role clusterMonitor role provides this privilege.

Output

The command returns a document with the following fields:

Field	Description
`state`	The free monitoring enablement state. Values are either: `"enabled"` or `"disabled"`.
`message`	Any informational message related to your state.
`url`	The unique URL at which your monitoring data can be accessed. Note Anyone with whom you share the URL can access your monitored data. Even when disabled, your unique URL is returned so that if you re-enable monitoring, you can access your previous metrics, if collected less than 24 hours ago.
`userReminder`	Any informational message related to your state.
`ok` `operationTime` `$clusterTime`	For details on these fields, see Response.