Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Trace - Extremely detailed view showing the execution flow. Likely only useful to developers
  • Debug - Information that is diagnostically helpful to a wider group than just developers (for example, sysadmins)
  • Info - Generally useful information to log (for example, service start/stop, configuration assumptions). Default logging level
  • Warn - Anything that can potentially cause application oddities but from which Besu automatically recovers
  • Error - Any error which is fatal to the operation, but not Besu itself (for example, missing data)
  • Fatal - An error that forces a shutdown of Besu

DEBUG Principles

  •  Aimed at both end users and developers
  •  Should lead to resolution of common problems, whilst not spamming
  •  Should not contain logs that take up more than one terminal screen, e.g. raw data, including RLP

DEBUG Guidelines

  • Should not include peer discovery
  • Should not include txpool management
  • Could include some peering to debug peering issues
  • Could include some high level syncing logs
  • Could include API requests, including potentially truncated data, but not full RLP

TRACE Principles

  • Aimed at developers
  • Expectation is everything is there and it's spammy
  • Only useful when targeting certain packages/classes