Navigation

getFreeMonitoringStatus

getFreeMonitoringStatus

New in version 4.0.

Returns the status of whether free Cloud monitoring is enabled for standalone or replica sets (including shards).

The command is run against the admin database and has the form:

db.adminCommand( { getFreeMonitoringStatus: 1 } )

The mongo shell provides the db.getFreeMonitoringStatus() helper for the command.

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.

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.
Tip
See also:

freeMonitoring field returned from db.serverStatus()

Give Feedback

On this page

  • Access Control
  • Output