[DOCS-15553] Investigate changes in SERVER-62760: Add information to query log line indicating when the new optimizer is used Created: 19/Aug/22  Updated: 13/Nov/23  Due: 16/Sep/22  Resolved: 22/Sep/22

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 6.1.0-rc0, 6.0.3, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Alison Huh
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-62760 Add information to query log line ind... Closed
Participants:
Days since reply: 1 year, 8 weeks, 2 days ago
Epic Link: DOCSP-21764
Story Points: 1

 Description   
Original Downstream Change Summary

1. Rename the `queryExecutionEngine` field to `queryFramework` in the $serverStatus output, the slow query log, and the system.profile entries.

2. Add an additional possible value ("cqf") for the `queryFramework` field.

This change will be backported to 6.0.

Description of Linked Ticket

null

FROM DOCS-15061

NOTE: DOCS-15061 has been closed and instead combined with DOCS-15553

Related to SERVER-60848

Downstream Change Summary

This patch makes changes to the slow query log line as well as the serverStatus counters. It also changes the system.profile collection, which will have identical fields to the new slow query log line. This change will also be backported to 5.2.

Description of Linked Ticket

Add a field that indicates whether we used classic or SBE for a query. We should backport it to 5.1. At the least we want to see how many queries are exposed to SBE.

Worth considering:

  • just logging a field if the less common case happens (e.g. "sbe")
  • should we use the same field in the future for the optimizer (e.g. "sbe" (executed with sbe) / "cqf" (optimized and executed with cqf)


 Comments   
Comment by Githook User [ 12/Dec/22 ]

Author:

{'name': 'Alison Huh', 'email': '112565127+ajhuh-mdb@users.noreply.github.com', 'username': 'ajhuh-mdb'}

Message: DOCS-15553 add queryFramework info (#1866)

  • cut out detailed sub-fields
  • add queryFramework to system.profile sample
  • add description in system.profile
  • add slow log examples
  • add queryFramework to slow query run on views
  • clarify subfields, clean up log examples, alphabetize values
  • match style guide for references
  • fix broken ref link
  • minor changes
  • fix wording in examples reference
  • fix wording in examples reference... again
  • small edits to subfield descriptions
  • final copy edits + add ref tag to slow oplog example
  • final final copy edits
  • [nit] monospacing aggregate and find
  • edit query engine text
  • review edits + start glossary entry for queryFramework
  • insert query framework definition (unfinished)
  • link query framework glossary entry to other pages
  • fix typo in server status def
  • change out doc link for ref
  • nit edit 'query execution engine'
Comment by Education Bot [ 19/Oct/22 ]

Fix Version updated for upstream SERVER-62760:
6.1.0-rc0, 6.0.3

Comment by Githook User [ 21/Sep/22 ]

Author:

{'name': 'Alison Huh', 'email': '112565127+ajhuh-mdb@users.noreply.github.com', 'username': 'ajhuh-mdb'}

Message: DOCS-15553 add queryFramework info (#1866)

  • cut out detailed sub-fields
  • add queryFramework to system.profile sample
  • add description in system.profile
  • add slow log examples
  • add queryFramework to slow query run on views
  • clarify subfields, clean up log examples, alphabetize values
  • match style guide for references
  • fix broken ref link
  • minor changes
  • fix wording in examples reference
  • fix wording in examples reference... again
  • small edits to subfield descriptions
  • final copy edits + add ref tag to slow oplog example
  • final final copy edits
  • [nit] monospacing aggregate and find
  • edit query engine text
  • review edits + start glossary entry for queryFramework
  • insert query framework definition (unfinished)
  • link query framework glossary entry to other pages
  • fix typo in server status def
  • change out doc link for ref
  • nit edit 'query execution engine'
Comment by Education Bot [ 19/Aug/22 ]

Fix Version updated for upstream SERVER-62760:
6.1.0-rc0

Generated at Thu Feb 08 08:13:14 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.