atlas api performanceAdvisor listSlowQueries
On this page
experimental: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified.
The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listSlowQueries'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries
Syntax
atlas api performanceAdvisor listSlowQueries [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--duration | int | false | length of time expressed during which the query finds slow queries among the managed namespaces in the cluster |
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for listSlowQueries | |
--nLogs | int | false | maximum number of lines from the log to return |
--namespaces | stringArray | false | namespaces from which to retrieve slow queries |
--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) |
--pretty | false | flag that indicates whether the response body should be in the prettyprint format | |
--processId | string | true | combination of host and port that serves the MongoDB process |
--since | int | false | date and time from which the query retrieves the slow queries |
--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. |