Skip to content

Commit 0c685e3

Browse files
authored
DOCSP-37078 SetAt for Diagnostics, Logging, and Health Parameters (#7… (#7781)
* DOCSP-37078 SetAt for Diagnostics, Logging, and Health Parameters (#7656) * DOCSP-37078 SetAt for Diagnostic, Logging, and Health Parameters * Adds setAt text * Adds setAt text * Adds setAt text * Adds setAt text * Adds setAt text * Adds setAt text * fixes build issue * Fixes build issue
1 parent 5c115c6 commit 0c685e3

File tree

2 files changed

+31
-3
lines changed

2 files changed

+31
-3
lines changed

source/reference/parameters.txt

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1674,6 +1674,8 @@ Logging Parameters
16741674

16751675
The default :parameter:`logLevel` is ``0`` (Informational).
16761676

1677+
.. include:: /includes/fact-runtime-startup-parameter
1678+
16771679
The following example sets the :parameter:`logLevel` to ``2``:
16781680

16791681
.. code-block:: javascript
@@ -1762,6 +1764,8 @@ Logging Parameters
17621764
:setting:`storage.recovery
17631765
<systemLog.component.storage.recovery.verbosity>`.
17641766

1767+
.. include:: /includes/fact-runtime-startup-parameter
1768+
17651769
For example, the following sets the :setting:`default verbosity
17661770
level <systemLog.verbosity>` to ``1``, the :setting:`query
17671771
<systemLog.component.query.verbosity>` to ``2``, the
@@ -1830,6 +1834,8 @@ Logging Parameters
18301834
``0``, may adversely affect system performance and negatively
18311835
impact database operations.
18321836

1837+
.. include:: /includes/fact-runtime-startup-parameter
1838+
18331839
The following example sets the maximum log line size to ``20``
18341840
kilobytes:
18351841

@@ -1853,6 +1859,8 @@ Logging Parameters
18531859

18541860
- replication synchronization activities.
18551861

1862+
.. include:: /includes/fact-runtime-startup-parameter
1863+
18561864
Consider the following example which sets the
18571865
``quiet`` parameter to ``1``:
18581866

@@ -1924,6 +1932,8 @@ Logging Parameters
19241932
for every database and socket C++ exception, for use with debugging.
19251933
If ``true``, :binary:`~bin.mongod` will log full stack traces.
19261934

1935+
.. include:: /includes/fact-runtime-parameter
1936+
19271937
Consider the following example which sets the
19281938
``traceExceptions`` to ``true``:
19291939

@@ -1951,14 +1961,15 @@ Logging Parameters
19511961
``suppressNoTLSPeerCertificateWarning`` to ``1`` or ``true`` to
19521962
suppress those warnings.
19531963

1964+
.. include:: /includes/fact-startup-parameter
1965+
19541966
The following operation sets ``suppressNoTLSPeerCertificateWarning``
19551967
to ``true``:
19561968

19571969
.. code-block:: bash
19581970

19591971
db.adminCommand( { setParameter: 1, suppressNoTLSPeerCertificateWarning: true} )
19601972

1961-
19621973
.. _param-ftdc:
19631974

19641975
Diagnostic Parameters
@@ -2006,6 +2017,8 @@ The following parameters support diagnostic data capture (FTDC):
20062017
Determines whether to enable the collecting and logging of data for
20072018
diagnostic purposes. Diagnostic logging is enabled by default.
20082019

2020+
.. include:: /includes/fact-runtime-startup-parameter
2021+
20092022
For example, the following disables the diagnostic collection:
20102023

20112024
.. code-block:: bash
@@ -2045,6 +2058,8 @@ The following parameters support diagnostic data capture (FTDC):
20452058
name already exists in the path or if the process does not have permissions
20462059
to create the directory.
20472060

2061+
.. include:: /includes/fact-runtime-startup-parameter
2062+
20482063
.. parameter:: diagnosticDataCollectionDirectorySizeMB
20492064

20502065
|both|
@@ -2058,6 +2073,8 @@ The following parameters support diagnostic data capture (FTDC):
20582073
diagnostic files in the directory are automatically deleted based on
20592074
the timestamp in the file name.
20602075

2076+
.. include:: /includes/fact-runtime-startup-parameter
2077+
20612078
For example, the following sets the maximum size of the directory to
20622079
``250`` megabytes:
20632080

@@ -2079,10 +2096,11 @@ The following parameters support diagnostic data capture (FTDC):
20792096

20802097
*Default*: 10
20812098

2082-
20832099
Specifies the maximum size, in megabytes, of each diagnostic
20842100
file. If the file exceeds the maximum file size, MongoDB creates a new file.
20852101

2102+
.. include:: /includes/fact-runtime-startup-parameter
2103+
20862104
For example, the following sets the maximum size of each diagnostic
20872105
file to ``20`` megabytes:
20882106

@@ -2104,6 +2122,8 @@ The following parameters support diagnostic data capture (FTDC):
21042122
Specifies the interval, in milliseconds, at which to collect
21052123
diagnostic data.
21062124

2125+
.. include:: /includes/fact-runtime-startup-parameter
2126+
21072127
For example, the following sets the interval to
21082128
``5000`` milliseconds or 5 seconds:
21092129

@@ -4266,6 +4286,8 @@ Health Manager Parameters
42664286
``critical``, the server waits for the specified interval
42674287
before removing the ``mongos`` from the cluster.
42684288

4289+
.. include:: /includes/fact-runtime-startup-parameter
4290+
42694291
.. include:: /includes/example-activeFaultDurationSecs.rst
42704292

42714293
.. parameter:: healthMonitoringIntensities
@@ -4276,6 +4298,8 @@ Health Manager Parameters
42764298

42774299
Use this parameter to set intensity levels for |HMS|.
42784300

4301+
.. include:: /includes/fact-runtime-startup-parameter
4302+
42794303
.. include:: /includes/fact-healthMonitoringIntensities-values-array.rst
42804304

42814305
Health Managers
@@ -4297,6 +4321,8 @@ Health Manager Parameters
42974321
|mongos-only|
42984322

42994323
How often this |HM| will run, in milliseconds.
4324+
4325+
.. include:: /includes/fact-runtime-startup-parameter
43004326

43014327
.. include:: /includes/fact-healthMonitoringIntervals-values-array.rst
43024328

@@ -4314,6 +4340,8 @@ Health Manager Parameters
43144340

43154341
.. include:: /includes/fact-progressMonitor.rst
43164342

4343+
.. include:: /includes/fact-runtime-startup-parameter
4344+
43174345
``progressMonitor`` Fields
43184346
``````````````````````````
43194347

source/release-notes/4.4.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1559,7 +1559,7 @@ inside a transaction:
15591559
For more details, see :ref:`transactions-create-collections-indexes`.
15601560

15611561
MongoDB 4.4 adds a new parameter
1562-
:parameter:`shouldMultiDocTxnCreateCollectionAndIndexes` which can
1562+
``shouldMultiDocTxnCreateCollectionAndIndexes`` which can
15631563
enable (default) or disable collection and index creation inside a
15641564
transaction. When setting the parameter for a sharded cluster, set
15651565
the parameter on all shards.

0 commit comments

Comments
 (0)