Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli atlas metrics databases describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Examples

Describe database metrics for a database on a specific host.

To retrieve the hostname and port needed for this command, run mongocli atlas process list.

mongocli atlas metrics databases describe <host:port> <databaseName> [options]
Name
Type
Required
Description
hostname:port
string
true
Hostname and port number of the instance running the Atlas MongoDB process.
databaseName
string
true
Label that identifies the database from which you want to retrieve metrics.
Name
Type
Required
Description
--end
string
false
End of the period, in UNIX Epoch format, until which to retrieve measurements.
--granularity
string
true
Duration in ISO 8601 notation that specifies the interval between measurement data points. Only the following subset of ISO 8601-formatted time periods are supported: PT10S, PT1M, PT5M, PT1H, P1D.
-h, --help
false
help for describe
--limit
int
false
Number of items per page.
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file.
--page
int
false
Page number.
--period
string
false
Duration in ISO 8601 that specifies how far back in the past to retrieve measurements.
--projectId
string
false
Project ID to use. Overrides the settings in the configuration file or environment variable.
--start
string
false
Beginning of the period, in UNIX Epoch format, from which to start retrieving measurements.
--type
strings
false
Measurements to return. If it is not specified, all measurements are returned.
Name
Type
Required
Description
-P, --profile
string
false
Profile to use from your configuration file.
This example retrieves database metrics for the database "testDB" in the host "atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017"
$ mongocli atlas metrics database describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 testDB --granularity PT1M --period P1DT12H
←  mongocli atlas metrics databasesmongocli atlas metrics databases list →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.