Skip to content

Commit 2f64d8d

Browse files
authored
DOCSP-37081 Set At for General Parameters (#6490) - Backport to v5.0 (#6827)
* DOCSP-37081 Set At for General Parameters (#6490) * DOCSP-37081 Standardizes phrasing on where to set parameter. * Adds callouts * Adds next set of parameters * Removes double spacing * Reverses and fixes space change. * Fixes missing periods * Reworks include text * Reworks include text * Minor edits * Fixes build issue * Fixes build issue * Fixes per Jocelyn * Fixes per Jocelyn * Fixes build issue
1 parent 031b95b commit 2f64d8d

File tree

4 files changed

+42
-20
lines changed

4 files changed

+42
-20
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
This parameter is only available at runtime. To set the
3+
parameter, use the :dbcommand:`setParameter` command.
4+
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
This parameter is available both at runtime and at startup:
3+
4+
- To set the parameter at runtime, use the
5+
:dbcommand:`setParameter` command
6+
7+
- To set the parameter at startup, use the
8+
:setting:`setParameter` setting
9+
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
This parameter is only available at startup. To set the
3+
parameter, use the :setting:`setParameter` setting.
4+

source/reference/parameters.txt

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -978,14 +978,12 @@ General Parameters
978978

979979
By default, the parameter is unset.
980980

981-
You can only set ``httpVerboseLogging`` during
982-
startup in the config file or on the command line. For example:
981+
.. include:: /includes/fact-runtime-startup-parameter
983982

984983
.. code-block:: bash
985984

986985
mongos --setParameter httpVerboseLogging=true
987986

988-
989987
.. parameter:: connPoolMaxConnsPerHost
990988

991989
*Default*: 200
@@ -1007,8 +1005,7 @@ General Parameters
10071005
connections and you're using authentication in the
10081006
context of a sharded cluster.
10091007

1010-
You can only set :parameter:`connPoolMaxConnsPerHost` during startup
1011-
in the config file or on the command line. For example:
1008+
.. include:: /includes/fact-startup-parameter
10121009

10131010
.. code-block:: bash
10141011

@@ -1026,8 +1023,7 @@ General Parameters
10261023

10271024
By default, the parameter is unset.
10281025

1029-
You can only set :parameter:`connPoolMaxInUseConnsPerHost` during
1030-
startup in the config file or on the command line. For example:
1026+
.. include:: /includes/fact-startup-parameter
10311027

10321028
.. code-block:: bash
10331029

@@ -1048,9 +1044,7 @@ General Parameters
10481044

10491045
By default, the parameter is unset.
10501046

1051-
You can only set :parameter:`globalConnPoolIdleTimeoutMinutes`
1052-
during startup in the config file or on the command line. For
1053-
example:
1047+
.. include:: /includes/fact-startup-parameter
10541048

10551049
.. code-block:: bash
10561050

@@ -1066,6 +1060,8 @@ General Parameters
10661060
MongoDB removes them; specifically, MongoDB removes cursors that have
10671061
been idle for the specified :parameter:`cursorTimeoutMillis`.
10681062

1063+
.. include:: /includes/fact-runtime-startup-parameter
1064+
10691065
For example, the following sets the :parameter:`cursorTimeoutMillis`
10701066
to ``300000`` milliseconds (5 minutes).
10711067

@@ -1132,6 +1128,8 @@ General Parameters
11321128
Too many index builds running simultaneously, waiting until the
11331129
number of active index builds is below the threshold.
11341130

1131+
.. include:: /includes/fact-runtime-startup-parameter
1132+
11351133
The following command sets a limit of 4 concurrent index builds:
11361134

11371135
.. code-block:: javascript
@@ -1173,6 +1171,8 @@ General Parameters
11731171
:parameter:`notablescan` because preventing collection scans can potentially
11741172
affect queries in all databases, including administrative queries.
11751173

1174+
.. include:: /includes/fact-runtime-startup-parameter
1175+
11761176
.. parameter:: ttlMonitorEnabled
11771177

11781178
|mongod-only|
@@ -1183,6 +1183,8 @@ General Parameters
11831183
instances have a background thread that is responsible for deleting
11841184
documents from collections with TTL indexes.
11851185

1186+
.. include:: /includes/fact-runtime-startup-parameter
1187+
11861188
To disable this worker thread for a :binary:`~bin.mongod`, set
11871189
:parameter:`ttlMonitorEnabled` to ``false``, as in the following
11881190
operations:
@@ -1239,9 +1241,7 @@ General Parameters
12391241
This parameter has no effect if the host operating system does not
12401242
support *or* is not configured to support TFO connections.
12411243

1242-
You can only set this parameter on startup, using either the
1243-
:setting:`setParameter` configuration file setting or the
1244-
:option:`--setParameter <mongod --setParameter>` command line option.
1244+
.. include:: /includes/fact-startup-parameter
12451245

12461246
See :ref:`4.4-rel-notes-tcp-fast-open` for more information on
12471247
MongoDB TFO support.
@@ -1274,9 +1274,7 @@ General Parameters
12741274
This parameter has no effect if the host operating system does not
12751275
support *or* is not configured to support TFO connections.
12761276

1277-
You can only set this parameter on startup, using either the
1278-
:setting:`setParameter` configuration file setting or the
1279-
:option:`--setParameter <mongod --setParameter>` command line option.
1277+
.. include:: /includes/fact-startup-parameter
12801278

12811279
See :ref:`4.4-rel-notes-tcp-fast-open` for more information on
12821280
MongoDB TFO support.
@@ -1321,6 +1319,8 @@ General Parameters
13211319
:ref:`4.4-rel-notes-tcp-fast-open` for more information on
13221320
MongoDB TFO support.
13231321

1322+
.. include:: /includes/fact-startup-parameter
1323+
13241324
.. seealso::
13251325

13261326
- `RFC7413 TCP Fast Open Section 5: Security Considerations
@@ -1336,6 +1336,8 @@ General Parameters
13361336
The MongoDB JavaScript engine uses SpiderMonkey, which implements
13371337
Just-in-Time (JIT) compilation for improved performance when running scripts.
13381338

1339+
.. include:: /includes/fact-runtime-startup-parameter
1340+
13391341
To enable the JIT, set :parameter:`disableJavaScriptJIT` to ``false``, as in
13401342
the following example:
13411343

@@ -1373,6 +1375,8 @@ General Parameters
13731375
:dbcommand:`createIndexes` command or its shell helper
13741376
:method:`db.collection.createIndexes()`.
13751377

1378+
.. include:: /includes/fact-runtime-startup-parameter
1379+
13761380
The memory consumed by an index build is separate from the
13771381
WiredTiger cache memory (see
13781382
:setting:`~storage.wiredTiger.engineConfig.cacheSizeGB`).
@@ -1389,9 +1393,7 @@ General Parameters
13891393
:method:`db.serverStatus()` method and :dbcommand:`serverStatus`
13901394
command return :serverstatus:`opWriteConcernCounters` information. [#perf]_
13911395

1392-
You can only set
1393-
:parameter:`reportOpWriteConcernCountersInServerStatus` during
1394-
startup in the config file or on the command line. For example:
1396+
.. include;: /includes/fact-starutp-parameter
13951397

13961398
.. code-block:: bash
13971399

@@ -1496,6 +1498,8 @@ General Parameters
14961498

14971499
A value of ``1`` enables ``tcmallocAggressiveMemoryDecommit``;
14981500
``0`` disables this parameter.
1501+
1502+
.. include:: /includes/fact-runtime-startup-parameter
14991503

15001504
If you enable this parameter, the system will require new memory allocations
15011505
for use. Consider enabling ``tcmallocAggressiveMemoryDecommit``
@@ -1528,6 +1532,8 @@ General Parameters
15281532
:parameter:`tcmallocReleaseRate`, unless you see a significant performance
15291533
degradation when using ``tcmallocAggressiveMemoryDecommit``.
15301534

1535+
.. include:: /includes/fact-runtime-startup-parameter
1536+
15311537
To modify the release rate during run time, you can use the
15321538
:dbcommand:`setParameter` command; for example:
15331539

@@ -1542,7 +1548,6 @@ General Parameters
15421548

15431549
mongod --setParameter "tcmallocReleaseRate=5.0"
15441550

1545-
15461551
Logging Parameters
15471552
~~~~~~~~~~~~~~~~~~
15481553

0 commit comments

Comments
 (0)