Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] PMM-9288 - Extended metrics and labels for MongoDB QAN #3752

Open
wants to merge 7 commits into
base: doc-release-3.1.0
Choose a base branch
from

Conversation

catalinaadam
Copy link
Contributor

PMM-0

Link to the Feature Build: SUBMODULES-0

If this PR adds or removes or alters one or more API endpoints, please review and add or update the relevant API documents as well:

  • API Docs updated

If this PR is related to some other PRs in this or other repositories, please provide links to those PRs:

  • Links to related pull requests (optional).

@catalinaadam catalinaadam requested a review from a team as a code owner March 7, 2025 13:26
- `keys_examined`: number of index entries scanned
- `nreturned`: number of documents returned by the query
- `response_length`: size of the response in bytes
- `millis`: query execution time in milliseconds
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Millis are same like "Query Time" in this case. No need to mention it.



#### Additional MongoDB QAN metrics
The following metrics are now available in QAN for MongoDB queries:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we mention that these are in "details" for query?

Comment on lines 60 to 72
- `docs_examined`: number of documents scanned during query execution
- `keys_examined`: number of index entries scanned
- `nreturned`: number of documents returned by the query
- `response_length`: size of the response in bytes
- `millis`: query execution time in milliseconds
- `locks_global_acquire_count_read_shared`: global read lock acquisition count
- `locks_global_acquire_count_write_shared`: global write lock acquisition count
- `locks_database_acquire_count_read_shared`: database read lock acquisition count
- `locks_database_acquire_wait_count_read_shared`: database read lock wait count
- `locks_database_time_acquiring_micros_read_shared`: time spent acquiring database locks in microseconds
- `locks_collection_acquire_count_read_shared`: collection read lock acquisition count
- `storage_bytes_read`: amount of data read from storage in bytes
- `storage_time_reading_micros`: time spent reading from storage in microseconds
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@catalinaadam catalinaadam changed the title Rel Notes for extended metrics and labels for MongoDB QAN [DOCS] PMM-9288 - Extended metrics and labels for MongoDB QAN Mar 10, 2025
- **Username**
- **Service Type**
- **Node Type**
- **City**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are not real filters, maybe leftover?


### MongoDB-specific filter groups
- **Plan Summary**: filters queries by execution plan type (COLLSCAN, IXSCAN, etc.) to easily identify inefficient full collection scans
- **Client Application Name**: filters queries by the application name that generated them
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is available for PG also

@sleto-it sleto-it added the documentation Documentation changes label Mar 11, 2025
Comment on lines +35 to +36
- **City**
- **AZ**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **City**
- **AZ**

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants