Skip to content

Commit d1f4ab2

Browse files
corryrootcorryroot
authored
(DOCS-16062): Added new connPoolStats metrics. (#3988)
* (DOCS-16062): Added new connPoolStats metrics. * (DOCSP-16062): Incorporated Sarah's feedback. * (DOCSP-16062): Incorporated George's feedback.
1 parent 1688bd2 commit d1f4ab2

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

‎source/reference/command/connPoolStats.txt

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ The command returns the output of the following form:
9191
"numAScopedConnections" : <num>,
9292
"totalInUse" : <num>,
9393
"totalAvailable" : <num>,
94+
"totalLeased" : <num>,
9495
"totalCreated" : <num>,
9596
"totalRefreshing" : <num>,
9697
"replicaSetMatchingStrategy" : <string>,
@@ -123,12 +124,14 @@ The command returns the output of the following form:
123124
"NetworkInterfaceTL-TaskExecutorPool-0" : {
124125
"poolInUse" : <num>,
125126
"poolAvailable" : <num>,
127+
"poolLeased" : <num>,
126128
"poolCreated" : <num>,
127129
"poolRefreshing" : <num>,
128130
"acquisitionWaitTimes" : <document>, // Added in MongoDB 6.3
129131
"cfg1.example.net:27019" : {
130132
"inUse" : <num>,
131133
"available" : <num>,
134+
"leased" : <num>,
132135
"created" : <num>,
133136
"refreshing" : <num>,
134137
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
@@ -137,12 +140,14 @@ The command returns the output of the following form:
137140
"NetworkInterfaceTL-TaskExecutorPool-1" : {
138141
"poolInUse" : <num>,
139142
"poolAvailable" : <num>,
143+
"poolLeased" : <num>,
140144
"poolCreated" : <num>,
141145
"poolRefreshing" : <num>,
142146
"acquisitionWaitTimes" : <document>, // Added in MongoDB 6.3
143147
"cfg1.example.net:27019" : {
144148
"inUse" : <num>,
145149
"available" : <num>,
150+
"leased" : <num>,
146151
"created" : <num>,
147152
"refreshing" : <num>,
148153
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
@@ -151,12 +156,14 @@ The command returns the output of the following form:
151156
"NetworkInterfaceTL-TaskExecutorPool-2" : {
152157
"poolInUse" : <num>,
153158
"poolAvailable" : <num>,
159+
"poolLeased" : <num>,
154160
"poolCreated" : <num>,
155161
"poolRefreshing" : <num>,
156162
"acquisitionWaitTimes" : <document>, // Added in MongoDB 6.3
157163
"cfg1.example.net:27019" : {
158164
"inUse" : <num>,
159165
"available" : <num>,
166+
"leased" : <num>,
160167
"created" : <num>,
161168
"refreshing" : <num>,
162169
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
@@ -165,12 +172,14 @@ The command returns the output of the following form:
165172
"NetworkInterfaceTL-TaskExecutorPool-3" : {
166173
"poolInUse" : <num>,
167174
"poolAvailable" : <num>,
175+
"poolLeased" : <num>,
168176
"poolCreated" : <num>,
169177
"poolRefreshing" : <num>,
170178
"acquisitionWaitTimes" : <document>, // Added in MongoDB 6.3
171179
"cfg1.example.net:27019" : {
172180
"inUse" : <num>,
173181
"available" : <num>,
182+
"leased" : <num>,
174183
"created" : <num>,
175184
"refreshing" : <num>,
176185
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
@@ -179,40 +188,46 @@ The command returns the output of the following form:
179188
"NetworkInterfaceTL-ShardRegistry" : {
180189
"poolInUse" : <num>,
181190
"poolAvailable" : <num>,
191+
"poolLeased" : <num>,
182192
"poolCreated" : <num>,
183193
"poolRefreshing" : <num>,
184194
"acquisitionWaitTimes" : <document>, // Added in MongoDB 6.3
185195
"cfg1.example.net:27019" : {
186196
"inUse" : <num>,
187197
"available" : <num>,
198+
"leased" : <num>,
188199
"created" : <num>,
189200
"refreshing" : <num>,
190201
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
191202
},
192203
"cfg2.example.net:27019" : {
193204
"inUse" : <num>,
194205
"available" : <num>,
206+
"leased" : <num>,
195207
"created" : <num>,
196208
"refreshing" : <num>,
197209
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
198210
},
199211
"cfg3.example.net:27019" : {
200212
"inUse" : <num>,
201213
"available" : <num>,
214+
"leased" : <num>,
202215
"created" : <num>,
203216
"refreshing" : <num>,
204217
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
205218
},
206219
"shard1.example.net:27018" : {
207220
"inUse" : <num>,
208221
"available" : <num>,
222+
"leased" : <num>,
209223
"created" : <num>,
210224
"refreshing" : <num>,
211225
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
212226
},
213227
"shard2.example.net:27018" : {
214228
"inUse" : <num>,
215229
"available" : <num>,
230+
"leased" : <num>,
216231
"created" : <num>,
217232
"refreshing" : <num>,
218233
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
@@ -221,40 +236,46 @@ The command returns the output of the following form:
221236
"global" : {
222237
"poolInUse" : <num>,
223238
"poolAvailable" : <num>,
239+
"poolLeased" : <num>,
224240
"poolCreated" : <num>,
225241
"poolRefreshing" : <num>,
226242
"acquisitionWaitTimes" : <document>, // Added in MongoDB 6.3
227243
"cfg3.example.net:27019" : {
228244
"inUse" : <num>,
229245
"available" : <num>,
246+
"leased" : <num>,
230247
"created" : <num>,
231248
"refreshing" : <num>,
232249
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
233250
},
234251
"cfg1.example.net:27019" : {
235252
"inUse" : <num>,
236253
"available" : <num>,
254+
"leased" : <num>,
237255
"created" : <num>,
238256
"refreshing" : <num>,
239257
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
240258
},
241259
"cfg2.example.net:27019" : {
242260
"inUse" : <num>,
243261
"available" : <num>,
262+
"leased" : <num>,
244263
"created" : <num>,
245264
"refreshing" : <num>,
246265
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
247266
},
248267
"shard2.example.net:27018" : {
249268
"inUse" : <num>,
250269
"available" : <num>,
270+
"leased" : <num>,
251271
"created" : <num>,
252272
"refreshing" : <num>,
253273
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
254274
},
255275
"shard1.example.net:27018" : {
256276
"inUse" : <num>,
257277
"available" : <num>,
278+
"leased" : <num>,
258279
"created" : <num>,
259280
"refreshing" : <num>,
260281
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
@@ -265,34 +286,39 @@ The command returns the output of the following form:
265286
"cfg3.example.net:27019" : {
266287
"inUse" : <num>,
267288
"available" : <num>,
289+
"leased" : <num>,
268290
"created" : <num>,
269291
"refreshing" : <num>,
270292
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
271293
},
272294
"cfg1.example.net:27019" : {
273295
"inUse" : <num>,
274296
"available" : <num>,
297+
"leased" : <num>,
275298
"created" : <num>,
276299
"refreshing" : <num>,
277300
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
278301
},
279302
"cfg2.example.net:27019" : {
280303
"inUse" : <num>,
281304
"available" : <num>,
305+
"leased" : <num>,
282306
"created" : <num>,
283307
"refreshing" : <num>,
284308
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
285309
},
286310
"shard2.example.net:27018" : {
287311
"inUse" : <num>,
288312
"available" : <num>,
313+
"leased" : <num>,
289314
"created" : <num>,
290315
"refreshing" : <num>,
291316
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
292317
},
293318
"shard1.example.net:27018" : {
294319
"inUse" : <num>,
295320
"available" : <num>,
321+
"leased" : <num>,
296322
"created" : <num>,
297323
"refreshing" : <num>,
298324
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
@@ -369,6 +395,14 @@ Output
369395
current :binary:`mongod` / :binary:`mongos` instance to other members
370396
of the :term:`sharded cluster` or :term:`replica set`.
371397

398+
.. data:: connPoolStats.totalLeased
399+
400+
Reports the total number of connections borrowed from a pool and
401+
expected to return. These connections might not remain active
402+
through the duration of a lease, and are excluded from the related
403+
metrics. These connections are unavailble through the
404+
duration of the lease.
405+
372406
.. data:: connPoolStats.totalCreated
373407

374408
Reports the total number of outgoing connections ever created by the
@@ -516,15 +550,16 @@ Output
516550
{
517551
"poolInUse" : <num>,
518552
"poolAvailable" : <num>,
553+
"poolLeased" : <num>,
519554
"poolCreated" : <num>,
520555
"poolRefreshing" : <num>,
521556
"acquisitionWaitTimes" : <document>, // Added in MongoDB 6.3
522557
"[host1]" : {
523-
"inUse" : <num>, "available" : <num>, "created" : <num>, "refreshing" : <num>,
558+
"inUse" : <num>, "available" : <num>, "leased" : <num>, "created" : <num>, "refreshing" : <num>,
524559
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
525560
},
526561
"[host2]" : {
527-
"inUse" : <num>, "available" : <num>, "created" : <num>, "refreshing" : <num>,
562+
"inUse" : <num>, "available" : <num>, "leased" : <num>, "created" : <num>, "refreshing" : <num>,
528563
"acquisitionWaitTimes" : <document> // Added in MongoDB 6.3
529564
},
530565
...
@@ -595,6 +630,14 @@ Output
595630
Reports the total number of connections available for connecting
596631
to the ``[host]``.
597632

633+
.. data:: connPoolStats.hosts.[host].leased
634+
635+
Reports the total number of connections to the host borrowed from
636+
a pool and expected to return. These connections might not remain
637+
active through the duration of a lease, and are excluded from the
638+
related metrics. These connections are unavailble through the
639+
duration of the lease.
640+
598641
.. data:: connPoolStats.hosts.[host].created
599642

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

0 commit comments

Comments
 (0)