Skip to main content

Use logging

Hyperledger Besu uses Log4j 2 for logging and provides two methods to configure logging behavior:

  • Basic - Changes the log level.
  • Advanced - Configures the output and format of the logs.

Quorum Developer Quickstart provides an example implementation using Elastic Stack for log management.

Basic logging​

Use the --logging command line option to specify logging verbosity. The --logging option changes the volume of events displayed in the log. Valid log levels are OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL. The default level is INFO.

For most use cases, the basic method provides enough configurability.

tip

Use the admin_changeLogLevel API method to change the log level while Besu is running.

Advanced logging​

You can provide your own logging configuration using the standard Log4j 2 configuration mechanisms. For example, the following Log4j 2 configuration is the same as the default configuration except for the exclusion of logging of stack traces for exceptions:

debug.xml
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO">
  <Properties>
    <Property name="root.log.level">INFO</Property>
  </Properties>

  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSSZZZ} | %t | %-5level | %c{1} | %msg %throwable{short.message}%n" />
    </Console>
  </Appenders>
  <Loggers>
    <Root level="${sys:root.log.level}">
      <AppenderRef ref="Console" />
    </Root>
  </Loggers>
</Configuration>

To use your custom configuration, set the environment variable LOG4J_CONFIGURATION_FILE to the location of your configuration file.

If you have more specific requirements, you can create your own Log4j 2 configuration.

For Bash-based executions, you can set the variable for only the scope of the program execution by setting it before starting Besu.

To set the debug logging and start Besu connected to the Holesky testnet:

LOG4J_CONFIGURATION_FILE=./debug.xml besu --network=holesky

Log invalid transactions​

You can log information about invalid transactions that have been removed from the transaction pool.

Use the log marker INVALID_TX_REMOVED and the following fields to format the log line as required:

  • txhash - The hash of the transaction.
  • txlog - The human-readable log of the transaction.
  • reason - The reason the transaction is invalid.
  • txrlp - The RLP encoding of the transaction.

For example, the following Log4j 2 configuration enables logging of invalid transactions:

debug.xml
<?xml version="1.0" encoding="UTF-8"?>
<Configuration monitorInterval="30" status="INFO">
  <Properties>
    <Property name="root.log.level">INFO</Property>
  </Properties>
  <Appenders>
    <Console name="Console">
      <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSSZZZ} | %t | %-5level | %c{1} | %msg%n"/>
    </Console>
    <Routing name="Router">
      <Routes pattern="$${event:Marker}">
        <Route key="INVALID_TX_REMOVED">
          <Console name="ConsoleITR" target="SYSTEM_OUT">
            <PatternLayout pattern="Invalid tx removed:%X{txlog}, reason:%X{reason}; RLP={%X{txrlp}}}%n"/>
          </Console>
        </Route>
        <Route ref="Console"/>
      </Routes>
    </Routing>
  </Appenders>
  <Loggers>
        <Logger additivity="false" name="org.hyperledger.besu.ethereum.eth.transactions">
            <AppenderRef ref="Router"/>
        </Logger>
    <Root level="${sys:root.log.level}">
      <AppenderRef ref="Console"/>
    </Root>
  </Loggers>
</Configuration>

Log rotation​

The Quorum Developer Quickstart logging configuration defines a log rotation to restrict the size of the log files.