Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Commands
/
api
/
monitoringAndLogs

atlas api monitoringAndLogs getDatabaseMeasurements

On this page

  • Syntax
  • Options
  • Inherited Options

experimental: Returns the measurements of one database for the specified host for the specified project.

Returns the database's on-disk storage space based on the MongoDB dbStats command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getDatabaseMeasurements'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements

Syntax

Command Syntax
atlas api monitoringAndLogs getDatabaseMeasurements [options]

Options

Name
Type
Required
Description

--databaseName

string

true

human-readable label that identifies the database that the specified MongoDB process serves

--end

string

false

date and time when MongoDB Cloud stops reporting the metrics

--envelope

false

flag that indicates whether Application wraps the response in an envelope JSON object

--granularity

string

true

duration that specifies the interval at which Atlas reports the metrics

--groupId

string

true

unique 24-hexadecimal digit string that identifies your project

-h, --help

false

help for getDatabaseMeasurements

--m

stringArray

false

one or more types of measurement to request for this MongoDB process

--output

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

--output-file

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

--period

string

false

duration over which Atlas reports the metrics

--pretty

false

flag that indicates whether the response body should be in the prettyprint format

--processId

string

true

combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process

--start

string

false

date and time when MongoDB Cloud begins reporting the metrics

--version

string

false

api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

Inherited Options

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Back

getDatabase

Next

getDiskMeasurements