Skip to content

Commit 9d7968d

Browse files
author
Kay Kim
committed
DOCS-12403: reportOpWriteConcernCountersInServerStatus flag
1 parent c8fd232 commit 9d7968d

File tree

4 files changed

+52
-3
lines changed

4 files changed

+52
-3
lines changed

source/includes/extracts-server-status-projection-base.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ content: |
2222
2323
- :serverstatus:`opReadConcernCounters`
2424
25-
- :serverstatus:`opWriteConcernCounters`
25+
- :serverstatus:`opWriteConcernCounters` (Requires
26+
:parameter:`reportOpWriteConcernCountersInServerStatus` parameter
27+
set to ``true``).
2628
2729
- :serverstatus:`metrics.repl.apply.batchSize`
2830

source/includes/extracts-server-status-projection.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,12 @@ inherit:
2525
file: extracts-server-status-projection-base.yaml
2626
replacement:
2727
operationName: ":method:`db.serverStatus()`"
28+
---
29+
ref: serverStatus-opWriteConcernCounters
30+
content: |
31+
32+
Only available when
33+
:parameter:`reportOpWriteConcernCountersInServerStatus` parameter is
34+
set to ``true`` (``false`` by default).
35+
2836
...

source/reference/command/serverStatus.txt

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -762,8 +762,6 @@ opWriteConcernCounters
762762

763763
.. serverstatus:: opWriteConcernCounters
764764

765-
.. versionadded:: 4.0.6
766-
767765
A document that reports on the :doc:`write concerns
768766
</reference/write-concern>` specified by write operations to the
769767
:binary:`~bin.mongod` instance since it last started.
@@ -774,6 +772,10 @@ opWriteConcernCounters
774772
(``wtimeout``) of the write concerns does not affect the count. The
775773
count is incremented even if the operation times out.
776774

775+
.. note::
776+
777+
.. include:: /includes/extracts/serverStatus-opWriteConcernCounters.rst
778+
777779
.. serverstatus:: opWriteConcernCounters.insert
778780

779781
.. versionadded:: 4.0.6
@@ -782,6 +784,10 @@ opWriteConcernCounters
782784
by insert operations to the :binary:`~bin.mongod` instance since it
783785
last started:
784786

787+
.. note::
788+
789+
.. include:: /includes/extracts/serverStatus-opWriteConcernCounters.rst
790+
785791
.. code-block:: javascript
786792

787793
"insert" : {
@@ -837,6 +843,10 @@ opWriteConcernCounters
837843
by update operations to the :binary:`~bin.mongod` instance since it
838844
last started:
839845

846+
.. note::
847+
848+
.. include:: /includes/extracts/serverStatus-opWriteConcernCounters.rst
849+
840850
.. code-block:: javascript
841851

842852
"update" : {
@@ -891,6 +901,10 @@ opWriteConcernCounters
891901
by delete operations to the :binary:`~bin.mongod` instance since it
892902
last started:
893903

904+
.. note::
905+
906+
.. include:: /includes/extracts/serverStatus-opWriteConcernCounters.rst
907+
894908
.. code-block:: javascript
895909

896910
"delete" : {

source/reference/parameters.txt

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -735,6 +735,31 @@ General Parameters
735735

736736
.. include:: /includes/fact-index-build-memory-limit.rst
737737

738+
739+
.. parameter:: reportOpWriteConcernCountersInServerStatus
740+
741+
.. versionadded:: 4.0.6
742+
743+
*Default*: false
744+
745+
A boolean flag that determines whether the
746+
:method:`db.serverStatus()` method and :dbcommand:`serverStatus`
747+
command return :serverstatus:`opWriteConcernCounters` information. [#perf]_
748+
749+
You can only set
750+
:parameter:`reportOpWriteConcernCountersInServerStatus` during
751+
startup in the config file or on the command line. For example:
752+
753+
.. code-block:: sh
754+
755+
mongod --setParameter reportOpWriteConcernCountersInServerStatus=true
756+
757+
.. [#perf]
758+
759+
Enabling :parameter:`reportOpWriteConcernCountersInServerStatus`
760+
can have a negative performance impact; specificaly, when running
761+
*without* TLS.
762+
738763
.. parameter:: watchdogPeriodSeconds
739764

740765
.. versionadded:: 3.6

0 commit comments

Comments
 (0)