Skip to content

Commit 53ddd46

Browse files
authored
(DOCSP-13514) Add advanced storage and log settings (#498)
* (DOCSP-13514) Add advanced storage and log settings
1 parent 9cc7a60 commit 53ddd46

File tree

1 file changed

+193
-2
lines changed

1 file changed

+193
-2
lines changed

source/reference/mms-cluster-settings-file.txt

Lines changed: 193 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@ replica set member:
180180
- boolean
181181
- Flag that indicates whether the |mongos| or |mongod| instance
182182
binds to all IPv4 addresses (for example, ``0.0.0.0``). If
183-
``ipv6`` is set to ``true``, ``bindIpAll` also binds to IPv6
184-
addresses (for exmaple, ``::``). {+mcli+} accepts ] the
183+
``ipv6`` is set to ``true``, ``bindIpAll`` also binds to IPv6
184+
addresses (for example, ``::`` ). {+mcli+} accepts the
185185
following values: ``true`` or ``false``.
186186

187187
This setting corresponds to the :manual:`net.bindIpAll
@@ -217,12 +217,44 @@ replica set member:
217217
replica set configuration option.
218218
- no
219219

220+
* - ``directoryPerDB``
221+
- boolean
222+
- Flag that indicates whether MongoDB should use a separate directory to store data
223+
for each database. The directories are under the
224+
:setting:`storage.dbPath` directory, and each subdirectory name
225+
corresponds to the database name.
226+
227+
By default, ``directoryPerDB`` is ``false``.
228+
229+
This setting corresponds to the :setting:`storage.directoryPerDB`
230+
|mongod| replica set configuration option.
231+
- no
232+
220233
* - ``hostname``
221234
- string
222235
- Name of the host to add to the replica set. This is the
223236
host on which |mms| deploys the |mongod| process.
224237
- yes
225238

239+
* - ``inMemory.engineConfig.inMemorySizeGB``
240+
- float
241+
- Maximum amount of memory to allocate for
242+
:manual:`in-memory storage engine </core/inmemory>` data,
243+
including indexes, oplog if the :binary:`~bin.mongod` is part of
244+
replica set, replica set or sharded cluster metadata, etc.
245+
246+
The value can range from ``256`` MB to ``10`` TB. By default,
247+
the in-memory storage engine uses 50% of physical RAM minus 1 GB.
248+
249+
.. note:: Enterprise Feature
250+
251+
Available for MongoDB Enterprise only.
252+
253+
This setting corresponds to the
254+
:setting:`storage.inMemory.engineConfig.inMemorySizeGB`
255+
|mongod| replica set configuration option.
256+
- no
257+
226258
* - ``ipv6``
227259
- boolean
228260
- Flag that indicates whether the deployment supports |ipv6|.
@@ -502,6 +534,165 @@ replica set member:
502534
</reference/replica-configuration/#rsconf.members[n].votes>`.
503535
- yes
504536

537+
* - ``wiredTiger.engineConfig.cacheSizeGB``
538+
- float
539+
- Maximum size of the internal cache that WiredTiger
540+
uses for all data.
541+
542+
The value can range from ``0.25`` GB to ``10000`` GB. By
543+
default, the WiredTiger internal cache size is the larger of
544+
either:
545+
546+
- 50% of (RAM - 1 GB), or
547+
- 256 MB.
548+
549+
Avoid increasing the WiredTiger internal cache size above its
550+
default value.
551+
552+
This setting corresponds to the
553+
:setting:`storage.wiredTiger.engineConfig.journalCompressor`
554+
|mongod| replica set configuration option.
555+
- no
556+
557+
* - ``wiredTiger.engineConfig.journalCompressor``
558+
- string
559+
- Type of compression to use to compress WiredTiger
560+
journal data.
561+
562+
Available compressors are:
563+
564+
- ``none``
565+
566+
- :term:`snappy`
567+
568+
- :term:`zlib`
569+
570+
- :term:`zstd` (Available for clusters running MongoDB 4.2 and
571+
later)
572+
573+
By default, WiredTiger uses :term:`snappy`.
574+
575+
This setting corresponds to the
576+
:setting:`storage.wiredTiger.engineConfig.journalCompressor`
577+
|mongod| replica set configuration option.
578+
- no
579+
580+
* - ``wiredTiger.engineConfig.directoryForIndexes``
581+
- boolean
582+
- Flag that indicates whether |mongod| stores indexes and collections in
583+
separate subdirectories under the data
584+
(i.e. :setting:`storage.dbPath`) directory. Specifically,
585+
|mongod| stores the indexes in a subdirectory named ``index``
586+
and the collection data in a subdirectory named ``collection``.
587+
588+
By using a symbolic link, you can specify a different location
589+
for the indexes. Specifically, when the |mongod| instance is
590+
**not** running, move the ``index`` subdirectory to a new
591+
destination and create a symbolic link named ``index`` under the
592+
data directory to the new destination.
593+
594+
By default ``wiredTiger.engineConfig.directoryForIndexes`` is
595+
``false``.
596+
597+
This setting corresponds to the
598+
:setting:`storage.wiredTiger.engineConfig.directoryForIndexes`
599+
|mongod| replica set configuration option.
600+
- no
601+
602+
* - ``wiredTiger.engineConfig.maxCacheOverflowFileSizeGB``
603+
- float
604+
- .. note:: Limited version support
605+
606+
This setting is only supported for clusters running MongoDB
607+
versions:
608+
609+
- 4.0.12 through 4.0.x, and
610+
611+
- 4.2.1 through 4.2.x.
612+
613+
Maximum size (in GB) for the "lookaside (or cache
614+
overflow) table" file named :file:`WiredTigerLAS.wt`. The file no
615+
longer exists starting in MongoDB version 4.4.
616+
617+
The setting can accept the following values:
618+
619+
.. list-table::
620+
:header-rows: 1
621+
:widths: 20 80
622+
623+
* - Value
624+
- Description
625+
626+
* - ``0``
627+
628+
- The default value. If set to ``0``, the file size is
629+
unbounded.
630+
631+
* - number >= 0.1
632+
633+
- The maximum size (in GB). If the :file:`WiredTigerLAS.wt`
634+
file exceeds this size, |mongod| exits with a
635+
fatal assertion. You can clear the
636+
:file:`WiredTigerLAS.wt` file and restart |mongod|.
637+
638+
To change the maximum size during runtime, use the
639+
:parameter:`wiredTigerMaxCacheOverflowSizeGB` parameter.
640+
641+
This setting corresponds to the
642+
:setting:`storage.wiredTiger.engineConfig.maxCacheOverflowFileSizeGB`
643+
|mongod| replica set configuration option.
644+
- no
645+
646+
* - ``wiredTiger.collectionConfig.blockCompressor``
647+
- string
648+
- Default compression for collection data. You can
649+
override this on a per-collection basis when creating
650+
collections.
651+
652+
Available compressors are:
653+
654+
- ``none``
655+
656+
- :term:`snappy`
657+
658+
- :term:`zlib`
659+
660+
- :term:`zstd` (Available for clusters running MongoDB 4.2 and
661+
later)
662+
663+
By default the compressor is :term:`snappy`.
664+
665+
This setting affects all newly created collections. If you change
666+
the value of this setting on an existing MongoDB deployment, all
667+
new collections will use the specified compressor. Existing
668+
collections continue to use the compressor that was specified when they
669+
were created, or the default compressor at that time.
670+
671+
This setting corresponds to the
672+
:setting:`storage.wiredTiger.collectionConfig.blockCompressor`
673+
|mongod| replica set configuration option.
674+
- no
675+
676+
* - ``wiredTiger.indexConfig.prefixCompression``
677+
- boolean
678+
- Flag that indicates whether to enable or disable :term:`prefix compression` for index data.
679+
680+
If ``true``, :term:`prefix compression` is enabled for
681+
index data. If ``false``, prefix compression is disabled.
682+
683+
By default ``wiredTiger.indexConfig.prefixCompression`` is
684+
``true``.
685+
686+
This setting affects all indexes created. If you change
687+
the value of this setting on an existing MongoDB deployment, all
688+
new indexes will use prefix compression. Existing indexes
689+
are not affected.
690+
691+
This setting corresponds to the
692+
:setting:`storage.wiredTiger.indexConfig.prefixCompression`
693+
|mongod| replica set configuration option.
694+
- no
695+
505696
.. _shard-settings:
506697

507698
Shard Settings

0 commit comments

Comments
 (0)