Skip to content

Commit 3c80a2b

Browse files
authored
DOCS-17090 analyzeShardKey defaults (#13649)
1 parent feda36e commit 3c80a2b

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

content/manual/upcoming/source/includes/shard-key-characteristics-metrics.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ documents sampled from the collection. The calculation requires the
99
shard key to have a :ref:`supporting index <supporting-indexes-ref>`.
1010
If there is no supporting index, no metrics are returned.
1111

12-
You can configure sampling with the ``sampleRate`` and ``sampleSize``
13-
fields. Both are optional and only one can be specified. If neither is
14-
specified, the sample size is set to ``10`` . Configure this value
15-
by setting
16-
``analyzeShardKeyCharacteristicsDefaultSampleSize``.
12+
You can configure sampling with the ``sampleRate`` and
13+
``sampleSize`` fields. Both are optional, but only one can be
14+
specified. When both ``sampleRate`` and ``sampleSize`` are
15+
unspecified, MongoDB uses the value of the
16+
:parameter:`analyzeShardKeyCharacteristicsDefaultSampleSize`
17+
parameter, which has a default value of 10 million.
1718

1819
To calculate metrics based on all documents in the collection,
1920
set the ``sampleRate`` to ``1``.

0 commit comments

Comments
 (0)