Skip to content

Commit ff15ad1

Browse files
author
Sam Kleinman
committed
DOCS-158 changes in response to technical review
1 parent 21b1b6c commit ff15ad1

File tree

1 file changed

+41
-30
lines changed

1 file changed

+41
-30
lines changed

source/reference/connection-pool-stats.txt

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,19 @@ Output
2424
.. stats:: hosts
2525

2626
The sub-documents of the :stats:`hosts` :term:`document` report connections
27-
between the :program:`mongos` instance and every component
27+
between the :program:`mongos` or :program:`mongod` instance and each component
2828
:program:`mongod` of the :term:`shard cluster`.
2929

3030
.. stats:: hosts.[host].available
3131

3232
:stats:`hosts.[host].available` reports the total number of
33-
connections created by the :program:`mongos`, and used to
34-
connect to members of the :term:`shard cluster`.
33+
connections that the :program:`mongos` or :program:`mongod`
34+
could use to connect to this :program:`mongod`.
3535

3636
.. stats:: hosts.[host].created
3737

3838
:stats:`hosts.[host].created` reports the number of connections
39-
that this :program:`mongos` has ever created for this host.
39+
that this :program:`mongos` or :program:`mongod` has ever created for this host.
4040

4141
.. stats:: replicaSets
4242

@@ -50,53 +50,63 @@ Output
5050

5151
.. stats:: replicaSets.[shard].host
5252

53-
The :stats:`replicaSets.[shard].host` :term:`document` reports
54-
on each host within the :term:`shard` in the :term:`replica
55-
set`.
53+
The :stats:`replicaSets.[shard].host` field holds an array of
54+
:term:`document` that reports on each host within the
55+
:term:`shard` in the :term:`replica set`.
5656

5757
These values derive from the :doc:`replica set status
5858
</reference/replica-status>` values.
5959

60-
.. stats:: replicaSets.[shard].[host].addr
60+
.. stats:: replicaSets.[shard].host[n].addr
6161

62-
:stats:`replicaSets.[shard].[host].addr` reports the address
62+
:stats:`replicaSets.[shard].host[n].addr` reports the address
6363
for the host in the :term:`shard cluster` in the format of
6464
"``[hostname]:[port]``".
6565

66-
.. stats:: replicaSets.[shard].[host].ok
66+
.. stats:: replicaSets.[shard].host[n].ok
6767

68-
:stats:`replicaSets.[shard].[host].ok` reports ``false``
68+
:stats:`replicaSets.[shard].host[n].ok` reports ``false``
6969
when:
7070

71-
- the :program:`mongos` cannot connect to instance.
71+
- the :program:`mongos` or :program:`mongod` cannot connect
72+
to instance.
7273

73-
- the :program:`mongos` received a connection exception or error.
74+
- the :program:`mongos` or :program:`mongod` received a
75+
connection exception or error.
7476

7577
This field is for internal use.
7678

77-
.. stats:: replicaSets.[shard].[host].ismaster
79+
.. stats:: replicaSets.[shard].host[n].ismaster
7880

79-
:stats:`replicaSets.[shard].[host].ismaster` reports ``true``
81+
:stats:`replicaSets.[shard].host[n].ismaster` reports ``true``
8082
if this :stats:`replicaSets.[shard].host` is the
8183
:term:`primary` member of the :term:`replica set`.
8284

83-
.. stats:: replicaSets.[shard].[host].hidden
85+
.. stats:: replicaSets.[shard].host[n].hidden
8486

85-
:stats:`replicaSets.[shard].[host].hidden` reports ``true``
87+
:stats:`replicaSets.[shard].host[n].hidden` reports ``true``
8688
if this :stats:`replicaSets.[shard].host` is a :term:`hidden
8789
member` of the :term:`replica set`.
8890

89-
.. stats:: replicaSets.[shard].[host].secondary
91+
.. stats:: replicaSets.[shard].host[n].secondary
9092

91-
:stats:`replicaSets.[shard].[host].secondary` reports
93+
:stats:`replicaSets.[shard].host[n].secondary` reports
9294
``true`` if this :stats:`replicaSets.[shard].host` is a
9395
:term:`secondary` member of the :term:`replica set`.
9496

95-
.. stats:: replicaSets.[shard].[host].pingTimeMillis
97+
.. stats:: replicaSets.[shard].host[n].pingTimeMillis
9698

97-
:stats:`replicaSets.[shard].[host].pingTimeMillis` reports
98-
the ping time in milliseconds from the :program:`mongos` to
99-
this :stats:`replicaSets.[shard].host`.
99+
:stats:`replicaSets.[shard].host[n].pingTimeMillis` reports
100+
the ping time in milliseconds from the :program:`mongos` or
101+
:program:`mongod` to this :stats:`replicaSets.[shard].host`.
102+
103+
.. stats:: replicaSets.[shard].host[n].tags
104+
105+
.. versionadded:: 2.2
106+
107+
:stats:`replicaSets.[shard].host[n].tags` reports the
108+
:data:`members[n].tags`, if this member of the set has tags
109+
configured.
100110

101111
.. stats:: replicaSets.[shard].master
102112

@@ -115,7 +125,7 @@ Output
115125
.. stats:: createdByType
116126

117127
:stats:`createdByType` :term:`document` reports the number of each
118-
type of connection that :program:`mongos` has created in all
128+
type of connection that :program:`mongos` or :program:`mongod` has created in all
119129
connection pools.
120130

121131
:program:`mongos` connect to :program:`mongod` instances using one
@@ -141,25 +151,26 @@ Output
141151
.. stats:: totalAvailable
142152

143153
:stats:`totalAvailable` reports the running total of connections
144-
from the :program:`mongos` to all :program:`mongod` instances in
145-
the :term:`shard cluster`
154+
from the :program:`mongos` or :program:`mongod` to all :program:`mongod` instances in
155+
the :term:`shard cluster` available for use. This value does not
156+
reflect those connections that
146157

147158
.. stats:: totalCreated
148159

149160
:stats:`totalCreated` reports the total number of connections ever
150-
created from the :program:`mongos` to all :program:`mongod`
161+
created from the :program:`mongos` or :program:`mongod` to all :program:`mongod`
151162
instances in the :term:`shard cluster`.
152163

153164
.. stats:: numDBClientConnection
154165

155166
:stats:`numDBClientConnection` reports the total number of
156-
connections from the :program:`mongos` to all of the :program:`mongod`
167+
connections from the :program:`mongos` or :program:`mongod` to all of the :program:`mongod`
157168
instances in the :term:`shard cluster`.
158169

159170
.. stats:: numAScopedConnection
160171

161172
:stats:`numAScopedConnection` reports the number of exception safe
162-
connections created from :program:`mongos` to all :program:`mongod`
163-
in the :term:`shard cluster`. The :program:`mongos` releases these
173+
connections created from :program:`mongos` or :program:`mongod` to all :program:`mongod`
174+
in the :term:`shard cluster`. The :program:`mongos` or :program:`mongod` releases these
164175
connections after receiving a socket exception from the
165176
:program:`mongod`.

0 commit comments

Comments
 (0)