Log customization
CloudBeaver uses logback.xml
to configure server logging. This file controls log level and log message pattern.
Info
For details on viewing logs directly in the CloudBeaver, see Log Viewer.
Default logging configuration¶
CloudBeaver's default logback.xml
:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<Pattern>
%d{dd-MM-yyyy HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n
</Pattern>
</layout>
</appender>
<statusListener class="ch.qos.logback.core.status.NopStatusListener"/>
<logger name="org.jkiss" level="DEBUG"/>
<logger name="com.dbeaver" level="DEBUG"/>
<logger name="io.cloudbeaver" level="DEBUG"/>
<logger name="org.apache.kafka" level="WARN"/>
<root level="INFO">
<appender-ref ref="CONSOLE"/>
</root>
</configuration>
Customize logging level and pattern¶
Customize CloudBeaver logging by creating a custom logback.xml
file:
- Create and save your custom
logback.xml
file on your server. - Mount your custom directory to the container's
/opt/cloudbeaver/conf/custom
folder. - Restart CloudBeaver to apply your new logging configuration.
Info
For mounting details, see Docker volumes documentation.
Logging level¶
Set the logging level in the <root>
element's level
attribute:
ERROR
: logs errors only.WARN
: logs warnings and errors.INFO
: standard logs (recommended for everyday use).DEBUG
: detailed debugging info.TRACE
: maximum verbosity for troubleshooting.
Example:
Info
To enable detailed logging of GraphQL queries, turn it on in Global preferences.
Logging pattern¶
Define custom log message pattern in the <Pattern>
element.
Example (time only):
Customize logging in Preferences¶
In addition to editing logback.xml
, you can configure logging directly in the CloudBeaver preferences. These
options let you:
- save all API requests in the Query Manager database
- choose how many days to keep logs
- log GraphQL requests to console
For details, see Preferences - Logger settings.