docs: clarify max rpc tracing requests (#11796)

Co-authored-by: Dan Cline <6798349+Rjected@users.noreply.github.com>
This commit is contained in:
Matthias Seitz
2024-10-16 18:50:18 +02:00
committed by GitHub
parent 281307fe4c
commit 6b2ec42e48
3 changed files with 9 additions and 2 deletions

View File

@ -320,7 +320,7 @@ fn preprocess_help(s: &str) -> Cow<'_, str> {
(r"default: reth/.*/\w+", "default: reth/<VERSION>/<OS>"),
// Remove rpc.max-tracing-requests default value
(
r"(rpc.max-tracing-requests <COUNT>\n.*\n.*\n.*)\[default: \d+\]",
r"(rpc.max-tracing-requests <COUNT>\n.*\n.*\n.*\n.*\n.*)\[default: \d+\]",
r"$1[default: <NUM CPU CORES-2>]",
),
];

View File

@ -331,7 +331,9 @@ RPC:
[default: 500]
--rpc.max-tracing-requests <COUNT>
Maximum number of concurrent tracing requests
Maximum number of concurrent tracing requests.
By default this chooses a sensible value based on the number of available cores. Tracing requests are generally CPU bound. Choosing a value that is higher than the available CPU cores can have a negative impact on the performance of the node and affect the node's ability to maintain sync.
[default: <NUM CPU CORES-2>]

View File

@ -135,6 +135,11 @@ pub struct RpcServerArgs {
pub rpc_max_connections: MaxU32,
/// Maximum number of concurrent tracing requests.
///
/// By default this chooses a sensible value based on the number of available cores.
/// Tracing requests are generally CPU bound.
/// Choosing a value that is higher than the available CPU cores can have a negative impact on
/// the performance of the node and affect the node's ability to maintain sync.
#[arg(long = "rpc.max-tracing-requests", alias = "rpc-max-tracing-requests", value_name = "COUNT", default_value_t = constants::default_max_tracing_requests())]
pub rpc_max_tracing_requests: usize,