[DOCS-11571] audit currentOp Created: 10/Apr/18  Updated: 27/Oct/23  Resolved: 05/Sep/18

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: 3.6

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Unassigned
Resolution: Gone away Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 5 years, 44 weeks, 1 day ago
Epic Link: DOCSP-1769
Story Points: 1.5

 Description   

Description

3.6 added $currentOp pipeline stage which uses the new db.aggregate() helper in the admin database.

As $currentOp is not limited to the 16MB BSON size limit that the current currentOp command/db.currentOp method are restricted to, we should audit for when $currentOp should be used instead of the other two. Should also reference $currentOp in the currentOp/db.currentOp pages as well.

Scope of changes (files that need work and how much)

currentOp and db.currentOp() do not currently reference the 16MB limit. Both pages should have a "Behavior" section added with this limit explicitly listed, and should point to $currentOp as an alternative.

Need to audit the following pages (where currentOp is referenced:

source//administration/monitoring.txt
source//core/index-creation.txt
source//core/index-ttl.txt
source//core/read-isolation-consistency-recency.txt
source//faq/concurrency.txt
source//faq/indexes.txt
source//includes/apiargs-dbcommand-aggregate-field.yaml
source//includes/apiargs-method-db.currentOp-param.yaml
source//includes/changelogs/releases/3.2.9.rst
source//includes/changelogs/releases/3.4.6.rst
source//includes/changelogs/releases/3.4.7.rst
source//includes/example-filter-current-op.rst
source//includes/extracts-command-field.yaml
source//includes/fact-copydb-cmd-behavior-indexes.rst
source//includes/ref-toc-aggregation-pipeline-operator.yaml
source//includes/ref-toc-command-administration.yaml
source//includes/ref-toc-method-database.yaml
source//reference/command/aggregate.txt
source//reference/command/compact.txt
source//reference/command/currentOp.txt
source//reference/command/fsync.txt
source//reference/command/killOp.txt
source//reference/command/serverStatus.txt
source//reference/database-profiler.txt
source//reference/method/cursor.comment.txt
source//reference/method/db.aggregate.txt
source//reference/method/db.collection.aggregate.txt
source//reference/method/db.currentOp.txt
source//reference/method/db.killOp.txt
source//reference/operator/aggregation/currentOp.txt
source//reference/operator/meta/explain.txt
source//reference/privilege-actions.txt
source//release-notes/2.2.txt
source//release-notes/2.6-changelog.txt
source//release-notes/2.6.txt
source//release-notes/3.0-changelog.txt
source//release-notes/3.2.txt
source//release-notes/3.4.txt
source//release-notes/3.6.txt
source//tutorial/evaluate-operation-performance.txt
source//tutorial/iterate-a-cursor.txt
source//tutorial/manage-the-database-profiler.txt
source//tutorial/manage-users-and-roles.txt
source//tutorial/terminate-running-operations.txt

Impact to other docs outside of this product

MVP (work and date?)

MVP 1.0: Update currentOp and db.currentOp() pages to state 16MB BSON limit and point to $currentOp (Week of April 17?)

MVP 2.0: Audit the pages and identify where using $currentOp would be appropriate (April?)

MVP 3.0: Fix the audited pages (Early may?)

Resources (e.g. Scope Docs, Invision)

grep -r -l 'currentOp' source/


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