Skip to content

Commit ebdeb02

Browse files
authored
DOCSP-37081 Set At for General Parameters (#6490) (#6826)
* 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
1 parent 3b78491 commit ebdeb02

File tree

4 files changed

+52
-23
lines changed

4 files changed

+52
-23
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: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1090,6 +1090,8 @@ General Parameters
10901090

10911091
.. include:: /includes/fact-allowDiskUseByDefault.rst
10921092

1093+
.. include:: /includes/fact-runtime-startup-parameter
1094+
10931095
.. code-block:: bash
10941096

10951097
mongod --setParameter allowDiskUseByDefault=false
@@ -1118,14 +1120,12 @@ General Parameters
11181120

11191121
By default, the parameter is unset.
11201122

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

11241125
.. code-block:: bash
11251126

11261127
mongos --setParameter httpVerboseLogging=true
11271128

1128-
11291129
.. parameter:: connPoolMaxConnsPerHost
11301130

11311131
*Default*: 200
@@ -1147,8 +1147,7 @@ General Parameters
11471147
connections and you're using authentication in the
11481148
context of a sharded cluster.
11491149

1150-
You can only set :parameter:`connPoolMaxConnsPerHost` during startup
1151-
in the config file or on the command line. For example:
1150+
.. include:: /includes/fact-startup-parameter
11521151

11531152
.. code-block:: bash
11541153

@@ -1164,8 +1163,7 @@ General Parameters
11641163

11651164
By default, the parameter is unset.
11661165

1167-
You can only set :parameter:`connPoolMaxInUseConnsPerHost` during
1168-
startup in the config file or on the command line. For example:
1166+
.. include:: /includes/fact-startup-parameter
11691167

11701168
.. code-block:: bash
11711169

@@ -1184,9 +1182,7 @@ General Parameters
11841182

11851183
By default, the parameter is unset.
11861184

1187-
You can only set :parameter:`globalConnPoolIdleTimeoutMinutes`
1188-
during startup in the config file or on the command line. For
1189-
example:
1185+
.. include:: /includes/fact-startup-parameter
11901186

11911187
.. code-block:: bash
11921188

@@ -1202,6 +1198,8 @@ General Parameters
12021198
MongoDB removes them; specifically, MongoDB removes cursors that have
12031199
been idle for the specified :parameter:`cursorTimeoutMillis`.
12041200

1201+
.. include:: /includes/fact-runtime-startup-parameter
1202+
12051203
For example, the following sets the :parameter:`cursorTimeoutMillis`
12061204
to ``300000`` milliseconds (5 minutes).
12071205

@@ -1268,6 +1266,8 @@ General Parameters
12681266
Too many index builds running simultaneously, waiting until the
12691267
number of active index builds is below the threshold.
12701268

1269+
.. include:: /includes/fact-runtime-startup-parameter
1270+
12711271
The following command sets a limit of 4 concurrent index builds:
12721272

12731273
.. code-block:: javascript
@@ -1309,6 +1309,8 @@ General Parameters
13091309
:parameter:`notablescan` because preventing collection scans can potentially
13101310
affect queries in all databases, including administrative queries.
13111311

1312+
.. include:: /includes/fact-runtime-startup-parameter
1313+
13121314
.. parameter:: ttlMonitorEnabled
13131315

13141316
|mongod-only|
@@ -1319,6 +1321,8 @@ General Parameters
13191321
instances have a background thread that is responsible for deleting
13201322
documents from collections with TTL indexes.
13211323

1324+
.. include:: /includes/fact-runtime-startup-parameter
1325+
13221326
To disable this worker thread for a :binary:`~bin.mongod`, set
13231327
:parameter:`ttlMonitorEnabled` to ``false``, as in the following
13241328
operations:
@@ -1375,9 +1379,7 @@ General Parameters
13751379
This parameter has no effect if the host operating system does not
13761380
support *or* is not configured to support TFO connections.
13771381

1378-
You can only set this parameter on startup, using either the
1379-
:setting:`setParameter` configuration file setting or the
1380-
:option:`--setParameter <mongod --setParameter>` command line option.
1382+
.. include:: /includes/fact-startup-parameter
13811383

13821384
See :ref:`4.4-rel-notes-tcp-fast-open` for more information on
13831385
MongoDB TFO support.
@@ -1410,9 +1412,7 @@ General Parameters
14101412
This parameter has no effect if the host operating system does not
14111413
support *or* is not configured to support TFO connections.
14121414

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

14171417
See :ref:`4.4-rel-notes-tcp-fast-open` for more information on
14181418
MongoDB TFO support.
@@ -1457,6 +1457,8 @@ General Parameters
14571457
:ref:`4.4-rel-notes-tcp-fast-open` for more information on
14581458
MongoDB TFO support.
14591459

1460+
.. include:: /includes/fact-startup-parameter
1461+
14601462
.. seealso::
14611463

14621464
- `RFC7413 TCP Fast Open Section 5: Security Considerations
@@ -1472,6 +1474,8 @@ General Parameters
14721474
The MongoDB JavaScript engine uses SpiderMonkey, which implements
14731475
Just-in-Time (JIT) compilation for improved performance when running scripts.
14741476

1477+
.. include:: /includes/fact-runtime-startup-parameter
1478+
14751479
To enable the JIT, set :parameter:`disableJavaScriptJIT` to ``false``, as in
14761480
the following example:
14771481

@@ -1504,6 +1508,8 @@ General Parameters
15041508
:parameter:`indexMaxNumGeneratedKeysPerDocument` parameter specifies,
15051509
the operation will fail.
15061510

1511+
.. include:: /includes/fact-startup-parameter
1512+
15071513
.. parameter:: maxIndexBuildMemoryUsageMegabytes
15081514

15091515
*Default*:
@@ -1519,6 +1525,8 @@ General Parameters
15191525
:dbcommand:`createIndexes` command or its shell helper
15201526
:method:`db.collection.createIndexes()`.
15211527

1528+
.. include:: /includes/fact-runtime-startup-parameter
1529+
15221530
The memory consumed by an index build is separate from the
15231531
WiredTiger cache memory (see
15241532
:setting:`~storage.wiredTiger.engineConfig.cacheSizeGB`).
@@ -1535,9 +1543,7 @@ General Parameters
15351543
:method:`db.serverStatus()` method and :dbcommand:`serverStatus`
15361544
command return :serverstatus:`opWriteConcernCounters` information. [#perf]_
15371545

1538-
You can only set
1539-
:parameter:`reportOpWriteConcernCountersInServerStatus` during
1540-
startup in the config file or on the command line. For example:
1546+
.. include;: /includes/fact-starutp-parameter
15411547

15421548
.. code-block:: bash
15431549

@@ -1642,6 +1648,8 @@ General Parameters
16421648

16431649
A value of ``1`` enables ``tcmallocAggressiveMemoryDecommit``;
16441650
``0`` disables this parameter.
1651+
1652+
.. include:: /includes/fact-runtime-startup-parameter
16451653

16461654
If you enable this parameter, the system will require new memory allocations
16471655
for use. Consider enabling ``tcmallocAggressiveMemoryDecommit``
@@ -1674,6 +1682,8 @@ General Parameters
16741682
:parameter:`tcmallocReleaseRate`, unless you see a significant performance
16751683
degradation when using ``tcmallocAggressiveMemoryDecommit``.
16761684

1685+
.. include:: /includes/fact-runtime-startup-parameter
1686+
16771687
To modify the release rate during run time, you can use the
16781688
:dbcommand:`setParameter` command; for example:
16791689

@@ -1704,6 +1714,8 @@ General Parameters
17041714
``fassertOnLockTimeoutForStepUpDown`` defaults to 15 seconds. To disable
17051715
nodes from fasserting, set ``fassertOnLockTimeoutForStepUpDown=0``.
17061716

1717+
.. include:: /includes/fact-runtime-startup-parameter
1718+
17071719
The following example disables nodes from fasserting:
17081720

17091721
.. code-block:: bash
@@ -2593,19 +2605,19 @@ If you attempt to update ``disableSplitHorizonIPCheck`` at runtime,
25932605

25942606
*Default*: ``logical``
25952607

2596-
Available only in MongoDB Enterprise.
2608+
Available only in MongoDB Enterprise.
25972609

2598-
Method used for :ref:`initial sync <replica-set-initial-sync>`.
2610+
Method used for :ref:`initial sync <replica-set-initial-sync>`.
25992611

26002612
Set to ``logical`` to use :ref:`logical initial sync
26012613
<replica-set-initial-sync-logical>`. Set to ``fileCopyBased`` to
26022614
use :ref:`file copy based initial sync
2603-
<replica-set-initial-sync-file-copy-based>`.
2615+
<replica-set-initial-sync-file-copy-based>`.
26042616

26052617
This parameter only affects the sync method for the member on which
26062618
it is specified. Setting this parameter on a single replica set
26072619
member does not affect the sync method of any other replica set
2608-
members.
2620+
members.
26092621

26102622
You can only set this parameter on startup, using either the
26112623
:setting:`setParameter` configuration file setting or the

0 commit comments

Comments
 (0)