Skip to content

cfg: document /dev/stdout for [debug_logfile] and its interaction with --silent#7579

Open
pete-csyn wants to merge 1 commit into
XRPLF:developfrom
pete-csyn:docs/debug-logfile-stdout-container
Open

cfg: document /dev/stdout for [debug_logfile] and its interaction with --silent#7579
pete-csyn wants to merge 1 commit into
XRPLF:developfrom
pete-csyn:docs/debug-logfile-stdout-container

Conversation

@pete-csyn

Copy link
Copy Markdown

High Level Overview of Change

Adds a short comment to the [debug_logfile] stanza in cfg/xrpld-example.cfg explaining that, in a container, the debug log file can be set to /dev/stdout (or /proc/1/fd/1) to route logs to the container log driver, and that when --silent is used the file sink is the only sink that keeps receiving ongoing logs.

Context of Change

xrpld has two log sinks: the console (stderr) and the optional [debug_logfile] file sink. The --silent flag disables the console sink for the entire run of the process, so under a process supervisor or in a container that captures stdout/stderr, no ongoing logs are emitted after the startup banner. The file sink is independent of --silent, so pointing [debug_logfile] at /dev/stdout restores log visibility to the container log driver. The example config did not mention either the container pattern or the --silent interaction; this comment closes that gap for operators reading the example config.

This is a comments-only change to the example config; no behavior changes.

Type of Change

  • Documentation update

API Impact

  • Public API: New feature (new methods and/or new fields)
  • Public API: Breaking change
  • libxrpl change
  • Peer protocol change

None — documentation/comment change to the example config only.

…h --silent

xrpld has two log sinks: the console (stderr) and the optional [debug_logfile]
file sink. --silent disables the console sink for the entire run, so under a
process supervisor or in a container that captures stdout/stderr, no ongoing
logs are emitted after the startup banner. The file sink is independent of
--silent, so pointing [debug_logfile] at /dev/stdout restores log visibility
to the container log driver. The example config did not mention either the
container pattern or the --silent interaction; this comment closes that gap.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant