Log customization

Table of contents

• Overview
• Default logging configuration
• Customize logging level and pattern
  • Logging level
• Logging pattern
• Enable detailed logs

Overview

CloudBeaver uses logback.xml to configure server logging. This file controls log level and log message pattern.

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:

1. Create and save your custom logback.xml file on your server.
2. Mount your custom directory to the container's /opt/cloudbeaver/conf/custom folder.
3. Restart CloudBeaver to apply your new logging configuration.

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:

<root level="WARN">
  <appender-ref ref="CONSOLE"/>
</root>

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):

<Pattern>
    %d{HH:mm:ss} [%t] %-5level - %msg%n
</Pattern>

Enable detailed logs

To enable detailed logging:

1. As administrator, go to Settings -> Administration -> Global preferences.
2. Go to Server configuration > Logger.
3. Turn on Enable detailed logging.
4. Save your changes.

Detailed logs include:

• Session ID and User ID.
• User creation, modification, and logout.
• Resource Manager activity.
• S3/cloud storage actions.
• All GraphQL and administration API parameters.

Passwords, private keys, credentials, and tokens are never logged.