Skip to content

Commit e6b7d8c

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

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed

source/reference/command/serverStatus.txt

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

3826+
.. _server-status-readPreferenceCounters:
3827+
3828+
readPreferenceCounters
3829+
~~~~~~~~~~~~~~~~~~~~~~
3830+
3831+
*Available starting in MongoDB 6.0.11.*
3832+
3833+
|mongod-only|
3834+
3835+
.. code-block:: javascript
3836+
3837+
readPreferenceCounters : {
3838+
executedOnPrimary : {
3839+
primary : {
3840+
internal : Long("<num>"),
3841+
external : Long("<num>")
3842+
},
3843+
primaryPreferred : {
3844+
internal : Long("<num>"),
3845+
external : Long("<num>")
3846+
},
3847+
secondary : {
3848+
internal : Long("<num>"),
3849+
external : Long("<num>")
3850+
},
3851+
secondaryPreferred : {
3852+
internal : Long("<num>"),
3853+
external : Long("<num>")
3854+
},
3855+
nearest : {
3856+
internal : Long("<num>"),
3857+
external : Long("<num>")
3858+
},
3859+
tagged : {
3860+
internal : Long("<num>"),
3861+
external : Long("<num>")
3862+
}
3863+
},
3864+
executedOnSecondary : {
3865+
primary : {
3866+
internal : Long("<num>"),
3867+
external : Long("<num>")
3868+
},
3869+
primaryPreferred : {
3870+
internal : Long("<num>"),
3871+
external : Long("<num>")
3872+
},
3873+
secondary : {
3874+
internal : Long("<num>"),
3875+
external : Long("<num>")
3876+
},
3877+
secondaryPreferred : {
3878+
internal : Long("<num>"),
3879+
external : Long("<num>")
3880+
},
3881+
nearest : {
3882+
internal : Long("<num>"),
3883+
external : Long("<num>")
3884+
},
3885+
tagged : {
3886+
internal : Long("<num>"),
3887+
external : Long("<num>")
3888+
}
3889+
}
3890+
}
3891+
3892+
.. serverstatus:: readPreferenceCounters
3893+
3894+
|mongod-only|
3895+
3896+
A document that reports the number of operations received by this
3897+
:binary:`~bin.mongod` node with the specified
3898+
:ref:`read preference <read-pref-summary>`.
3899+
3900+
The ``tagged`` sub-field refers to any read preference passed in
3901+
with a :ref:`tag <replica-set-read-preference-tag-sets>`.
3902+
3903+
.. serverstatus:: readPreferenceCounters.executedOnPrimary
3904+
3905+
|mongod-only|
3906+
3907+
A document that counts how many internal and external read preference
3908+
operations the node received while serving as the primary.
3909+
3910+
.. serverstatus:: readPreferenceCounters.executedOnSecondary
3911+
3912+
|mongod-only|
3913+
3914+
A document that counts how many internal and external read preference
3915+
operations the node received while serving as a secondary.
3916+
38263917
.. _server-status-repl:
38273918

38283919
repl

0 commit comments

Comments
 (0)