diff --git a/book/SUMMARY.md b/book/SUMMARY.md index 4ffbf8458..136e67434 100644 --- a/book/SUMMARY.md +++ b/book/SUMMARY.md @@ -63,6 +63,7 @@ - [`reth debug merkle`](./cli/reth/debug/merkle.md) - [`reth debug in-memory-merkle`](./cli/reth/debug/in-memory-merkle.md) - [`reth debug build-block`](./cli/reth/debug/build-block.md) + - [`reth debug replay-engine`](./cli/reth/debug/replay-engine.md) - [`reth recover`](./cli/reth/recover.md) - [`reth recover storage-tries`](./cli/reth/recover/storage-tries.md) - [Developers](./developers/developers.md) diff --git a/book/cli/SUMMARY.md b/book/cli/SUMMARY.md index 7427e488c..f5c1b792c 100644 --- a/book/cli/SUMMARY.md +++ b/book/cli/SUMMARY.md @@ -34,6 +34,7 @@ - [`reth debug merkle`](./reth/debug/merkle.md) - [`reth debug in-memory-merkle`](./reth/debug/in-memory-merkle.md) - [`reth debug build-block`](./reth/debug/build-block.md) + - [`reth debug replay-engine`](./reth/debug/replay-engine.md) - [`reth recover`](./reth/recover.md) - [`reth recover storage-tries`](./reth/recover/storage-tries.md) diff --git a/book/cli/help.py b/book/cli/help.py index 6f86da4a6..bc584136a 100755 --- a/book/cli/help.py +++ b/book/cli/help.py @@ -254,8 +254,10 @@ def preprocess_help(s: str): """Preprocesses the help output of a command.""" # Remove the user-specific paths. s = re.sub(r"default: /.*/reth", "default: ", s) - # Remove the commit SHA. - s = re.sub(r"-[0-9A-Fa-f]{6,10}/", "-/", s) + # Remove the commit SHA and target architecture triple + s = re.sub(r"default: reth/.*-[0-9A-Fa-f]{6,10}/\w+-\w*-\w+", "default: reth/-/", s) + # Remove the OS + s = re.sub(r"default: reth/.*/\w+", "default: reth//", s) return s diff --git a/book/cli/reth.md b/book/cli/reth.md index 087726863..e0aa8c659 100644 --- a/book/cli/reth.md +++ b/book/cli/reth.md @@ -47,6 +47,36 @@ Options: Print version Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -62,11 +92,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/config.md b/book/cli/reth/config.md index 30cc4715a..fbd5e42a3 100644 --- a/book/cli/reth/config.md +++ b/book/cli/reth/config.md @@ -2,7 +2,7 @@ Write config to stdout -```text +```bash $ reth config --help Usage: reth config [OPTIONS] @@ -37,6 +37,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -52,11 +82,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db.md b/book/cli/reth/db.md index cac6fa04b..272b14659 100644 --- a/book/cli/reth/db.md +++ b/book/cli/reth/db.md @@ -2,7 +2,7 @@ Database debugging utilities -```text +```bash $ reth db --help Usage: reth db [OPTIONS] @@ -68,6 +68,36 @@ Database: - extra: Enables logging for extra debug-level messages Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -83,11 +113,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db/clear.md b/book/cli/reth/db/clear.md index ad1f999ba..249c29461 100644 --- a/book/cli/reth/db/clear.md +++ b/book/cli/reth/db/clear.md @@ -2,7 +2,7 @@ Deletes all table entries -```text +```bash $ reth db clear --help Usage: reth db clear [OPTIONS] @@ -46,6 +46,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -61,11 +91,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db/diff.md b/book/cli/reth/db/diff.md index 1ce2a14f3..120cd949e 100644 --- a/book/cli/reth/db/diff.md +++ b/book/cli/reth/db/diff.md @@ -2,7 +2,7 @@ Create a diff between two database tables or two entire databases -```text +```bash $ reth db diff --help Usage: reth db diff [OPTIONS] --secondary-datadir --output @@ -65,6 +65,36 @@ Database: The output directory for the diff report. Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -80,11 +110,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db/drop.md b/book/cli/reth/db/drop.md index 9a8d64de0..a0ba3b1bd 100644 --- a/book/cli/reth/db/drop.md +++ b/book/cli/reth/db/drop.md @@ -2,7 +2,7 @@ Deletes all database entries -```text +```bash $ reth db drop --help Usage: reth db drop [OPTIONS] @@ -45,6 +45,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -60,11 +90,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db/get.md b/book/cli/reth/db/get.md index 4452490fd..6c8ca30ad 100644 --- a/book/cli/reth/db/get.md +++ b/book/cli/reth/db/get.md @@ -2,9 +2,9 @@ Gets the content of a table for the given key -```text +```bash $ reth db get --help -Usage: reth db get [OPTIONS]
+Usage: reth db get [OPTIONS]
[SUBKEY] Arguments:
@@ -15,6 +15,9 @@ Arguments: The key to get content for + [SUBKEY] + The subkey to get content for + Options: --datadir The path to the data dir for all reth files and subdirectories. @@ -54,6 +57,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -69,11 +102,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db/list.md b/book/cli/reth/db/list.md index 4e3df18a6..f1ae85228 100644 --- a/book/cli/reth/db/list.md +++ b/book/cli/reth/db/list.md @@ -2,7 +2,7 @@ Lists the contents of a table -```text +```bash $ reth db list --help Usage: reth db list [OPTIONS]
@@ -88,6 +88,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -103,11 +133,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db/path.md b/book/cli/reth/db/path.md index 6f16ebb5c..f39fd11b4 100644 --- a/book/cli/reth/db/path.md +++ b/book/cli/reth/db/path.md @@ -2,7 +2,7 @@ Returns the full database path -```text +```bash $ reth db path --help Usage: reth db path [OPTIONS] @@ -42,6 +42,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -57,11 +87,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db/snapshot.md b/book/cli/reth/db/snapshot.md index 11c3ea72a..761b66bc2 100644 --- a/book/cli/reth/db/snapshot.md +++ b/book/cli/reth/db/snapshot.md @@ -2,7 +2,7 @@ Snapshots tables from database -```text +```bash $ reth db snapshot --help Usage: reth db snapshot [OPTIONS] [SEGMENTS]... @@ -63,8 +63,13 @@ Options: -c, --compression Compression algorithms to use - [default: lz4] - [possible values: lz4, zstd, zstd-with-dictionary, uncompressed] + [default: uncompressed] + + Possible values: + - lz4: LZ4 compression algorithm + - zstd: Zstandard (Zstd) compression algorithm + - zstd-with-dictionary: Zstandard (Zstd) compression algorithm with a dictionary + - uncompressed: No compression, uncompressed snapshot --with-filters Flag to enable inclusion list filters and PHFs @@ -91,6 +96,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -106,11 +141,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db/stats.md b/book/cli/reth/db/stats.md index 2f104124d..411021b0a 100644 --- a/book/cli/reth/db/stats.md +++ b/book/cli/reth/db/stats.md @@ -2,7 +2,7 @@ Lists all the tables, their entry count and their size -```text +```bash $ reth db stats --help Usage: reth db stats [OPTIONS] @@ -42,6 +42,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -57,11 +87,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/db/version.md b/book/cli/reth/db/version.md index 8bc650740..d673f53f1 100644 --- a/book/cli/reth/db/version.md +++ b/book/cli/reth/db/version.md @@ -2,7 +2,7 @@ Lists current and local database versions -```text +```bash $ reth db version --help Usage: reth db version [OPTIONS] @@ -42,6 +42,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -57,11 +87,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/debug.md b/book/cli/reth/debug.md index 12dfaa032..5aca4e6ca 100644 --- a/book/cli/reth/debug.md +++ b/book/cli/reth/debug.md @@ -2,7 +2,7 @@ Various debug routines -```text +```bash $ reth debug --help Usage: reth debug [OPTIONS] @@ -11,6 +11,7 @@ Commands: merkle Debug the clean & incremental state root calculations in-memory-merkle Debug in-memory state root calculation build-block Debug block building + replay-engine Debug engine API by replaying stored messages help Print this message or the help of the given subcommand(s) Options: @@ -38,6 +39,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -53,11 +84,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/import.md b/book/cli/reth/import.md index 0c955f1f7..49abf1774 100644 --- a/book/cli/reth/import.md +++ b/book/cli/reth/import.md @@ -2,7 +2,7 @@ This syncs RLP encoded blocks from a file -```text +```bash $ reth import --help Usage: reth import [OPTIONS] @@ -65,6 +65,36 @@ Database: remaining stages are executed. Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -80,11 +110,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/init.md b/book/cli/reth/init.md index e057debcf..ee7453ccc 100644 --- a/book/cli/reth/init.md +++ b/book/cli/reth/init.md @@ -2,7 +2,7 @@ Initialize the database from a genesis file -```text +```bash $ reth init --help Usage: reth init [OPTIONS] @@ -57,55 +57,61 @@ Database: Logging: --log.stdout.format - The format to use for logs written to stdout. - + The format to use for logs written to stdout + [default: terminal] Possible values: - - json - - logfmt - - terminal + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs --log.stdout.filter - The filter to use for logs written to stdout. - + The filter to use for logs written to stdout + [default: info] + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in + [default: /logs] --log.file.max-size The maximum size (in MB) of one log file + [default: 200] --log.file.max-files The maximum amount of log files that will be stored. If set to 0, background file logging is disabled + [default: 5] - --log.file.filter - The filter to use for logs written to the log file - [default: debug] - - --log.file.format - The format to use for logs written to the log file. - - [default: Terminal] - - Possible values: - - json - - logfmt - - terminal - --log.journald Write logs to journald --log.journald.filter The filter to use for logs written to journald + [default: error] --color Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting + [default: always] Possible values: @@ -116,6 +122,7 @@ Logging: Display: -v, --verbosity... Set the minimum log level. + -v Errors -vv Warnings -vvv Info diff --git a/book/cli/reth/node.md b/book/cli/reth/node.md index fde742380..2f49c1590 100644 --- a/book/cli/reth/node.md +++ b/book/cli/reth/node.md @@ -2,20 +2,20 @@ Start the node -```text +```bash $ reth node --help Usage: reth node [OPTIONS] Options: --datadir The path to the data dir for all reth files and subdirectories. - + Defaults to the OS-specific data directory: - + - Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/` - Windows: `{FOLDERID_RoamingAppData}/reth/` - macOS: `$HOME/Library/Application Support/reth/` - + [default: default] --config @@ -24,21 +24,21 @@ Options: --chain The chain this node is running. Possible values are either a built-in chain or the path to a chain specification file. - + Built-in chains: mainnet, sepolia, goerli, holesky, dev - + [default: mainnet] --instance Add a new instance of a node. - + Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine. - + Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other. - + Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2 - + [default: 1] --trusted-setup-file @@ -50,7 +50,7 @@ Options: Metrics: --metrics Enable Prometheus metrics. - + The metrics will be served at the given interface and port. Networking: @@ -65,17 +65,17 @@ Networking: --discovery.addr The UDP address to use for P2P discovery/networking - + [default: 0.0.0.0] --discovery.port The UDP port to use for P2P discovery/networking - + [default: 30303] --trusted-peers Comma separated enode URLs of trusted peers for P2P connections. - + --trusted-peers enode://abcd@192.168.0.1:30303 --trusted-only @@ -83,7 +83,7 @@ Networking: --bootnodes Comma separated enode URLs for P2P discovery bootstrap. - + Will fall back to a network-specific default if not specified. --peers-file @@ -92,30 +92,30 @@ Networking: --identity Custom node identity - + [default: reth/-/] --p2p-secret-key Secret key to use for this node. - + This will also deterministically set the peer ID. If not specified, it will be set in the data dir for the chain being used. --no-persist-peers Do not persist peers. --nat - NAT resolution method (any|none|upnp|publicip|extip:) - + NAT resolution method (any|none|upnp|publicip|extip:\) + [default: any] --addr Network listening address - + [default: 0.0.0.0] --port Network listening port - + [default: 30303] --max-outbound-peers @@ -130,17 +130,17 @@ RPC: --http.addr Http server address to listen on - + [default: 127.0.0.1] --http.port Http server port to listen on - + [default: 8545] --http.api Rpc Modules to be configured for the HTTP server - + [possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots, eth-call-bundle] --http.corsdomain @@ -151,12 +151,12 @@ RPC: --ws.addr Ws server address to listen on - + [default: 127.0.0.1] --ws.port Ws server port to listen on - + [default: 8546] --ws.origins @@ -164,7 +164,7 @@ RPC: --ws.api Rpc Modules to be configured for the WS server - + [possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots, eth-call-bundle] --ipcdisable @@ -172,193 +172,196 @@ RPC: --ipcpath Filename for IPC socket/pipe within the datadir - + [default: .ipc] --authrpc.addr Auth server address to listen on - + [default: 127.0.0.1] --authrpc.port Auth server port to listen on - + [default: 8551] --authrpc.jwtsecret Path to a JWT secret to use for the authenticated engine-API RPC server. - + This will enforce JWT authentication for all requests coming from the consensus layer. - + If no path is provided, a secret will be generated and stored in the datadir under `//jwt.hex`. For mainnet this would be `~/.reth/mainnet/jwt.hex` by default. --rpc.jwtsecret Hex encoded JWT secret to authenticate the regular RPC server(s), see `--http.api` and `--ws.api`. - + This is __not__ used for the authenticated engine-API RPC server, see `--authrpc.jwtsecret`. --rpc-max-request-size Set the maximum RPC request payload size for both HTTP and WS in megabytes - + [default: 15] --rpc-max-response-size Set the maximum RPC response payload size for both HTTP and WS in megabytes - + [default: 150] [aliases: --rpc.returndata.limit] --rpc-max-subscriptions-per-connection Set the the maximum concurrent subscriptions per connection - + [default: 1024] --rpc-max-connections Maximum number of RPC server connections - + [default: 500] --rpc-max-tracing-requests Maximum number of concurrent tracing requests - + [default: 25] --rpc-max-blocks-per-filter Maximum number of blocks that could be scanned per filter request. (0 = entire chain) - + [default: 100000] --rpc-max-logs-per-response Maximum number of logs that can be returned in a single response. (0 = no limit) - + [default: 20000] --rpc-gas-cap Maximum gas limit for `eth_call` and call tracing RPC methods - + [default: 50000000] RPC State Cache: --rpc-cache.max-blocks Max number of blocks in cache - + [default: 5000] --rpc-cache.max-receipts Max number receipts in cache - + [default: 2000] --rpc-cache.max-envs Max number of bytes for cached env data - + [default: 1000] --rpc-cache.max-concurrent-db-requests Max number of concurrent database requests - + [default: 512] Gas Price Oracle: --gpo.blocks Number of recent blocks to check for gas price - + [default: 20] --gpo.ignoreprice Gas Price below which gpo will ignore transactions - + [default: 2] --gpo.maxprice Maximum transaction priority fee(or gasprice before London Fork) to be recommended by gpo - + [default: 500000000000] --gpo.percentile The percentile of gas prices to use for the estimate - + [default: 60] TxPool: --txpool.pending_max_count Max number of transaction in the pending sub-pool - + [default: 10000] --txpool.pending_max_size Max size of the pending sub-pool in megabytes - + [default: 20] --txpool.basefee_max_count Max number of transaction in the basefee sub-pool - + [default: 10000] --txpool.basefee_max_size Max size of the basefee sub-pool in megabytes - + [default: 20] --txpool.queued_max_count Max number of transaction in the queued sub-pool - + [default: 10000] --txpool.queued_max_size Max size of the queued sub-pool in megabytes - + [default: 20] --txpool.max_account_slots Max number of executable transaction slots guaranteed per account - + [default: 16] --txpool.pricebump Price bump (in %) for the transaction pool underpriced check - + [default: 10] --blobpool.pricebump Price bump percentage to replace an already existing blob transaction - + [default: 100] --txpool.nolocals Flag to disable local transaction exemptions + --txpool.locals + Flag to allow certain addresses as local + Builder: --builder.extradata Block extra data set by the payload builder - + [default: reth//] --builder.gaslimit Target gas ceiling for built blocks - + [default: 30000000] --builder.interval The interval at which the job should build a new payload after the last (in seconds) - + [default: 1] --builder.deadline The deadline for when the payload builder job should resolve - + [default: 12] --builder.max-tasks Maximum number of tasks to spawn for building a payload - + [default: 3] Debug: --debug.continuous Prompt the downloader to download blocks one at a time. - + NOTE: This is for testing purposes only. --debug.terminate @@ -366,7 +369,7 @@ Debug: --debug.tip Set the chain tip manually for testing purposes. - + NOTE: This is a temporary flag --debug.max-block @@ -384,6 +387,9 @@ Debug: --debug.hook-all Hook on every transaction in a block + --debug.engine-api-store + The path to store engine API messages at. If specified, all of the intercepted engine API messages will be written to specified location + Database: --db.log-level Database logging level. Levels higher than "notice" require a debug build @@ -401,7 +407,7 @@ Database: Dev testnet: --dev Start the node in dev mode - + This mode uses a local proof-of-authority consensus engine with either fixed block times or automatically mined blocks. Disables network discovery and enables local http server. @@ -413,7 +419,7 @@ Dev testnet: --dev.block-time Interval between blocks. - + Parses strings using [humantime::parse_duration] --dev.block-time 12s @@ -422,37 +428,62 @@ Pruning: Run full node. Only the most recent [`MINIMUM_PRUNING_DISTANCE`] block states are stored. This flag takes priority over pruning configuration in reth.toml Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in - + [default: /logs] --log.file.max-size The maximum size (in MB) of one log file - + [default: 200] --log.file.max-files The maximum amount of log files that will be stored. If set to 0, background file logging is disabled - + [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald --log.journald.filter The filter to use for logs written to journald - + [default: error] --color Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting - + [default: always] Possible values: @@ -463,7 +494,7 @@ Logging: Display: -v, --verbosity... Set the minimum log level. - + -v Errors -vv Warnings -vvv Info @@ -472,4 +503,4 @@ Display: -q, --quiet Silence all log output -``` +``` \ No newline at end of file diff --git a/book/cli/reth/p2p.md b/book/cli/reth/p2p.md index 1047dc6ef..edc80ebbb 100644 --- a/book/cli/reth/p2p.md +++ b/book/cli/reth/p2p.md @@ -2,7 +2,7 @@ P2P Debugging utilities -```text +```bash $ reth p2p --help Usage: reth p2p [OPTIONS] @@ -102,6 +102,36 @@ Database: - extra: Enables logging for extra debug-level messages Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -117,11 +147,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/p2p/body.md b/book/cli/reth/p2p/body.md index 15b07f26e..5ef001c34 100644 --- a/book/cli/reth/p2p/body.md +++ b/book/cli/reth/p2p/body.md @@ -2,7 +2,7 @@ Download block body -```text +```bash $ reth p2p body --help Usage: reth p2p body [OPTIONS] @@ -26,6 +26,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -41,11 +71,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/p2p/header.md b/book/cli/reth/p2p/header.md index fdadb6c7a..50f210189 100644 --- a/book/cli/reth/p2p/header.md +++ b/book/cli/reth/p2p/header.md @@ -2,7 +2,7 @@ Download block header -```text +```bash $ reth p2p header --help Usage: reth p2p header [OPTIONS] @@ -26,6 +26,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -41,11 +71,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/recover.md b/book/cli/reth/recover.md index cb39a6a3e..aa077c75c 100644 --- a/book/cli/reth/recover.md +++ b/book/cli/reth/recover.md @@ -2,7 +2,7 @@ Scripts for node recovery -```text +```bash $ reth recover --help Usage: reth recover [OPTIONS] @@ -35,6 +35,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -50,11 +80,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/recover/storage-tries.md b/book/cli/reth/recover/storage-tries.md index 7ac2beb09..91322f6c5 100644 --- a/book/cli/reth/recover/storage-tries.md +++ b/book/cli/reth/recover/storage-tries.md @@ -2,7 +2,7 @@ Recover the node by deleting dangling storage tries -```text +```bash $ reth recover storage-tries --help Usage: reth recover storage-tries [OPTIONS] @@ -42,6 +42,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -57,11 +87,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage.md b/book/cli/reth/stage.md index ad022a1af..7c8faf3e6 100644 --- a/book/cli/reth/stage.md +++ b/book/cli/reth/stage.md @@ -2,7 +2,7 @@ Manipulate individual stages -```text +```bash $ reth stage --help Usage: reth stage [OPTIONS] @@ -38,6 +38,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -53,11 +83,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/drop.md b/book/cli/reth/stage/drop.md index 01ee7c04d..299e49a3a 100644 --- a/book/cli/reth/stage/drop.md +++ b/book/cli/reth/stage/drop.md @@ -2,7 +2,7 @@ Drop a stage's tables from the database -```text +```bash $ reth stage drop --help Usage: reth stage drop [OPTIONS] @@ -56,9 +56,51 @@ Database: - extra: Enables logging for extra debug-level messages - [possible values: headers, bodies, senders, execution, account-hashing, storage-hashing, hashing, merkle, tx-lookup, account-history, storage-history, total-difficulty] + Possible values: + - headers: The headers stage within the pipeline + - bodies: The bodies stage within the pipeline + - senders: The senders stage within the pipeline + - execution: The execution stage within the pipeline + - account-hashing: The account hashing stage within the pipeline + - storage-hashing: The storage hashing stage within the pipeline + - hashing: The hashing stage within the pipeline + - merkle: The Merkle stage within the pipeline + - tx-lookup: The transaction lookup stage within the pipeline + - account-history: The account history stage within the pipeline + - storage-history: The storage history stage within the pipeline + - total-difficulty: The total difficulty stage within the pipeline Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -74,11 +116,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/dump.md b/book/cli/reth/stage/dump.md index b1d84dd62..f7887cf69 100644 --- a/book/cli/reth/stage/dump.md +++ b/book/cli/reth/stage/dump.md @@ -2,7 +2,7 @@ Dumps a stage from a range into a new database -```text +```bash $ reth stage dump --help Usage: reth stage dump [OPTIONS] @@ -63,6 +63,36 @@ Database: - extra: Enables logging for extra debug-level messages Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -78,11 +108,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/dump/account-hashing.md b/book/cli/reth/stage/dump/account-hashing.md index 79757d4e5..78a7cd412 100644 --- a/book/cli/reth/stage/dump/account-hashing.md +++ b/book/cli/reth/stage/dump/account-hashing.md @@ -2,7 +2,7 @@ AccountHashing stage -```text +```bash $ reth stage dump account-hashing --help Usage: reth stage dump account-hashing [OPTIONS] --output-db --from --to @@ -34,6 +34,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -49,11 +79,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/dump/execution.md b/book/cli/reth/stage/dump/execution.md index e02306570..4de5af8f8 100644 --- a/book/cli/reth/stage/dump/execution.md +++ b/book/cli/reth/stage/dump/execution.md @@ -2,7 +2,7 @@ Execution stage -```text +```bash $ reth stage dump execution --help Usage: reth stage dump execution [OPTIONS] --output-db --from --to @@ -34,6 +34,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -49,11 +79,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/dump/merkle.md b/book/cli/reth/stage/dump/merkle.md index 93a01d16a..5d595a2ca 100644 --- a/book/cli/reth/stage/dump/merkle.md +++ b/book/cli/reth/stage/dump/merkle.md @@ -2,7 +2,7 @@ Merkle stage -```text +```bash $ reth stage dump merkle --help Usage: reth stage dump merkle [OPTIONS] --output-db --from --to @@ -34,6 +34,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -49,11 +79,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/dump/storage-hashing.md b/book/cli/reth/stage/dump/storage-hashing.md index 5e836213a..5a36b733b 100644 --- a/book/cli/reth/stage/dump/storage-hashing.md +++ b/book/cli/reth/stage/dump/storage-hashing.md @@ -2,7 +2,7 @@ StorageHashing stage -```text +```bash $ reth stage dump storage-hashing --help Usage: reth stage dump storage-hashing [OPTIONS] --output-db --from --to @@ -34,6 +34,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -49,11 +79,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/run.md b/book/cli/reth/stage/run.md index e6c1bf28d..a4a6dd59c 100644 --- a/book/cli/reth/stage/run.md +++ b/book/cli/reth/stage/run.md @@ -2,15 +2,27 @@ Run a single stage. -```text +```bash $ reth stage run --help Usage: reth stage run [OPTIONS] --from --to Arguments: The name of the stage to run - - [possible values: headers, bodies, senders, execution, account-hashing, storage-hashing, hashing, merkle, tx-lookup, account-history, storage-history, total-difficulty] + + Possible values: + - headers: The headers stage within the pipeline + - bodies: The bodies stage within the pipeline + - senders: The senders stage within the pipeline + - execution: The execution stage within the pipeline + - account-hashing: The account hashing stage within the pipeline + - storage-hashing: The storage hashing stage within the pipeline + - hashing: The hashing stage within the pipeline + - merkle: The Merkle stage within the pipeline + - tx-lookup: The transaction lookup stage within the pipeline + - account-history: The account history stage within the pipeline + - storage-history: The storage history stage within the pipeline + - total-difficulty: The total difficulty stage within the pipeline Options: --config @@ -120,7 +132,7 @@ Networking: Do not persist peers. --nat - NAT resolution method (any|none|upnp|publicip|extip:) + NAT resolution method (any|none|upnp|publicip|extip:\) [default: any] @@ -160,6 +172,36 @@ Database: Useful when you want to run diagnostics on the database. Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -175,11 +217,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/unwind.md b/book/cli/reth/stage/unwind.md index 506d35761..af06b85d0 100644 --- a/book/cli/reth/stage/unwind.md +++ b/book/cli/reth/stage/unwind.md @@ -2,7 +2,7 @@ Unwinds a certain block range, deleting it from the database -```text +```bash $ reth stage unwind --help Usage: reth stage unwind [OPTIONS] @@ -61,6 +61,36 @@ Database: - extra: Enables logging for extra debug-level messages Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -76,11 +106,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/unwind/num-blocks.md b/book/cli/reth/stage/unwind/num-blocks.md index ce3705df7..6daecb5e0 100644 --- a/book/cli/reth/stage/unwind/num-blocks.md +++ b/book/cli/reth/stage/unwind/num-blocks.md @@ -2,7 +2,7 @@ Unwinds the given number of blocks from the database -```text +```bash $ reth stage unwind num-blocks --help Usage: reth stage unwind num-blocks [OPTIONS] @@ -46,6 +46,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -61,11 +91,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/stage/unwind/to-block.md b/book/cli/reth/stage/unwind/to-block.md index bd3a85dc5..bee3b555a 100644 --- a/book/cli/reth/stage/unwind/to-block.md +++ b/book/cli/reth/stage/unwind/to-block.md @@ -2,7 +2,7 @@ Unwinds the database until the given block number (range is inclusive) -```text +```bash $ reth stage unwind to-block --help Usage: reth stage unwind to-block [OPTIONS] @@ -46,6 +46,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -61,11 +91,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/test-vectors.md b/book/cli/reth/test-vectors.md index b27a6c73e..061e6ee84 100644 --- a/book/cli/reth/test-vectors.md +++ b/book/cli/reth/test-vectors.md @@ -2,7 +2,7 @@ Generate Test Vectors -```text +```bash $ reth test-vectors --help Usage: reth test-vectors [OPTIONS] @@ -35,6 +35,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -50,11 +80,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald diff --git a/book/cli/reth/test-vectors/tables.md b/book/cli/reth/test-vectors/tables.md index 47c89a802..f752e8e23 100644 --- a/book/cli/reth/test-vectors/tables.md +++ b/book/cli/reth/test-vectors/tables.md @@ -2,7 +2,7 @@ Generates test vectors for specified tables. If no table is specified, generate for all -```text +```bash $ reth test-vectors tables --help Usage: reth test-vectors tables [OPTIONS] [NAMES]... @@ -35,6 +35,36 @@ Options: Print help (see a summary with '-h') Logging: + --log.stdout.format + The format to use for logs written to stdout + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.stdout.filter + The filter to use for logs written to stdout + + [default: info] + + --log.file.format + The format to use for logs written to the log file + + [default: terminal] + + Possible values: + - json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging + - log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications + - terminal: Represents terminal-friendly formatting for logs + + --log.file.filter + The filter to use for logs written to the log file + + [default: debug] + --log.file.directory The path to put log files in @@ -50,11 +80,6 @@ Logging: [default: 5] - --log.file.filter - The filter to use for logs written to the log file - - [default: debug] - --log.journald Write logs to journald