Query Performance Insights

[tnaum-ms]

Query Performance Insights

We’re excited to propose Query Performance Insights for MongoDB clusters, a feature that provides developers with detailed query performance metrics directly within the Collection View. This functionality aims to make it easier to understand, analyze, and optimize queries by leveraging MongoDB's explain command and related tools. Here’s the concept, and we’d love your input to refine it further.

This feature is scheduled for development soon, and we’d love to hear your thoughts!

You can track the release it’s planned for, explore the feature’s details and challenges, and stay updated on its progress by clicking here #2487.

Your feedback and votes are invaluable in helping us fine-tune priorities and ensure this extension truly serves everyone’s needs. We think we know our users, but your input can make all the difference - after all, you know your workflows best!

Proposed Feature Overview

The Query Performance feature will provide a dedicated tab within the Collection View to display detailed performance metrics and insights after each query execution. By using MongoDB’s explain command, it will highlight query execution paths, index usage, and potential optimization opportunities.

Core Features

1. Query Performance Tab

   • Automatically generate performance insights for every query executed in the Collection View.
   • Display query performance data in a new tab, adjacent to the query results tab, for seamless exploration.

2. Detailed explain Results

   • Present results of the explain command in a structured and readable format.
   • Include support for all verbosity levels (queryPlanner, executionStats, allPlansExecution) to provide varying levels of detail.

3. Index Usage Insights

   • Highlight indexes used in the query execution.
   • Show whether the query is fully indexed, partially indexed, or unindexed.

4. Index Suggestions

   • Provide recommendations for indexes that could optimize query performance, based on execution stats and query patterns.
   • Include an option to generate suggested indexes as editable templates for easy creation.

5. Performance Summary

   • Key metrics summary for each query:
     • Execution time (total and per operation).
     • Document and index scan counts.
     • Number of documents returned.
     • Stages in the query execution pipeline.
   • Flag potential performance bottlenecks, such as unindexed fields or large collection scans.

6. Customizable Display Options

   • Allow users to toggle between:
     • Table View: Tabular format for key metrics and index usage.
     • Dashboard View: Visualizations like bar charts, pie charts, and execution graphs for a more interactive analysis experience.

7. Actionable Insights

   • Highlight areas for improvement, such as:
     • Queries that could benefit from compound indexes.
     • Fields frequently involved in sorts, filters, or joins.
     • Expensive stages in the query execution plan.