setFreeMonitoring

Definition

setFreeMonitoring

New in version 4.0: Available for MongoDB Community Edition.

Enables or disables free Cloud monitoring for standalones and replica sets.

The command is run against the admin database.

Important

To run setFreeMonitoring, 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.

Syntax

The command has the following syntax:

db.adminCommand(
   {
     setFreeMonitoring: 1,
     action: "<enable|disable>"
   }
)

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.

mongosh provides the following helper methods for setFreeMonitoring:

• db.enableFreeMonitoring()

• db.disableFreeMonitoring()

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

Access Control

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

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

The built-in role clusterMonitor role provides this privilege.