这是indexloc提供的服务，不要输入任何密码
Skip to content

BAEL-6478: Conditional Logging with Logback + tests #18512

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

Merged
merged 2 commits into from
May 12, 2025
Merged

BAEL-6478: Conditional Logging with Logback + tests #18512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30d2bbe
BAEL-6478: Conditional Logging with Logback + tests
palani-a Apr 27, 2025
e0041b4
BAEL-6478: Fix XML formatting
palani-a May 10, 2025
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
13 changes: 12 additions & 1 deletion logging-modules/logback/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,18 @@
<scope>provided</scope>
<version>${lombok.version}</version>
</dependency>
<dependency>
<groupId>org.codehaus.janino</groupId>
<artifactId>janino</artifactId>
<version>${janino.version}</version>
</dependency>
<dependency>
<groupId>net.logstash.logback</groupId>
<artifactId>logstash-logback-encoder</artifactId>
<version>${logstash.version}</version>
</dependency>
</dependencies>


<build>
<plugins>
<plugin>
Expand All @@ -102,6 +111,8 @@
<angus.activation.version>2.0.0</angus.activation.version>
<logback.version>1.5.6</logback.version>
<slf4j.version>2.1.0-alpha1</slf4j.version>
<janino.version>3.1.12</janino.version>
<logstash.version>8.0</logstash.version>
</properties>

</project>
66 changes: 66 additions & 0 deletions logging-modules/logback/src/test/java/com/baeldung/logback/ConditionalLoggingUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
package com.baeldung.logback;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.PrintStream;

import org.apache.commons.io.FileUtils;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.slf4j.LoggerFactory;

import ch.qos.logback.classic.Logger;

public class ConditionalLoggingUnitTest {

private static Logger logger;
private static ByteArrayOutputStream consoleOutput = new ByteArrayOutputStream();
private static PrintStream printStream = new PrintStream(consoleOutput);

@BeforeAll
public static void setUp() {
System.setProperty("logback.configurationFile", "src/test/resources/logback-conditional.xml");
// Redirect console output to our stream
System.setOut(printStream);
}

@Test
public void whenSystemPropertyIsNotPresent_thenReturnConsoleLogger() {
System.clearProperty("ENVIRONMENT");
logger = (Logger) LoggerFactory.getLogger(ConditionalLoggingUnitTest.class);

logger.info("test console log");
String logOutput = consoleOutput.toString();
assertTrue(logOutput.contains("test console log"));
}

@Test
public void whenSystemPropertyIsPresent_thenReturnFileLogger() throws IOException {
System.setProperty("ENVIRONMENT", "PROD");
logger = (Logger) LoggerFactory.getLogger(ConditionalLoggingUnitTest.class);

logger.info("test prod log");
String logOutput = FileUtils.readFileToString(new File("conditional.log"));
assertTrue(logOutput.contains("test prod log"));
}

@Test
public void whenMatchedWithEvaluatorFilter_thenReturnFilteredLogs() throws IOException {
logger = (Logger) LoggerFactory.getLogger(ConditionalLoggingUnitTest.class);

logger.info("normal log");
logger.info("billing details: XXXX");
String normalLog = FileUtils.readFileToString(new File("conditional.log"));
assertTrue(normalLog.contains("normal log"));
assertTrue(normalLog.contains("billing details: XXXX"));

String filteredLog = FileUtils.readFileToString(new File("filtered.log"));
assertTrue(filteredLog.contains("test prod log"));
assertFalse(filteredLog.contains("billing details: XXXX"));
}

}
63 changes: 63 additions & 0 deletions logging-modules/logback/src/test/resources/logback-conditional.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<configuration debug="true">

<if condition='property("ENVIRONMENT").contains("PROD")'>
<then>
<appender name="FILE_APPENDER" class="ch.qos.logback.core.FileAppender">
<file>conditional.log</file>
<encoder>
<pattern>%d %-5level %logger{35} -%kvp- %msg %n</pattern>
</encoder>
</appender>
</then>
</if>

<if condition='isNull("ENVIRONMENT")'>
<then>
<appender name="CONSOLE_APPENDER" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d %-5level %logger{35} -%kvp- %msg %n</pattern>
</encoder>
</appender>
</then>
</if>

<if condition='isDefined("LOG_STASH_URL")'>
<then>
<appender name="LOG_STASH_APPENDER" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<destination>${LOG_STASH_URL}</destination>
<encoder class="net.logstash.logback.encoder.LogstashEncoder">
<customFields>{"app_name": "TestApp"}</customFields>
</encoder>
</appender>
</then>
</if>

<appender name="FILTER_APPENDER" class="ch.qos.logback.core.FileAppender">
<file>filtered.log</file>
<filter class="ch.qos.logback.core.filter.EvaluatorFilter">
<evaluator>
<expression>return message.contains("billing");</expression>
</evaluator>
<OnMatch>DENY</OnMatch>
<OnMismatch>NEUTRAL</OnMismatch>
</filter>
<encoder>
<pattern>%d %-4relative [%thread] %-5level %logger -%kvp -%msg%n</pattern>
</encoder>
</appender>

<appender name="CONSOLE_APPENDER" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d %-5level %logger{35} -%kvp- %msg %n</pattern>
</encoder>
</appender>

<root level="DEBUG">
<appender-ref ref="FILE_APPENDER" />
<appender-ref ref="FILTER_APPENDER" />
<appender-ref ref="CONSOLE_APPENDER" />
</root>
</configuration>