Skip to content

Clarify that --silent suppresses console logging for the entire run, not just startup - #3721

Open
pete-csyn wants to merge 1 commit into
XRPLF:masterfrom
pete-csyn:docs/clarify-silent-logging
Open

Clarify that --silent suppresses console logging for the entire run, not just startup#3721
pete-csyn wants to merge 1 commit into
XRPLF:masterfrom
pete-csyn:docs/clarify-silent-logging

Conversation

@pete-csyn

Copy link
Copy Markdown

Summary

The --silent option for xrpld (formerly rippled) is currently documented as suppressing standard-output/standard-error logging "during startup." In practice the flag suppresses console logging for the entire run of the process — only the pre---silent startup banner is still printed. This is easy to trip over when running xrpld under a process supervisor or in a container, where the operator expects ongoing logs on the container log driver but sees only the startup banner.

This PR:

  1. Corrects the --silent description in the Verbosity Options table on the Commandline Usage page to say it suppresses console logging for the whole run, not only startup.
  2. Adds a short note to the "Check the server log" section of Diagnosing Problems explaining how to surface logs in a container/supervisor: either run xrpld in the foreground without --silent, or set [debug_logfile] to /dev/stdout (the file sink keeps flowing even with --silent).

Why

xrpld has a single console log sink (standard error). --silent disables that sink for the lifetime of the process, so any stdout/stderr-based log capture (e.g. a container log driver) receives nothing after the banner. The file sink configured by [debug_logfile] is independent of --silent, so pointing it at /dev/stdout restores log visibility.

Test Plan

Documentation-only change. Verified the cross-page anchor (#check-the-server-log) resolves to the existing heading on the Diagnosing Problems page, and that the {% admonition %} syntax matches existing usage in both edited files.

…not just startup

xrpld has a single console log sink (stderr). --silent disables it for the
lifetime of the process, so any stdout/stderr-based log capture (e.g. a
container log driver) receives nothing after the startup banner. The file
sink configured by [debug_logfile] is independent of --silent, so pointing
it at /dev/stdout restores log visibility.

- commandline-usage: correct the --silent description (entire run, not only startup)
- diagnosing-problems: add a container/supervisor logging note and drop the
  inaccurate "during startup" qualifier from the --silent link text
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