mongocli cloud-manager metrics process¶
mongocli cloud-manager|cm metrics process <processID> --granularity <granularity> --period <period> --start <start> --end <end> [--type <type>] [ --output|-o <output-format> ] [ --profile|-P <profile-name> ] [ --projectId <project-ID> ]
--help to view the command-line help for
The host ID of the server running the Atlas MongoDB process for which to retrieve metrics. You can obtain the host ID string with the process list command.
An ISO-8601-formatted time period that specifies the interval
between metric data points. For example,
The following subset of ISO-8601-formatted time periods are supported:
When you specify
An ISO-8601-formatted time period that specifies the length of time in the past to query. For example, to request the last 36 hours, specify:
The time at which to start retrieving metrics, as specified by an ISO-8601 timestamp string. If you specify
The time at which to stop retrieving metrics, as specified by an ISO-8601 timestamp string. If you specify
Specifies which metric to return. If
You must specify metrics that are valid for the host. Atlas returns an error if any specified metrics are invalid.
The following metric values are valid:
The command prints the following fields in the specified format to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.
M0 Free Tier and
M2/M5 shared-tier clusters return a subset
of the metrics documented here.
If you set the query element
true, the response is wrapped
The HTTP response returns a JSON document that includes the following objects:
The end of the period for which to retrieve metrics, specified as an ISO-8601 timestamp.
An ISO-8601-formatted time period that specifies the size of the interval covered by each data point. For example,
ID of the project that owns the Atlas MongoDB process.
The hostname of the machine running the Atlas MongoDB process.
One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
An array of metrics and their data points.
An array of objects, where each object represents a single data point. If there is no data point available for a particular moment in time (i.e., a timestamp), the
The timestamp of the beginning of the time interval represented by this data point.
The value of the data point.
The name of the metric.
Units of measurement. Possible units are:
Name of the disk or partition to which the metrics pertain.
The hostname and port of the machine running the Atlas MongoDB process.
The start of the period for which to retrieve metrics, specified as an ISO-8601 timestamp.
The following example uses the
mongocli cloud-manager metrics process command
to retrieve the
CONNECTIONS process measurement for a host with ID
shard-00-02.qmljy.mongodb.net, listening on port
granularity is set to one minute, with a period of one minute. The
command uses the default profile where the project ID and the
Programmatic API Key