Logging

Apache Druid services emit logs that to help you debug. The same services also emit periodic metrics about their state. To disable metric info logs set the following runtime property: -Ddruid.emitter.logging.logLevel=debug.

Druid uses log4j2 for logging. The default configuration file log4j2.xml ships with Druid at the following path: conf/druid/{config}/_common/log4j2.xml.

By default, Druid uses RollingRandomAccessFile for rollover daily, and keeps log files up to 7 days. If that’s not suitable in your case, modify the log4j2.xml accordingly.

The following example log4j2.xml is based upon the micro quickstart:

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <Configuration status="WARN">
  3.   <Properties>
  4.     <!-- to change log directory, set DRUID_LOG_DIR environment variable to your directory before launching Druid -->
  5.     <Property name="druid.log.path" value="log" />
  6.   </Properties>
  8.   <Appenders>
  9.     <Console name="Console" target="SYSTEM_OUT">
  10.       <PatternLayout pattern="%d{ISO8601} %p [%t] %c - %m%n"/>
  11.     </Console>
  13.     <!-- Rolling Files-->
  14.     <RollingRandomAccessFile name="FileAppender"
  15.                              fileName="${sys:druid.log.path}/${sys:druid.node.type}.log"
  16.                              filePattern="${sys:druid.log.path}/${sys:druid.node.type}.%d{yyyyMMdd}.log">
  17.       <PatternLayout pattern="%d{ISO8601} %p [%t] %c - %m%n"/>
  18.       <Policies>
  19.         <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
  20.       </Policies>
  21.       <DefaultRolloverStrategy>
  22.         <Delete basePath="${sys:druid.log.path}/" maxDepth="1">
  23.           <IfFileName glob="*.log" />
  24.           <IfLastModified age="7d" />
  25.         </Delete>
  26.       </DefaultRolloverStrategy>
  27.     </RollingRandomAccessFile>
  29.   </Appenders>
  31.   <Loggers>
  32.     <Root level="info">
  33.       <AppenderRef ref="FileAppender"/>
  34.     </Root>
  36.     <!-- Set level="debug" to see stack traces for query errors -->
  37.     <Logger name="org.apache.druid.server.QueryResource" level="info" additivity="false">
  38.       <Appender-ref ref="FileAppender"/>
  39.     </Logger>
  40.     <Logger name="org.apache.druid.server.QueryLifecycle" level="info" additivity="false">
  41.       <Appender-ref ref="FileAppender"/>
  42.     </Logger>
  44.     <!-- Set level="debug" or "trace" to see more Coordinator details (segment balancing, load/drop rules, etc) -->
  45.     <Logger name="org.apache.druid.server.coordinator" level="info" additivity="false">
  46.       <Appender-ref ref="FileAppender"/>
  47.     </Logger>
  49.     <!-- Set level="debug" to see low-level details about segments and ingestion -->
  50.     <Logger name="org.apache.druid.segment" level="info" additivity="false">
  51.       <Appender-ref ref="FileAppender"/>
  52.     </Logger>
  54.     <!-- Set level="debug" to see more information about extension initialization -->
  55.     <Logger name="org.apache.druid.initialization" level="info" additivity="false">
  56.       <Appender-ref ref="FileAppender"/>
  57.     </Logger>
  59.     <!-- Quieter logging at startup -->
  60.     <Logger name="org.skife.config" level="warn" additivity="false">
  61.       <Appender-ref ref="FileAppender"/>
  62.     </Logger>
  63.     <Logger name="com.sun.jersey.guice" level="warn" additivity="false">
  64.       <Appender-ref ref="FileAppender"/>
  65.     </Logger>
  66.   </Loggers>
  67. </Configuration>

NOTE: Although Druid shares the log4j configuration file task peon processes, the appenders in this file DO NOT take effect for peon processes. Peons always output logs to standard output. Middle Managers redirect task logs from standard output to long-term storage.

However, log level settings do take effect for these task peon processes. This means you can configure loggers at different logging level for task logs using log4j2.xml.

Log directory

The included log4j2.xml configuration for Druid and ZooKeeper writes logs to the log directory at the root of the distribution.

If you want to change the log directory, set the environment variable DRUID_LOG_DIR to the right directory before you start Druid.

All-in-one start commands

If you use one of the all-in-one start commands, such as bin/start-micro-quickstart, the default configuration for each service has two kinds of log files. Log4j2 writes the main log file and rotates it periodically. For example, log/historical.log.

The secondary log file contains anything that is written by the component directly to standard output or standard error without going through log4j2. For example, log/historical.stdout.log. This consists mainly of messages from the Java runtime itself. This file is not rotated, but it is generally small due to the low volume of messages. If necessary, you can truncate it using the Linux command truncate --size 0 log/historical.stdout.log.

Avoid reflective access warnings in logs

On Java 11, you may see warnings like the following in the logs:

  1. WARNING: An illegal reflective access operation has occurred
  2. WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
  3. WARNING: All illegal access operations will be denied in a future release

To avoid these, add the --add-exports and --add-opens command line parameters described in the documentation section about Java strong encapsulation.

Set the logs to asynchronously write

If your logs are really chatty, you can set them to write asynchronously. The following example shows a log4j2.xml that configures some of the more chatty classes to write asynchronously:

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <Configuration status="WARN">
  3.   <Appenders>
  4.     <Console name="Console" target="SYSTEM_OUT">
  5.       <PatternLayout pattern="%d{ISO8601} %p [%t] %c - %m%n"/>
  6.     </Console>
  7.   </Appenders>
  9. <Loggers>
  10.     <!-- AsyncLogger instead of Logger -->
  11.     <AsyncLogger name="org.apache.druid.curator.inventory.CuratorInventoryManager" level="debug" additivity="false">
  12.       <AppenderRef ref="Console"/>
  13.     </AsyncLogger>
  14.     <AsyncLogger name="org.apache.druid.client.BatchServerInventoryView" level="debug" additivity="false">
  15.       <AppenderRef ref="Console"/>
  16.     </AsyncLogger>
  17.     <!-- Make extra sure nobody adds logs in a bad way that can hurt performance -->
  18.     <AsyncLogger name="org.apache.druid.client.ServerInventoryView" level="debug" additivity="false">
  19.       <AppenderRef ref="Console"/>
  20.     </AsyncLogger>
  21.     <AsyncLogger name ="org.apache.druid.java.util.http.client.pool.ChannelResourceFactory" level="info" additivity="false">
  22.       <AppenderRef ref="Console"/>
  23.     </AsyncLogger>
  24.     <Root level="info">
  25.       <AppenderRef ref="Console"/>
  26.     </Root>
  27.   </Loggers>
  28. </Configuration>