mongocli atlas metrics disks describe

On this page

Syntax

Options
Output
Example

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.

The metrics disks describe command lists the available metrics for a specified partition on a specified Atlas host. You can get a list of partition names for a host with the metrics disks list command. You can get the hostnames associated with a particular Atlas project with the process list command.

Syntax

mongocli atlas metrics disks describe <hostname>:<port> <partition-name>
     --granularity <granularity>
     --period <period>
     --start <start>
     --end <end>
     [--type <type>]
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Note

Use -h or --help to view the command-line help for this command.

Options

Option

Type

Description

Required?

<hostname>:<port>

String

The hostname of the server running the Atlas MongoDB process and the port on which the process listens.

yes

<partition-name>

string

The name of the disk or partition for which to get available metrics.

yes

--granularity

String

An ISO-8601-formatted time period that specifies the interval between measurement data points. For example, PT1M specifies 1-minute granularity.

The following subset of ISO-8601-formatted time periods are supported:

PT1M
PT5M
PT1H
P1D

When you specify granularity, you must specify either period or start and end.

yes

--period

String

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: period=P1DT12H. Mutually exclusive with start and end.

yes

--start

String

The time at which to start retrieving metrics, as specified by an ISO-8601 timestamp string. If you specify start, you must also specify end. Mutually exclusive with period.

yes

--end

String

The time at which to stop retrieving metrics, as specified by an ISO-8601 timestamp string. If you specify end, you must also specify start. Mutually exclusive with period.

yes

--type

String

Specifies which measurement to return. If type is not specified, all metrics are returned.

You must specify a measurement that is valid for the host. Atlas returns an error if a specified measurement is invalid.

The following measurement values are valid:

`DISK_PARTITION_IOPS_READ` `DISK_PARTITION_IOPS_WRITE` `DISK_PARTITION_IOPS_TOTAL`	Measures throughput of I/O operations for the disk partition used for MongoDB.
`DISK_PARTITION_UTILIZATION`	The percentage of time during which requests are being issued to and serviced by the partition. This includes requests from any process, not just MongoDB processes.
`DISK_PARTITION_LATENCY_READ` `DISK_PARTITION_LATENCY_WRITE`	Measures latency, per operation type, of the disk partition used by MongoDB.
`DISK_PARTITION_SPACE_FREE` `DISK_PARTITION_SPACE_USED` `DISK_PARTITION_SPACE_PERCENT_FREE` `DISK_PARTITION_SPACE_PERCENT_USED`	Measures the free disk space and used disk space on the disk partition used by MongoDB.

--output, -o

string

Command output format. Valid values are:

json for output in JSON format
go-template for custom output using the Go template
go-template-file for custom output specified using Go template file

If omitted, the command returns output in the default format.

--profile, -P

string

Name of the profile where the project ID and the Programmatic API Keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.

--projectId

string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

Output

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.

Important

Free Tier

M0 Free Tier and M2/M5 shared-tier clusters return a subset of the metrics documented here.

If you set the query element envelope to true, the response is wrapped by the content object.

The HTTP response returns a JSON document that includes the following objects:

Name	Type	Description
`end`	string	The end of the period for which to retrieve metrics, specified as an ISO-8601 timestamp.
`granularity`	string	An ISO-8601-formatted time period that specifies the size of the interval covered by each data point. For example, `PT5M` specifies a 5-minute granularity.
`groupId`	string	The ID of the project that owns the Atlas MongoDB process.
`hostId`	string	The hostname of the machine running the Atlas MongoDB process.
`links`	document array	One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
`measurements`	object array	An array of metrics and their data points.
`measurements.name`	string	The name of the measurement.
`measurements.units`	string	How the measurement is quantified. Possible units are: `PERCENT` `MILLISECONDS` `BYTES` `GIGABYTES` `BYTES_PER_SECOND` `MEGABYTES_PER_SECOND` `GIGABYTES_PER_HOUR` `SCALAR_PER_SECOND` `SCALAR`
`partitionName`	string	Name of the disk or partition to which the metrics pertain.
`processId`	string	The hostname and port of the machine running the Atlas MongoDB process.
`start`	string	The start of the period for which to retrieve metrics, specified as an ISO-8601 timestamp.

Example

The following example uses the mongocli atlas metrics disks describe command to retrieve available process metrics for the data partition on a host with ID atlas-ap6k8a-shard-00-02.qmljy.mongodb.net, listening on port 27017. The 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 Keys are stored.

mongocli atlas metrics disks describe \
  atlas-ap6k8a-shard-00-02.qmljy.mongodb.net:27017 data \
  --granularity PT1M --period PT1M --output json

The previous command produces the following output.

{
     "end": "",
     "granularity": "PT1M",
     "groupId": "5dd5a6b6f10fab1d71a58495",
     "hostId": "atlas-ap6kaa-shard-00-02.qmajy.mongodb.net:27017",
     "links": [
             {
                     "rel": "self",
                     "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5dd5a6b6f10fab1d71a58495/processes/atlas-ap6kaa-shard-00-02.qmajy.mongodb.net:27017/disks/data/measurements?granularity=PT1M\u0026period=PT1M"
             },
             {
                     "rel": "http://mms.mongodb.com/host",
                     "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5dd5a6b6f10fab1d71a58495/processes/atlas-ap6kaa-shard-00-02.qmajy.mongodb.net:27017"
             }
     ],
     "measurements": [
             {
                     "name": "DISK_PARTITION_IOPS_READ",
                     "units": "SCALAR_PER_SECOND"
             },
             {
                     "name": "DISK_PARTITION_IOPS_WRITE",
                     "units": "SCALAR_PER_SECOND"
             },
             {
                     "name": "DISK_PARTITION_IOPS_TOTAL",
                     "units": "SCALAR_PER_SECOND"
             },
             {
                     "name": "DISK_PARTITION_UTILIZATION",
                     "units": "PERCENT"
             },
             {
                     "name": "DISK_PARTITION_LATENCY_READ",
                     "units": "MILLISECONDS"
             },
             {
                     "name": "DISK_PARTITION_LATENCY_WRITE",
                     "units": "MILLISECONDS"
             },
             {
                     "name": "DISK_PARTITION_SPACE_FREE",
                     "units": "BYTES"
             },
             {
                     "name": "DISK_PARTITION_SPACE_USED",
                     "units": "BYTES"
             },
             {
                     "name": "DISK_PARTITION_SPACE_PERCENT_FREE",
                     "units": "PERCENT"
             },
             {
                     "name": "DISK_PARTITION_SPACE_PERCENT_USED",
                     "units": "PERCENT"
             }
     ],
     "processId": "atlas-ap6kaa-shard-00-02.qmajy.mongodb.net:27017",
     "start": "",
     "partitionName": "data"
 }

Back

List Available Databases for a Process

List Available Partitions