Skip to content

Commit 56c490d

Browse files
authored
(DOCS-16275): Backport DOCS-16062 to v6.0. (#3988) (#4038)
* (DOCS-16062): Added new connPoolStats metrics. * (DOCSP-16062): Incorporated Sarah's feedback. * (DOCSP-16062): Incorporated George's feedback.
1 parent cae7e9a commit 56c490d

File tree

1 file changed

+49
-2
lines changed

1 file changed

+49
-2
lines changed

source/reference/command/connPoolStats.txt

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,126 +91,147 @@ The command returns the output of the following form:
9191
"numAScopedConnections" : <num>,
9292
"totalInUse" : <num>,
9393
"totalAvailable" : <num>,
94+
"totalLeased" : <num>, // Added in MongoDB 6.0.6
9495
"totalCreated" : <num>,
9596
"totalRefreshing" : <num>,
9697
"replicaSetMatchingStrategy" : <string>,
9798
"pools" : {
9899
"NetworkInterfaceTL-TaskExecutorPool-0" : {
99100
"poolInUse" : <num>,
100101
"poolAvailable" : <num>,
102+
"poolLeased" : <num>, // Added in MongoDB 6.0.6
101103
"poolCreated" : <num>,
102104
"poolRefreshing" : <num>,
103105
"cfg1.example.net:27019" : {
104106
"inUse" : <num>,
105107
"available" : <num>,
108+
"leased" : <num>, // Added in MongoDB 6.0.6
106109
"created" : <num>,
107110
"refreshing" :<num>
108111
}
109112
},
110113
"NetworkInterfaceTL-TaskExecutorPool-1" : {
111114
"poolInUse" : <num>,
112115
"poolAvailable" : <num>,
116+
"poolLeased" : <num>, // Added in MongoDB 6.0.6
113117
"poolCreated" : <num>,
114118
"poolRefreshing" : <num>,
115119
"cfg1.example.net:27019" : {
116120
"inUse" : <num>,
117121
"available" : <num>,
122+
"leased" : <num>, // Added in MongoDB 6.0.6
118123
"created" : <num>,
119124
"refreshing" :<num>
120125
}
121126
},
122127
"NetworkInterfaceTL-TaskExecutorPool-2" : {
123128
"poolInUse" : <num>,
124129
"poolAvailable" : <num>,
130+
"poolLeased" : <num>, // Added in MongoDB 6.0.6
125131
"poolCreated" : <num>,
126132
"poolRefreshing" : <num>,
127133
"cfg1.example.net:27019" : {
128134
"inUse" : <num>,
129135
"available" : <num>,
136+
"leased" : <num>, // Added in MongoDB 6.0.6
130137
"created" : <num>,
131138
"refreshing" :<num>
132139
}
133140
},
134141
"NetworkInterfaceTL-TaskExecutorPool-3" : {
135142
"poolInUse" : <num>,
136143
"poolAvailable" : <num>,
144+
"poolLeased" : <num>, // Added in MongoDB 6.0.6
137145
"poolCreated" : <num>,
138146
"poolRefreshing" : <num>,
139147
"cfg1.example.net:27019" : {
140148
"inUse" : <num>,
141149
"available" : <num>,
150+
"leased" : <num>, // Added in MongoDB 6.0.6
142151
"created" : <num>,
143152
"refreshing" :<num>
144153
}
145154
},
146155
"NetworkInterfaceTL-ShardRegistry" : {
147156
"poolInUse" : <num>,
148157
"poolAvailable" : <num>,
158+
"poolLeased" : <num>, // Added in MongoDB 6.0.6
149159
"poolCreated" : <num>,
150160
"poolRefreshing" : <num>,
151161
"cfg1.example.net:27019" : {
152162
"inUse" : <num>,
153163
"available" : <num>,
164+
"leased" : <num>, // Added in MongoDB 6.0.6
154165
"created" : <num>,
155166
"refreshing" :<num>
156167
},
157168
"cfg2.example.net:27019" : {
158169
"inUse" : <num>,
159170
"available" : <num>,
171+
"leased" : <num>, // Added in MongoDB 6.0.6
160172
"created" : <num>,
161173
"refreshing" :<num>
162174
},
163175
"cfg3.example.net:27019" : {
164176
"inUse" : <num>,
165177
"available" : <num>,
178+
"leased" : <num>, // Added in MongoDB 6.0.6
166179
"created" : <num>,
167180
"refreshing" :<num>
168181
},
169182
"shard1.example.net:27018" : {
170183
"inUse" : <num>,
171184
"available" : <num>,
185+
"leased" : <num>, // Added in MongoDB 6.0.6
172186
"created" : <num>,
173187
"refreshing" :<num>
174188
},
175189
"shard2.example.net:27018" : {
176190
"inUse" : <num>,
177191
"available" : <num>,
192+
"leased" : <num>, // Added in MongoDB 6.0.6
178193
"created" : <num>,
179194
"refreshing" :<num>
180195
}
181196
},
182197
"global" : {
183198
"poolInUse" : <num>,
184199
"poolAvailable" : <num>,
200+
"poolLeased" : <num>, // Added in MongoDB 6.0.6
185201
"poolCreated" : <num>,
186202
"poolRefreshing" : <num>,
187203
"cfg3.example.net:27019" : {
188204
"inUse" : <num>,
189205
"available" : <num>,
206+
"leased" : <num>, // Added in MongoDB 6.0.6
190207
"created" : <num>,
191208
"refreshing" :<num>
192209
},
193210
"cfg1.example.net:27019" : {
194211
"inUse" : <num>,
195212
"available" : <num>,
213+
"leased" : <num>, // Added in MongoDB 6.0.6
196214
"created" : <num>,
197215
"refreshing" :<num>
198216
},
199217
"cfg2.example.net:27019" : {
200218
"inUse" : <num>,
201219
"available" : <num>,
220+
"leased" : <num>, // Added in MongoDB 6.0.6
202221
"created" : <num>,
203222
"refreshing" :<num>
204223
},
205224
"shard2.example.net:27018" : {
206225
"inUse" : <num>,
207226
"available" : <num>,
227+
"leased" : <num>, // Added in MongoDB 6.0.6
208228
"created" : <num>,
209229
"refreshing" :<num>
210230
},
211231
"shard1.example.net:27018" : {
212232
"inUse" : <num>,
213233
"available" : <num>,
234+
"leased" : <num>, // Added in MongoDB 6.0.6
214235
"created" : <num>,
215236
"refreshing" :<num>
216237
}
@@ -220,30 +241,35 @@ The command returns the output of the following form:
220241
"cfg3.example.net:27019" : {
221242
"inUse" : <num>,
222243
"available" : <num>,
244+
"leased" : <num>, // Added in MongoDB 6.0.6
223245
"created" : <num>,
224246
"refreshing" :<num>
225247
},
226248
"cfg1.example.net:27019" : {
227249
"inUse" : <num>,
228250
"available" : <num>,
251+
"leased" : <num>, // Added in MongoDB 6.0.6
229252
"created" : <num>,
230253
"refreshing" :<num>
231254
},
232255
"cfg2.example.net:27019" : {
233256
"inUse" : <num>,
234257
"available" : <num>,
258+
"leased" : <num>, // Added in MongoDB 6.0.6
235259
"created" : <num>,
236260
"refreshing" :<num>
237261
},
238262
"shard2.example.net:27018" : {
239263
"inUse" : <num>,
240264
"available" : <num>,
265+
"leased" : <num>, // Added in MongoDB 6.0.6
241266
"created" : <num>,
242267
"refreshing" :<num>
243268
},
244269
"shard1.example.net:27018" : {
245270
"inUse" : <num>,
246271
"available" : <num>,
272+
"leased" : <num>, // Added in MongoDB 6.0.6
247273
"created" : <num>,
248274
"refreshing" :<num>
249275
}
@@ -319,6 +345,16 @@ Output
319345
current :binary:`mongod` / :binary:`mongos` instance to other members
320346
of the :term:`sharded cluster` or :term:`replica set`.
321347

348+
.. data:: connPoolStats.totalLeased
349+
350+
.. versionadded:: 6.0.6
351+
352+
Reports the total number of connections borrowed from a pool and
353+
expected to return. These connections might not remain active
354+
through the duration of a lease, and are excluded from the related
355+
metrics. These connections are unavailble through the
356+
duration of the lease.
357+
322358
.. data:: connPoolStats.totalCreated
323359

324360
Reports the total number of outgoing connections ever created by the
@@ -417,10 +453,11 @@ Output
417453
{
418454
"poolInUse" : <num>,
419455
"poolAvailable" : <num>,
456+
"poolLeased" : <num>, // Added in MongoDB 6.0.6
420457
"poolCreated" : <num>,
421458
"poolRefreshing" : <num>,
422-
"[host1]" : { "inUse" : <num>, "available" : <num>, "created" : <num>, "refreshing" : <num> },
423-
"[host2]" : { "inUse" : <num>, "available" : <num>, "created" : <num>, "refreshing" : <num> },
459+
"[host1]" : { "inUse" : <num>, "available" : <num>, "leased" : <num>, "created" : <num>, "refreshing" : <num> },
460+
"[host2]" : { "inUse" : <num>, "available" : <num>, "leased" : <num>, "created" : <num>, "refreshing" : <num> },
424461
...
425462
}
426463

@@ -481,6 +518,16 @@ Output
481518
Reports the total number of connections available for connecting
482519
to the ``[host]``.
483520

521+
.. data:: connPoolStats.hosts.[host].leased
522+
523+
.. versionadded:: 6.0.6
524+
525+
Reports the total number of connections to the host borrowed from
526+
a pool and expected to return. These connections might not remain
527+
active through the duration of a lease, and are excluded from the
528+
related metrics. These connections are unavailble through the
529+
duration of the lease.
530+
484531
.. data:: connPoolStats.hosts.[host].created
485532

486533
Reports the number of connections to the ``[host]`` ever created.

0 commit comments

Comments
 (0)