[DOCS-16226] Create public documentation on observability limitations of QE Created: 28/Jun/23  Updated: 30/Oct/23  Resolved: 01/Aug/23

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Task Priority: Major - P3
Reporter: Erwin Pe Assignee: Nick Villahermosa
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Participants:
Days since reply: 27 weeks, 1 day ago
Epic Link: DOCSP-30633

 Description   

Add a disclaimer up front under considerations for enabling QE that mentions the redaction impact on supportability, and then link to the Limitations topic for the detailed information on which methods/commands are affected by it.



 Comments   
Comment by Nick Villahermosa [ 01/Aug/23 ]

PR: https://github.com/10gen/docs-mongodb-internal/pull/4192

Comment by Erwin Pe [ 21/Jul/23 ]

nick.villahermosa@mongodb.com Also, please add either Spencer Brown or Kevin Arhelger to the doc reviewers. Thanks!

Comment by Nick Villahermosa [ 21/Jul/23 ]

Sounds good. I'll make sure the docs note that, and run this past you for dev review once it's ready.

Comment by Erwin Pe [ 21/Jul/23 ]

nick.villahermosa@mongodb.com my intent for this ticket is for our QE documentation to stress the fact that due to the limited visibility into QE collections, we cannot help customers with analyzing specific QE query performance, and so they will have to use a third-party application performance monitoring tool to collect metrics and detect whether there are any perf issues on QE operations. As long as this is made clear in the public docs, I'm happy to have the docs team complete this ticket.

Comment by Nick Villahermosa [ 21/Jul/23 ]

erwin.pe@mongodb.com to clarify, since this is public facing doc I think the approach for our existing server docs should be to mention the information up front in the initial QE topics and note it as a consideration, then link to the existing information on redaction in the Limitations topic. Is there other work here that you're actively progressing, or is it fine to take on this ticket as a docs team item?

Comment by Erwin Pe [ 20/Jul/23 ]

Hi sarah.olson@mongodb.com. My plan is to get this in before the project end date of 08/07.

Comment by Cynthia Braund (Inactive) [ 20/Jul/23 ]

the work for 7.1 is to help support handle the lack of info on the server side.  The actual thing that made them lose the visibility is in 7.0.  Let me look at the docs and see if we need some stronger wording than we already have.

Comment by Sarah Olson [ 20/Jul/23 ]

Hi erwin.pe@mongodb.com, cynthia.braund@mongodb.com, Just wanting to be sure we correctly prioritize this ticket. Is this something we'll want to prioritize for 7.0 Server GA in August? Or is this something later? I see the engineering epic is set to a 7.1 release. When should we plan for these docs to land? 

Thanks a ton in advance!

 

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