Skip to content

config: improve logback configuration with async appenders and env-based properties #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vLuckyyy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

config: improve logback configuration with async appenders and env-based properties #247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 53 additions & 12 deletions src/main/resources/logback.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,67 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>

<contextName>DiscordOfficer</contextName>

<property name="APP_NAME" value="${APP_NAME:-discord-officer}" />
<property name="LOG_DIR" value="${LOG_DIR:-logs}" />
<property name="ROOT_LOG_LEVEL" value="${ROOT_LOG_LEVEL:-INFO}" />
<property name="JDA_LOG_LEVEL" value="${JDA_LOG_LEVEL:-INFO}" />
<property name="JDA_INTERNAL_LOG_LEVEL" value="${JDA_INTERNAL_LOG_LEVEL:-WARN}" />

<property name="CONSOLE_PATTERN"
value="%blue(╭ %d{HH:mm:ss.SSS}) %magenta(${APP_NAME}) %white(| %thread |) %highlight(%-5level) %cyan(%-40.40logger{40}) %white(→) %msg%n%ex" />
<property name="FILE_PATTERN"
value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] ${APP_NAME} %logger{50} - %msg%n%ex" />

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<charset>UTF-8</charset>
<pattern>${CONSOLE_PATTERN}</pattern>
</encoder>
</appender>

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logs/logs-%d{yyyy-MM-dd}.log</fileNamePattern>
<file>${LOG_DIR}/app.log</file>
<append>true</append>

<maxHistory>90</maxHistory>
<totalSizeCap>3GB</totalSizeCap>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${LOG_DIR}/app.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
<maxFileSize>20MB</maxFileSize>
<maxHistory>30</maxHistory>
<totalSizeCap>2GB</totalSizeCap>
<cleanHistoryOnStart>true</cleanHistoryOnStart>
</rollingPolicy>

<encoder>
<pattern>[%d{dd-MM-yyyy HH:mm:ss}] %boldGreen(%-15.-15logger{0}) %highlight(%-6level) %msg%n</pattern>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<charset>UTF-8</charset>
<pattern>${FILE_PATTERN}</pattern>
</encoder>
</appender>

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>[%d{dd-MM-yyyy HH:mm:ss}] %boldGreen(%-15.-15logger{0}) %highlight(%-6level) %msg%n</pattern>
</encoder>
<!-- Async wrappers reduce blocking in JDA event/network threads -->
<appender name="ASYNC_CONSOLE" class="ch.qos.logback.classic.AsyncAppender">
<queueSize>2048</queueSize>
<neverBlock>true</neverBlock>
<appender-ref ref="CONSOLE" />
</appender>

<root level="info">
<appender name="ASYNC_FILE" class="ch.qos.logback.classic.AsyncAppender">
<queueSize>8192</queueSize>
<neverBlock>true</neverBlock>
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Feb 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Avoid dropping logs when async file queue fills

Setting neverBlock to true on the async file appender means log events are discarded once the queue is saturated (for example during bursty logging or slow disk I/O), and this configuration routes all root logging through async appenders only. That can silently lose warning/error evidence exactly during incidents, whereas the previous synchronous setup preserved those messages.

Useful? React with 👍 / 👎.

<appender-ref ref="FILE" />
<appender-ref ref="STDOUT" />
</appender>

<!-- JDA and related HTTP/WebSocket dependencies -->
<logger name="net.dv8tion.jda" level="${JDA_LOG_LEVEL}" />
<logger name="net.dv8tion.jda.internal" level="${JDA_INTERNAL_LOG_LEVEL}" />
<logger name="com.neovisionaries.ws.client" level="WARN" />
<logger name="okhttp3" level="WARN" />
<logger name="okio" level="WARN" />
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Feb 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The okio library is a dependency of OkHttp and provides efficient I/O primitives, but it does not have its own logging capabilities that are configured via SLF4J/Logback. Therefore, this <logger> configuration for okio has no effect and can be removed to keep the configuration clean and concise.


<root level="${ROOT_LOG_LEVEL}">
<appender-ref ref="ASYNC_CONSOLE" />
<appender-ref ref="ASYNC_FILE" />
</root>

</configuration>
Loading