DOCSP-25509 $shardedDataDistribution (#2150) (#2210)

* DOCSP-25509 Stubs  aggregation stage reference

* DOCSP-25509 Fix build

* DOCSP-25509 Aggregation stage reference

* DOCSP-25509 Adds sidebar to Agg Pipeline page

* DOCSP-25509 Adds privilege

* DOCSP-25509 Adds privilege note to agg stage reference

* Adds release note

* Typo

* Fixes build issue

* Fixes per Joe

* Fixes per Joe

* DOCSP-26245 update mongocrypt version (#2139)

* updated mongocrypt version

* revert autoformatting

* Update pull_request_template.md

* DOCSP-25224 EOL Version Cleanup of mongosh Methods (#1901)

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 version cleanup in Method Reference

* DOCSP-25224 redirects

* DOCSP-25224 Updates redirects, removes copyDatabase and cloneDatabase as deprecated

* DOCSP-25224 Update for build

* DOCSP-25224 Update for build

* DOCSP-25224 Fixes build errors

* DOCSP-25224 Fixes per Jocelyn

* DOCSP-25224 Fixes per Jocelyn

* DOCSP-25224 Fixes per Jocelyn

* DOCSP-25224 Fixes per Jocelyn

* DOCSP-25224 Fixes per Jocelyn

* DOCS-15377 Fixes per Jocelyn

* DOCSP-25890 adds page-level refs to pages under tutorial/ that have doc directives pointing to them (#2063)

* DOCS-15521 sh.status.partitioned not valid (#2050)

* DOCS-15521 sh.status.partitioned not valid

* DOCS-15521 sh.status.partitioned not valid

* DOCS-15521 sh.status.partitioned not valid

* Review Feedback

* Review feedback

* DOCSP-25339 (#2026)

* add api docs for rewrapmanydatakeys methods

* move to shared include

* broken links

* update product names, add as constants

* (DOCSP-24983) QE Server Side Schema Behavior (#2018)

* wip

* Trigger Build

* proofread, spell-check, grammar-check

* js - suggestion

Co-authored-by: Jordan Smith <[email protected]>

Co-authored-by: Jordan Smith <[email protected]>

* (DOCSP-24820) libmongocrypt install fix (#2071)

* libmongocryptdev

* update qe libmongocrypt page

* proofread

* (DOCS-15399): 6.1 retryable writes errors (#2066)

* (DOCS-15399): 6.1 retryable writes errors

* wording

* wording and minimalism

* fix include name

* edits

* add clarity

* reorder phrases

* minimalism

* minimalism, formatting

* review edits

* updates per review

* wording

* final review edits

* minimalism

* DOCS-15473 Update exit codes reference (#2070)

* DOCSP-26150 Replace :doc: with :method: / :command: where possible (#2074)

* Date()

* internal review feedback

* internal review feedback

* internal review

* DOCS-15411 commit quorum v write concern (#2009)

* DOCS-15411 commitQuorum-and-writeConcerns

* DOCS-15411 commitQuorum-and-writeConcerns

* Staging fixes

* Staging fixes

* Review feedback

* Staging fixes

* Review Feedback

* Review Feedback

* Review feedback

* Review feedback

* Staging fixes

* Review feedback

* Review feedback

* Commit feedback

* DOCSP-25986 improve style of limitations page (#2047)

* DOCSP-25986 timeseries limitations restyling

* DOCSP-25986 timeseries limitations restyling

* Review Feedback

* Staging fixes

* Merge feedback

* (DOCSP-24856) (#2083)

* update qe tut

* update qe tuts

* update csfle tuts

* remove output from tuts that do not produce this output

* remove output from code block that does not produce output

* add deleted back in

* DOCSP-26183 replaces :doc: with improved admonitions (#2080)

* DOCSP-26204 update instances of :doc: pointing to core/index-text with :ref: (#2087)

* DOCSP-26204 update instances of :doc: pointing to core/index-text with :ref:

* internal review feedback

* DOCSP-15109 Resume Token Expansion (#2049)

* DOCSP-15109 Updates _id token

* DOCSP-15109 Updates token sources

* DOCSP-15109 Updates token sources

* DOCSP-15109 Refactors resume token text

* DOCSP-15109 Refactors resume token text

* DOCSP-15109 Fixes code block

* DOCSP-15109 Fixes code block

* DOCSP-15109 Fixes per Dave

* DOCSP-15109 Fixes per Dave

* DOCSP-15109 Fixes per Dave

* DOCSP-15109 Fixes per Dave

* DOCSP-15109 Fixes build error

* DOCSP-15109 Fixes build error

* DOCSP-15109 Fixes build error

* DOCSP-15109 Fixes per Valentin

* (DOCS-15063): Change to balancerCollectionStatus output (#2085)

* (DOCS-15063): Update balancerCollectionStatus command page

* more updates

* edits

* small edits

* tweak

* wording

* add details per tech review

* formatting - note

* DOCSP-26224 replace docs directives pointing to transactions (#2090)

* DOCSP-26224 replace docs directives pointing to transactions

* internal review feedback

* DOCSP-26193 replaces 2d and 2dsphere index doc admonitions (#2082)

* DOCSP-26193 replaces 2d and 2dsphere index doc admonitions

* internal review feedback

* DOCSP-26256 replaces views-related doc directives (#2092)

* DOCSP-26275 replaces write-related doc directives (#2094)

* DOCS-15437-reap-transactions (#2062)

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

* DOCS-15437-reap-transactions

Co-authored-by: jason-price-mongodb <[email protected]>

* DOCSP-26288 replaces auditing-related doc directives (#2102)

* DOCSP-26288 replaces auditing-realted doc directives

* internal review feedback

* internal review feedback

* (DOCSP-26124): Add new fill example (#2106)

* (DOCSP-26124): Add new fill example

* wording

* wording

* add clarification for values of zero

* add note title

* tweaks

* internal review edits

* fix output order

* fix toc heading

* wording

* (DOCSP-22423): Clarify startup instructions for redactClientLogData (#2101)

* Clarify startup instructions for redactClientLogData

* copy review feedback

* final fixes

* DOCPS-26298 updates BSON-related doc directives (#2105)

* DOCPS-26298 updates BSON-related doc directives

* internal review feedback

* internal review feedback

* update python qe apps from testing with solutions architect (#1887)

* DOCSP-26321 updates collation-related doc directives (#2112)

* (DOCSP-26328): Migrate changelog script from Python 2 to Python 3 (#2116)

* (DOCSP-26328): Migrate changelog script from Python 2 to Python 3 (#2113)

* update Makefile command and requirements filename (#2114)

* (DOCS-15722): 4.4.18 initial changelog and changelog script fixes (#2117)

* (DOCS-15722): 4.4.18 initial changelog

* fix bug with changelog output

* refactoring

* regenerate 4.4.18 changelog

* fix typo

* DOCSP-26358 replaces agg pipline doc directives (#2120)

* DOCS-15516 Time series range outside 1970-2038 behavior (#2119)

* Add a missing named reference definition in 5.1-compatibility (#2115)

* DOCSP-25224 version cleanup in Method Reference

Co-authored-by: jmd-mongo <[email protected]>
Co-authored-by: Dave Cuthbert <[email protected]>
Co-authored-by: Aleksander Binion <[email protected]>
Co-authored-by: Jordan Smith <[email protected]>
Co-authored-by: Jeff Allen <[email protected]>
Co-authored-by: Nick Villahermosa <[email protected]>
Co-authored-by: jason-price-mongodb <[email protected]>
Co-authored-by: jason-price-mongodb <[email protected]>
Co-authored-by: davidhou17 <[email protected]>
Co-authored-by: Heli Aldridge <[email protected]>

* (DOCS-13987): Introduce updated query planner diagram (#2107)

* Add new query planner diagram

* tech review feedback

* tech review feedback 2

* final changes

* DOCSP-26426 Replaces Compound-GeoJSON doc directives (#2156)

* (DOCS-15740): Finalize 6.0.3 changelog (#2158)

* (DOCS-15740): Finalize 6.0.3 changelog

* remove extra space

* (DOCS-15741): Finalize 4.4.18 changelog (#2160)

* (DOCSP-26069): Inaccuracy in document count for multi-document transactions (#2138)

* Inaccuracy in document count for multi-document transactions

* copy review feedback

* copy review feedback 2

* copy review feedback 3

* tech review feedback

* (DOCS-15746): Add changelog for 5.0.14 (#2163)

* (DOCSP-26626): Fix mongod/mongos formatting (#2170)

* DOCSP-26428 Replace Getting Started Guide-LDAP Proxy doc directives (#2165)

* DOCSP-26428 Replace Getting Started Guide-LDAP Proxy doc directives

* internal review feedback

* fix release dates in release notes (#2175)

* (DOCS-14355): fix regex pattern in validation example (#2166)

* (DOCS-14355): fix regex pattern in validation example

* change example

* typo

* fix formatting

* remove extra sentence

* formatting

* consistency

* update section titles per review

* (DOCS-10564): Sharding tutorial - distribute collections using zones (#2142)

* initial page setup

* WIP

* wip

* WIP

* finish balancer section

* fix widths

* add security prereq

* (DOCS-16064): Sharding tutorial - distribute collections using zones

* edits

* fix learn more

* add prereq

* fix code block highlighting

* typo

* wording

* WIP review edits

* finish review edits

* edits

* edits

* typo fixes

* updates per Asya's feedback

* wording

* remove extra heading

* review edits

* wording

* reorder

* add clarification

* clarify balancing behavior

* ordering

* wording

* alphabetize

* edits

* (DOCS-11076): Document inaccuracies when inserting documents (#2149)

* add information about insert inaccuracies

* copy review feedback

* tech review feedback

* (DOCS-7159): Add tcmalloc verbosity section to serverStatus() (#2167)

* Add tcmalloc section to serverStatus()

* copy review feedback

* Update source/reference/command/serverStatus.txt

Co-authored-by: Kyle Suarez <[email protected]>

Co-authored-by: Kyle Suarez <[email protected]>

* DOCS-11817: clarify single-version downgrade (#2188)

* clarify single-version downgrade

* fix include replacements

* update 6.0 downgrade pages

* update 5.0 downgrade instructions

* fix build warnings

* update 4.4 downgrade pages

* update language and use replacements

* language

* use correct include for standalone pages

* grammar

* remove extra include file

* updates per review

* formatting

* DOCSP-26654: Bolding edits (#2192)

* Fixes per Jordi

Co-authored-by: Jordan Smith <[email protected]>
Co-authored-by: Ashley Brown <[email protected]>
Co-authored-by: jmd-mongo <[email protected]>
Co-authored-by: Dave Cuthbert <[email protected]>
Co-authored-by: Aleksander Binion <[email protected]>
Co-authored-by: Jeff Allen <[email protected]>
Co-authored-by: Nick Villahermosa <[email protected]>
Co-authored-by: jason-price-mongodb <[email protected]>
Co-authored-by: jason-price-mongodb <[email protected]>
Co-authored-by: davidhou17 <[email protected]>
Co-authored-by: Heli Aldridge <[email protected]>
Co-authored-by: Kyle Suarez <[email protected]>
Co-authored-by: Sarah Olson <[email protected]>

Co-authored-by: Jordan Smith <[email protected]>
Co-authored-by: Ashley Brown <[email protected]>
Co-authored-by: jmd-mongo <[email protected]>
Co-authored-by: Dave Cuthbert <[email protected]>
Co-authored-by: Aleksander Binion <[email protected]>
Co-authored-by: Jeff Allen <[email protected]>
Co-authored-by: Nick Villahermosa <[email protected]>
Co-authored-by: jason-price-mongodb <[email protected]>
Co-authored-by: jason-price-mongodb <[email protected]>
Co-authored-by: davidhou17 <[email protected]>
Co-authored-by: Heli Aldridge <[email protected]>
Co-authored-by: Kyle Suarez <[email protected]>
Co-authored-by: Sarah Olson <[email protected]>

Author: 14 people

source/reference/operator/aggregation-pipeline.txt

@@ -6,6 +6,12 @@ Aggregation Pipeline Stages
 
 .. default-domain:: mongodb
 
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
 In the :method:`db.collection.aggregate` method and
 :method:`db.aggregate` method, :doc:`pipeline
 </core/aggregation-pipeline>` stages appear in an array. Documents pass
@@ -306,6 +312,12 @@ Alphabetical Listing of Stages
 
        .. versionadded:: 5.0
 
+   * - :pipeline:`$shardedDataDistribution`
+
+     - Provides data and size distribution information on sharded collections.
+
+       .. versionadded:: 6.0.3
+
 
    * - :pipeline:`$skip`
 
@@ -386,6 +398,7 @@ Alphabetical Listing of Stages
    /reference/operator/aggregation/searchMeta
    /reference/operator/aggregation/set
    /reference/operator/aggregation/setWindowFields
+   /reference/operator/aggregation/shardedDataDistribution
    /reference/operator/aggregation/skip
    /reference/operator/aggregation/sort
    /reference/operator/aggregation/sortByCount

source/reference/operator/aggregation/shardedDataDistribution.txt

@@ -0,0 +1,117 @@
+======================================
+$shardedDataDistribution (aggregation)
+======================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+Definition
+----------
+
+.. pipeline:: $shardedDataDistribution
+
+   .. versionadded:: 6.0.3
+
+   Returns information on the distribution of data in sharded collections. 
+
+   .. note:: 
+
+      This aggregation stage is only available on :program:`mongos`.
+
+   This aggregation stage must be run on the ``admin`` database.  The user must
+   have the :authaction:`shardedDataDistribution` privilege action.
+
+Syntax
+------
+
+The ``shardedDataDistribution`` stage has the following syntax: 
+
+.. code-block:: javascript
+
+   db.aggregate( [
+      { $shardedDataDistribution: { } }
+   ] )
+
+
+
+Output Fields
+-------------
+
+The ``$shardedDataDistribution`` stage outputs an array of documents
+for each sharded collection in the database.  These documents contain the
+following fields:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 30 15 55
+
+   * - Field Name
+     - Data Type
+     - Description
+
+   * - ``ns``
+     - string
+     - The namespace of the sharded collection.
+
+   * - ``shards``
+     - array
+     - Lists the shards in the collection with data distribution information 
+       on each shard.
+
+   * - ``shards.numOrphanedDocs``
+     - integer
+     - Number of orphaned documents in the shard.
+
+   * - ``shards.numOwnedDocuments``
+     - integer
+     - Number of documents owned by the shard.
+
+   * - ``shards.orphanedSizeBytes``
+     - integer
+     - Amount of storage in bytes used by orphaned documents in the shard.
+
+   * - ``shards.ownedSizeBytes``
+     - integer
+     - Amount of storage in bytes used by owned documents in the shard.
+
+
+Examples
+--------
+
+.. code-block:: javascript
+
+   db.aggregate( [
+      { $shardedDataDistribution: { } }
+   ] )
+
+Example output:
+
+.. code-block:: json
+
+   [
+     {
+       "ns": "test.names",
+       "shards": [
+         {
+           "shardName": "shard-1",
+           "numOrphanedDocs": 0,
+           "numOwnedDocuments": 6,
+           "ownedSizeBytes": 366,
+           "orphanedSizeBytes": 0
+         },
+         {
+           "shardName": "shard-2",
+           "numOrphanedDocs": 0,
+           "numOwnedDocuments": 6,
+           "ownedSizeBytes": 366,
+           "orphanedSizeBytes": 0
+         }
+       ]
+     }
+   ]
+

source/reference/privilege-actions.txt

@@ -552,6 +552,13 @@ Sharding Actions
    User can perform the :dbcommand:`removeShard` command. Apply this
    action to the ``cluster`` resource.
 
+.. authaction:: shardedDataDistribution
+
+   User can perform the :pipeline:`$shardedDataDistribution` aggregation 
+   pipeline stage.
+
+   .. versionadded:: 6.0.3
+
 .. authaction:: shardingState
 
    User can perform the :dbcommand:`shardingState` command. Apply this

source/release-notes/6.0.txt

@@ -137,6 +137,13 @@ MongoDB 6.0 introduces the following aggregation stages:
    * - :pipeline:`$fill`
      - .. include:: /includes/fact-fill-description.rst
 
+   * - :pipeline:`$shardedDataDistribution`
+     - .. versionadded:: 6.0.3
+
+          Provides size and data distribution information on sharded 
+          collections. 
+       
+
 .. _6.0-rel-notes-new-agg-operators:
 
 New Aggregation Operators