Skip to content

Commit 75743b3

Browse files
committed
DOCSP-3674: mongo shell does not enable networkMessageCompressors by default
1 parent b1545f4 commit 75743b3

File tree

6 files changed

+43
-67
lines changed

6 files changed

+43
-67
lines changed

source/includes/fact-networkMessageCompressors.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@
44
compression. Otherwise, messages between the parties are
55
uncompressed.
66

7-
You can specify the following compressors:
8-
9-
- :term:`snappy` (Default)
10-
11-
- :term:`zlib`
12-
137
If you specify multiple compressors, then the order in which you list
148
the compressors matter as well as the communication initiator. For
159
example, if a :binary:`~bin.mongo` shell specifies the following network

source/includes/options-conf.yaml

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -814,29 +814,14 @@ inherit:
814814
---
815815
program: conf
816816
name: net.compression.compressors
817-
type: <string>
818817
directive: setting
819-
description: |
820-
821-
.. versionadded:: 3.4
822-
823-
.. versionchanged:: 3.6
824-
825-
- Add support for :term:`zlib` compressor.
826-
827-
- Enabled by default. To disable, set to ``disabled``.
828-
829-
Enables network compression for communication between this
830-
:binary:`~bin.mongod` or :binary:`~bin.mongos` instance and:
831-
832-
- other members in the deployment, if a member of a replica set or a
833-
sharded cluster
834-
835-
- a :binary:`~bin.mongo` shell
836-
837-
- drivers that support the ``OP_COMPRESSED`` message format.
818+
inherit:
819+
name: networkMessageCompressors
820+
program: mongod
821+
file: options-mongod.yaml
822+
replacement:
823+
program: ":binary:`~bin.mongod` or :binary:`~bin.mongos`"
838824

839-
.. include:: /includes/fact-networkMessageCompressors.rst
840825
---
841826
program: conf
842827
name: net.serviceExecutor

source/includes/options-mongo.yaml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -441,18 +441,19 @@ description: |
441441
442442
.. versionadded:: 3.4
443443
444-
.. versionchanged:: 3.6
445-
446-
- Add support for :term:`zlib` compressor.
447-
- Enabled by default. To disable, set to ``disabled``.
448-
449444
Enables network compression for communication between this
450445
{{program}} shell and:
451446
452447
- a :binary:`~bin.mongod` instance
453448
454449
- a :binary:`~bin.mongos` instance.
455450
451+
You can specify the following compressors:
452+
453+
- :term:`snappy`
454+
455+
- :term:`zlib` (Available in MongoDB 3.6 or greater)
456+
456457
.. include:: /includes/fact-networkMessageCompressors.rst
457458
458459
---

source/includes/options-mongod.yaml

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2917,33 +2917,38 @@ optional: true
29172917
program: mongod
29182918
name: networkMessageCompressors
29192919
args: <string>
2920+
default: snappy,zlib
29202921
directive: option
29212922
description: |
29222923
29232924
.. versionadded:: 3.4
29242925
2925-
.. versionchanged:: 3.6
2926+
Specifies the default compressor(s) to use for
2927+
communication between this {{program}} instance and:
29262928
2927-
- Add support for :term:`zlib` compressor.
2928-
- Enabled by default. To disable, set to ``disabled``.
2929+
- {{deployment}}
29292930
2930-
Enables network compression for communication between this
2931-
{{program}} instance and:
2931+
- a :binary:`~bin.mongo` shell
29322932
2933-
- other members of the replica set, if the instance is part of a
2934-
replica set
2933+
- drivers that support the ``OP_COMPRESSED`` message format.
29352934
2936-
- other members of the sharded cluster, if the instance is part of a
2937-
sharded cluster
2935+
MongoDB supports the following compressors:
29382936
2939-
- a :binary:`~bin.mongo` shell,
2937+
- :term:`snappy`
29402938
2941-
- drivers that support the ``OP_COMPRESSED`` message format.
2939+
- :term:`zlib` (Available in MongoDB 3.6 or greater)
29422940
2943-
.. include:: /includes/fact-networkMessageCompressors.rst
2941+
**In versions 3.6 and 4.0**, :binary:`~bin.mongod` and
2942+
:binary:`~bin.mongos` enable network compression by default with
2943+
``snappy`` as the compressor.
2944+
2945+
To disable network compression, set the value to ``disabled``.
29442946
2947+
.. include:: /includes/fact-networkMessageCompressors.rst
29452948
29462949
optional: true
2950+
replacement:
2951+
deployment: other members of the deployment if the instance is part of a replica set or a sharded cluster
29472952
---
29482953
program: mongod
29492954
name: serviceExecutor

source/includes/options-mongos.yaml

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -497,24 +497,14 @@ program: mongos
497497
name: networkMessageCompressors
498498
args: <string>
499499
directive: option
500-
description: |
501-
502-
.. versionadded:: 3.4
503-
504-
.. versionchanged:: 3.6
505-
506-
Add support for :term:`zlib` compressor.
507-
508-
Enables network compression for communication between this
509-
{{program}} instance and:
510-
511-
- other members of the sharded cluster
512-
513-
- a :binary:`~bin.mongo` shell.
514-
515-
.. include:: /includes/fact-networkMessageCompressors.rst
516-
500+
inherit:
501+
name: networkMessageCompressors
502+
program: mongod
503+
file: options-mongod.yaml
517504
optional: true
505+
replacement:
506+
deployment: other members of the sharded cluster
507+
518508
---
519509
program: mongos
520510
name: serviceExecutor

source/release-notes/3.6.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -816,18 +816,19 @@ Wire Protocol and Compression
816816
This opcode's message format is extensible and designed to subsume
817817
the functionality of other opcodes.
818818

819-
- Added support for the ``zlib`` compressor for
819+
- MongoDB 3.6 adds support for the ``zlib`` compressor for
820820
``--networkMessageCompressors`` option (or
821821
:setting:`net.compression.compressors` setting if using the
822822
configuration file). ``--networkMessageCompressors`` option (or
823823
:setting:`net.compression.compressors` setting) enables network
824824
compression for communication among :binary:`~bin.mongod`,
825-
:binary:`~bin.mongos`, :binary:`~bin.mongo` shell, and drivers that support
826-
the ``OP_COMPRESSED`` message format.
825+
:binary:`~bin.mongos`, :binary:`~bin.mongo` shell, and drivers that
826+
support the ``OP_COMPRESSED`` message format.
827827

828-
- Enables ``snappy`` network compression for communication, by default,
829-
among :binary:`~bin.mongod`, :binary:`~bin.mongos`, and :binary:`~bin.mongo`
830-
shell.
828+
- :binary:`~bin.mongod` and :binary:`~bin.mongos` enable network
829+
compression by default with ``snappy`` as the compressor. For more
830+
information on network compression, see
831+
:setting:`net.compression.compressors`.
831832

832833
Read Concern
833834
~~~~~~~~~~~~

0 commit comments

Comments
 (0)