Skip to content

Commit

Permalink
docs: remarks on socket exhaustion warning
Browse files Browse the repository at this point in the history
  • Loading branch information
kuhe authored Nov 25, 2024
1 parent 7497406 commit 27a4cd3
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion supplemental-docs/CLIENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,19 @@ new S3Client({
});
```

A note on **socket exhaustion**: if you encounter an error that indicates
A note on **socket exhaustion**:

The SDK may emit the following warning when detecting socket exhaustion:

```
@smithy/node-http-handler:WARN - socket usage at capacity=${socketsInUse} and ${requestsEnqueued} additional requests are enqueued.
```

Socket exhaustion detection is not an exact determination.
We only warn on this when there is a high count of `requestsEnqueued`,
because running at socket capacity may be intentional and normal in your application.

If you encounter the above warning or an error that indicates
you have run out of sockets due to a high volume of requests flowing through
your SDK Client, there are two things to check:

Expand Down

0 comments on commit 27a4cd3

Please sign in to comment.