Skip to content

docs: document logging configuration and fix dev-server white screen - #313

Merged
KKRainbow merged 3 commits into
mainfrom
docs/logging-settings
Aug 18, 2026
Merged

docs: document logging configuration and fix dev-server white screen#313
KKRainbow merged 3 commits into
mainfrom
docs/logging-settings

Conversation

@KKRainbow

Copy link
Copy Markdown
Member

Adds previously-missing documentation for logging configuration (fixes #2498) and a couple of related fixes to the doc site.

  • docs: expand logging settings section in configurations — the page only listed the logging flags as a table without any explanation. Adds usage details: default behavior, --console-log-level / ET_CONSOLE_LOG_LEVEL, RUST_LOG per-target filters, enabling file logging with a non-off --file-log-level plus the optional --file-log-dir/--file-log-size/--file-log-count knobs, runtime adjustment via easytier-cli logger, and why logging is a process-level option that cannot go in the -c config file. Both zh and en.
  • fix: dev-server white screen — vite dev serves node_modules sources as-is unless prebundled; mermaid's named import from the pure-CJS @braintree/sanitize-url then fails in the browser and blanks the whole page. Add optimizeDeps.include: ['mermaid'] so the dev server prebundles it (rollup build was already fine).
  • docs(configurations): flatten section structure — the single h2 "Basic Settings" wrapped every parameter group as h3, so the on-page outline only showed one entry. Promote each group to its own h2 and enable outline: deep so the logging sub-topics also appear. Both zh and en.

The configuration page only listed the logging flags as a table without any
explanation. Add usage details covering:

- default behavior (console prints core info only, file logging off)
- setting the console level via --console-log-level / ET_CONSOLE_LOG_LEVEL
  and the RUST_LOG per-target filter syntax
- enabling file logging with --file-log-level (non-off), the optional
  --file-log-dir / --file-log-size / --file-log-count knobs and daily
  rotation
- adjusting the file log level at runtime with easytier-cli logger set/get
- why logging options are process-level and cannot be put in the -c config
  file

Applies to both the Chinese and English versions.
In dev mode vite serves node_modules sources as-is unless they are
prebundled. mermaid 11 imports { sanitizeUrl } from the pure-CJS
@braintree/sanitize-url package, which fails to load natively in the
browser and crashes the whole page (white screen). Build output is
unaffected because rollup converts the CJS dependency during bundling.

Add vite.optimizeDeps.include for mermaid so the dev server prebundles
it and its CJS dependencies with esbuild.
…groups

The page had a single h2 (Basic Settings) wrapping every parameter group
as h3, so the on-page outline only listed that one entry. Promote each
parameter group (configuration server, network, RPC, listener, other,
logging) to its own h2 and enable outline: deep so the logging sub-topics
also appear. Applies to both the Chinese and English pages.
@vercel

vercel Bot commented Aug 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
doc Building Building Preview Aug 18, 2026 1:24pm

@KKRainbow
KKRainbow merged commit c0660fe into main Aug 18, 2026
2 of 3 checks passed
@KKRainbow
KKRainbow deleted the docs/logging-settings branch August 18, 2026 13:24
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