Skip to content

Commit 27a4cd3

Browse files
authored
docs: remarks on socket exhaustion warning
1 parent 7497406 commit 27a4cd3

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

supplemental-docs/CLIENTS.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,19 @@ new S3Client({
262262
});
263263
```
264264

265-
A note on **socket exhaustion**: if you encounter an error that indicates
265+
A note on **socket exhaustion**:
266+
267+
The SDK may emit the following warning when detecting socket exhaustion:
268+
269+
```
270+
@smithy/node-http-handler:WARN - socket usage at capacity=${socketsInUse} and ${requestsEnqueued} additional requests are enqueued.
271+
```
272+
273+
Socket exhaustion detection is not an exact determination.
274+
We only warn on this when there is a high count of `requestsEnqueued`,
275+
because running at socket capacity may be intentional and normal in your application.
276+
277+
If you encounter the above warning or an error that indicates
266278
you have run out of sockets due to a high volume of requests flowing through
267279
your SDK Client, there are two things to check:
268280

0 commit comments

Comments
 (0)