atlas metrics processes

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

Return the process measurements for the specified host.

To return the hostname and port needed for this command, run atlas processes list

Syntax

atlas metrics processes <hostname:port> [options]

Arguments

Name	Type	Required	Description
hostname:port	string	true	Hostname and port number of the instance running the MongoDB process.

Options

Name	Type	Required	Description
--end	string	false	ISO 8601-formatted date and time that specifies when to stop retrieving measurements. You can't set this parameter and period in the same request.
--granularity	string	true	ISO 8601-formatted duration 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. When you specify granularity, you must specify either period or start and end.
-h, --help		false	help for processes
--limit	int	false	Number of items per results page. This value defaults to 100.
-o, --output	string	false	Output format. Valid values are json, json-path, go-template, or go-template-file.
--page	int	false	Page number that specifies a page of results. This value defaults to 1.
--period	string	false	ISO 8601-formatted time period that specifies the length of time in the past to query. You can't set this parameter and start/end in the same request
--projectId	string	false	Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
--start	string	false	ISO 8601-formatted date and time that specifies when to start retrieving measurements. You can't set this parameter and period in the same request.
--type	strings	false	Measurements to return. If this is not specified, all measurements are returned. Valid values are DATABASE_AVERAGE_OBJECT_SIZE, DATABASE_COLLECTION_COUNT, DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_INDEX_COUNT, DATABASE_EXTENT_COUNT, DATABASE_OBJECT_COUNT, and DATABASE_VIEW_COUNT

Inherited Options

Name	Type	Required	Description
-P, --profile	string	false	Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Examples

# Return the JSON-formatted process metrics for the host atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017
atlas metrics processes atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --output json

Back

list

networking