Skip to content

Commit 209e53b

Browse files
authored
Add tc. prefix to container logger names (#6781)
Co-authored-by: Vitalii Chura <[email protected]> Fixes #3016
1 parent 34aa967 commit 209e53b

File tree

4 files changed

+35
-5
lines changed

4 files changed

+35
-5
lines changed

core/src/main/java/org/testcontainers/utility/DockerLoggerFactory.java

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ public static Logger getLogger(String dockerImageName) {
1616
abbreviatedName = dockerImageName;
1717
}
1818

19-
if ("UTF-8".equals(System.getProperty("file.encoding"))) {
20-
return LoggerFactory.getLogger("\uD83D\uDC33 [" + abbreviatedName + "]");
21-
} else {
22-
return LoggerFactory.getLogger("docker[" + abbreviatedName + "]");
23-
}
19+
return LoggerFactory.getLogger("tc." + abbreviatedName);
2420
}
2521
}
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
package org.testcontainers.utility;
2+
3+
import ch.qos.logback.classic.Level;
4+
import ch.qos.logback.classic.Logger;
5+
import ch.qos.logback.classic.spi.ILoggingEvent;
6+
import ch.qos.logback.core.read.ListAppender;
7+
import org.junit.Test;
8+
9+
import static org.assertj.core.api.Assertions.assertThat;
10+
11+
public class DockerLoggerFactoryTest {
12+
13+
private static final Logger LOGGER = (Logger) DockerLoggerFactory.getLogger("dockerImageName");
14+
15+
@Test
16+
public void debugIsNotSwallowedForContainerLogs() {
17+
ListAppender<ILoggingEvent> listAppender = new ListAppender<>();
18+
listAppender.start();
19+
LOGGER.addAppender(listAppender);
20+
21+
LOGGER.debug("some text");
22+
23+
assertThat(listAppender.list).withFailMessage("Log message has been swallowed").hasSize(1);
24+
25+
ILoggingEvent event = listAppender.list.get(0);
26+
27+
assertThat(event.getFormattedMessage()).isEqualTo("some text");
28+
assertThat(event.getLevel()).isEqualTo(Level.DEBUG);
29+
assertThat(event.getLoggerName()).startsWith("tc");
30+
}
31+
}

core/src/test/resources/logback-test.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
</root>
1414

1515
<logger name="org.testcontainers" level="INFO"/>
16+
<logger name="tc.dockerImageName" level="DEBUG"/>
1617

1718
<logger name="com.github.dockerjava" level="WARN"/>
1819
<logger name="org.zeroturnaround.exec" level="WARN"/>

docs/supported_docker_environment/logging_config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ should be included in your classpath to show a reasonable level of log output:
1717
</root>
1818

1919
<logger name="org.testcontainers" level="INFO"/>
20+
<!-- The following logger can be used for containers logs since 1.18.0 -->
21+
<logger name="tc" level="INFO"/>
2022
<logger name="com.github.dockerjava" level="WARN"/>
2123
<logger name="com.github.dockerjava.zerodep.shaded.org.apache.hc.client5.http.wire" level="OFF"/>
2224
</configuration>

0 commit comments

Comments
 (0)