[DOCS-11962] Docs for SERVER-35981: Include hash of plan cache key in planCacheListShapes and planCacheListPlans Created: 13/Aug/18 Updated: 13/Nov/23 Resolved: 31/Jan/19 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | manual, Server |
| Affects Version/s: | None |
| Fix Version/s: | 4.1.2, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113 |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Kay Kim (Inactive) | Assignee: | Kay Kim (Inactive) |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||||||||||
| Participants: | |||||||||||||||||||||||||||||
| Days since reply: | 5 years, 2 weeks ago | ||||||||||||||||||||||||||||
| Epic Link: | DOCS: 4.2 Server/Tools | ||||||||||||||||||||||||||||
| Description |
|
---------------------------- Original DescriptionDescription:The "queryHash" is now present in planCacheListPlans and planCacheListQueryShapes output. We may wish to document this in pages about these debug mechanisms? Right now it looks like we don't have detailed documentation about the output of these commands – I think we might want to keep it that way, in order to prevent users from depending too much on the particular format. These commands are mostly for use by TSEs or others who are diagnosing query performance issues. All queries with the same hash are considered the same "shape", and use the same plan cache entry. This may be useful for diagnosing issues around query performance. Please ask Storch for more details, and to review any proposed documentation changes. Note that https://jira.mongodb.org/browse/SERVER-23332 added this same 'queryHash' to the logs and system.profile, and https://jira.mongodb.org/browse/SERVER-36527 added it to explain output. ---------------------------- DescriptionScope of changes (files that need work and how much)
note: we're missing collation from the plancache methods/commands – but will do it as a separate ticket in order to backport just those through 3.4. Impact to other docs outside of this productMVP (work and date?)Resources (e.g. Scope Docs, Invision) |
| Comments |
| Comment by Githook User [ 31/Jan/19 ] |
|
Author: {'email': 'kay.kim@mongodb.com', 'name': 'Kay Kim'}Message: |