mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-12 10:30:08 +01:00
Code Issues Projects Releases Wiki Activity

doc: Update limitations sections in RPC and REST interface docs

Browse source
This commit is contained in:
Fabian Jahr 2023-05-24 01:10:08 +02:00
parent 5e8eccceac
commit 3a66391bdb
No known key found for this signature in database
GPG key ID: F13D1E9D890798CD
2 changed files with 10 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/JSON-RPC-interface.md
View file

@ -188,11 +188,8 @@ this RPC may not yet be reflected as such in this RPC response.
## Limitations
There is a known issue in the JSON-RPC interface that can cause a node to crash if
too many http connections are being opened at the same time because the system runs
out of available file descriptors. To prevent this from happening you might
want to increase the number of maximum allowed file descriptors in your system
and try to prevent opening too many connections to your JSON-RPC interface at the
same time if this is under your control. It is hard to give general advice
since this depends on your system but if you make several hundred requests at
once you are definitely at risk of encountering this issue.
When too many connections are opened quickly the interface will start to
respond with 503 Service Unavailable to prevent a crash from running out of file
descriptors. To prevent this from happening you should try to prevent opening
too many connections to the interface at the same time, for example
by throttling your request rate.

13
doc/REST-interface.md
View file

@ -15,14 +15,11 @@ apply.
Limitations
-----------
There is a known issue in the REST interface that can cause a node to crash if
too many http connections are being opened at the same time because the system runs
out of available file descriptors. To prevent this from happening you might
want to increase the number of maximum allowed file descriptors in your system
and try to prevent opening too many connections to your rest interface at the
same time if this is under your control. It is hard to give general advice
since this depends on your system but if you make several hundred requests at
once you are definitely at risk of encountering this issue.
When too many connections are opened quickly the interface will start to
respond with 503 Service Unavailable to prevent a crash from running out of file
descriptors. To prevent this from happening you should try to prevent opening
too many connections to the interface at the same time, for example
by throttling your request rate.
Supported API
-------------