Skip to content

Commit 6fefa84

Browse files
authored
DOCS-16384 readPreferenceCounters Metrics in serverStatus (#5196)
* DOCS-16384 readPreferenceCounters Metrics in serverStatus * add availability note * rn * order * internal review feedback * AM feedback * update rn * *
1 parent d0c27f5 commit 6fefa84

File tree

2 files changed

+101
-0
lines changed

2 files changed

+101
-0
lines changed

source/reference/command/serverStatus.txt

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4103,6 +4103,97 @@ readConcernCounters
41034103
time, which means a point in time was omitted and the server will
41044104
read the most recently committed snapshot available to the node.
41054105

4106+
.. _server-status-readPreferenceCounters:
4107+
4108+
readPreferenceCounters
4109+
~~~~~~~~~~~~~~~~~~~~~~
4110+
4111+
*Available starting in MongoDB 7.2 (and 7.0.3, 6.0.11).*
4112+
4113+
|mongod-only|
4114+
4115+
.. code-block:: javascript
4116+
4117+
readPreferenceCounters : {
4118+
executedOnPrimary : {
4119+
primary : {
4120+
internal : Long("<num>"),
4121+
external : Long("<num>")
4122+
},
4123+
primaryPreferred : {
4124+
internal : Long("<num>"),
4125+
external : Long("<num>")
4126+
},
4127+
secondary : {
4128+
internal : Long("<num>"),
4129+
external : Long("<num>")
4130+
},
4131+
secondaryPreferred : {
4132+
internal : Long("<num>"),
4133+
external : Long("<num>")
4134+
},
4135+
nearest : {
4136+
internal : Long("<num>"),
4137+
external : Long("<num>")
4138+
},
4139+
tagged : {
4140+
internal : Long("<num>"),
4141+
external : Long("<num>")
4142+
}
4143+
},
4144+
executedOnSecondary : {
4145+
primary : {
4146+
internal : Long("<num>"),
4147+
external : Long("<num>")
4148+
},
4149+
primaryPreferred : {
4150+
internal : Long("<num>"),
4151+
external : Long("<num>")
4152+
},
4153+
secondary : {
4154+
internal : Long("<num>"),
4155+
external : Long("<num>")
4156+
},
4157+
secondaryPreferred : {
4158+
internal : Long("<num>"),
4159+
external : Long("<num>")
4160+
},
4161+
nearest : {
4162+
internal : Long("<num>"),
4163+
external : Long("<num>")
4164+
},
4165+
tagged : {
4166+
internal : Long("<num>"),
4167+
external : Long("<num>")
4168+
}
4169+
}
4170+
}
4171+
4172+
.. serverstatus:: readPreferenceCounters
4173+
4174+
|mongod-only|
4175+
4176+
A document that reports the number of operations received by this
4177+
:binary:`~bin.mongod` node with the specified
4178+
:ref:`read preference <read-pref-summary>`.
4179+
4180+
The ``tagged`` sub-field refers to any read preference passed in
4181+
with a :ref:`tag <replica-set-read-preference-tag-sets>`.
4182+
4183+
.. serverstatus:: readPreferenceCounters.executedOnPrimary
4184+
4185+
|mongod-only|
4186+
4187+
A document that counts how many internal and external read preference
4188+
operations the node received while serving as the primary.
4189+
4190+
.. serverstatus:: readPreferenceCounters.executedOnSecondary
4191+
4192+
|mongod-only|
4193+
4194+
A document that counts how many internal and external read preference
4195+
operations the node received while serving as a secondary.
4196+
41064197
.. _server-status-repl:
41074198

41084199
repl

source/release-notes/7.2.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,16 @@ New Bulk Write Command
2424

2525
.. include:: /includes/bulkWrite-introduction.rst
2626

27+
.. _7.2-rel-notes-serverStatus:
28+
29+
``serverStatus`` Metrics
30+
~~~~~~~~~~~~~~~~~~~~~~~~
31+
32+
Starting in MongoDB 7.2, the :dbcommand:`serverStatus` command and the
33+
:method:`db.serverStatus()` method outputs include the following new metrics:
34+
35+
- :serverstatus:`readPreferenceCounters`
36+
2737
.. toctree::
2838
:titlesonly:
2939
:hidden:

0 commit comments

Comments
 (0)