db.getFreeMonitoringStatus¶

On this page

Access Control
Output
Example

db.getFreeMonitoringStatus()¶

Returns information on free monitoring status.

The mongo shell helper db.getFreeMonitoringStatus() is a wrapper around the getFreeMonitoringStatus 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:

copy

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

The built-in role clusterMonitor role provides this privilege.

Output¶

The method 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 this unique 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.
`userReminder`	Any informational message related to your state.
`ok`	Status of the `getFreeMonitoringStatus` operation itself. Values are either: `1` if the operation was successful. `0` if the operation was not successful.

Example¶

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

copy

db.getFreeMonitoringStatus()

The method returns information on your free monitoring status.

copy

{
   "state" : "enabled",
   "message" : "To see your monitoring data, navigate to the unique URL below.\nAnyone you share the URL with will also be able to view this page.\n\nhttps://cloud.mongodb.com/freemonitoring/mongo/MSBjZTZhNTJmOS0yODg1\n\nYou can disable monitoring at any time by running db.disableFreeMonitoring().",
   "url" : "https://cloud.mongodb.com/freemonitoring/mongo/MSBjZTZhNTJmOS0yODg1",
   "userReminder" : "",
   "ok" : 1
}