Skip to content

Commit a68078f

Browse files
authored
[ISSUE #5484] Replace logging module with the shaded logback (#5540)
* Replace logging module with the shaded logback * Add license header * Fix bazel compile issue
1 parent 991af5e commit a68078f

File tree

419 files changed

+2036
-6119
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

419 files changed

+2036
-6119
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
.settings/
55
target/
66
devenv
7-
*.log*
7+
*.log.*
88
*.iml
99
.idea/
1010
*.versionsBackup

.licenserc.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ header:
4444
- 'distribution/NOTICE-BIN'
4545
- 'distribution/conf/rmq-proxy.json'
4646
- '.bazelversion'
47+
- 'common/src/main/resources/META-INF/services/org.apache.rocketmq.logging.ch.qos.logback.classic.spi.Configurator'
4748

4849

4950
comment: on-failure

WORKSPACE

+4-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ maven_install(
4343
"com.alibaba:fastjson:1.2.76",
4444
"org.hamcrest:hamcrest-library:1.3",
4545
"io.netty:netty-all:4.1.65.Final",
46-
"org.slf4j:slf4j-api:1.7.7",
46+
"org.slf4j:slf4j-api:1.7.33",
4747
"org.assertj:assertj-core:3.22.0",
4848
"org.mockito:mockito-core:3.10.0",
4949
"com.github.luben:zstd-jni:1.5.2-2",
@@ -64,7 +64,6 @@ maven_install(
6464
"org.yaml:snakeyaml:1.30",
6565
"commons-codec:commons-codec:1.13",
6666
"commons-io:commons-io:2.7",
67-
"log4j:log4j:1.2.17",
6867
"com.google.truth:truth:0.30",
6968
"org.bouncycastle:bcpkix-jdk15on:1.69",
7069
"com.google.code.gson:gson:2.8.9",
@@ -73,7 +72,7 @@ maven_install(
7372
"com.google.protobuf:protobuf-java:3.20.1",
7473
"com.google.protobuf:protobuf-java-util:3.20.1",
7574
"com.conversantmedia:disruptor:1.2.10",
76-
"javax.annotation:javax.annotation-api:1.3.2",
75+
"org.apache.tomcat:annotations-api:6.0.53",
7776
"com.google.code.findbugs:jsr305:3.0.2",
7877
"org.checkerframework:checker-qual:3.12.0",
7978
"org.reflections:reflections:0.9.11",
@@ -94,6 +93,8 @@ maven_install(
9493
"io.opentelemetry:opentelemetry-api:1.19.0",
9594
"io.opentelemetry:opentelemetry-sdk-metrics:1.19.0",
9695
"io.opentelemetry:opentelemetry-sdk-common:1.19.0",
96+
"io.github.aliyun-mq:rocketmq-slf4j-api:1.0.4",
97+
"io.github.aliyun-mq:rocketmq-logback-classic:1.0.4",
9798
],
9899
fetch_sources = True,
99100
repositories = [

acl/BUILD.bazel

+2-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ java_library(
2222
visibility = ["//visibility:public"],
2323
deps = [
2424
"//common",
25-
"//logging",
2625
"//remoting",
2726
"//srvutil",
2827
"@maven//:com_alibaba_fastjson",
@@ -36,6 +35,8 @@ java_library(
3635
"@maven//:org_apache_rocketmq_rocketmq_proto",
3736
"@maven//:org_lz4_lz4_java",
3837
"@maven//:org_yaml_snakeyaml",
38+
"@maven//:io_github_aliyun_mq_rocketmq_slf4j_api",
39+
"@maven//:io_github_aliyun_mq_rocketmq_logback_classic",
3940
],
4041
)
4142

acl/pom.xml

+8-15
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,6 @@
3131
<groupId>${project.groupId}</groupId>
3232
<artifactId>rocketmq-remoting</artifactId>
3333
</dependency>
34-
<dependency>
35-
<groupId>${project.groupId}</groupId>
36-
<artifactId>rocketmq-logging</artifactId>
37-
</dependency>
3834
<dependency>
3935
<groupId>${project.groupId}</groupId>
4036
<artifactId>rocketmq-common</artifactId>
@@ -43,6 +39,14 @@
4339
<groupId>${project.groupId}</groupId>
4440
<artifactId>rocketmq-srvutil</artifactId>
4541
</dependency>
42+
<dependency>
43+
<groupId>io.github.aliyun-mq</groupId>
44+
<artifactId>rocketmq-slf4j-api</artifactId>
45+
</dependency>
46+
<dependency>
47+
<groupId>io.github.aliyun-mq</groupId>
48+
<artifactId>rocketmq-logback-classic</artifactId>
49+
</dependency>
4650
<dependency>
4751
<groupId>org.yaml</groupId>
4852
<artifactId>snakeyaml</artifactId>
@@ -55,17 +59,6 @@
5559
<groupId>org.apache.commons</groupId>
5660
<artifactId>commons-lang3</artifactId>
5761
</dependency>
58-
59-
<dependency>
60-
<groupId>org.slf4j</groupId>
61-
<artifactId>slf4j-api</artifactId>
62-
<scope>test</scope>
63-
</dependency>
64-
<dependency>
65-
<groupId>ch.qos.logback</groupId>
66-
<artifactId>logback-classic</artifactId>
67-
<scope>test</scope>
68-
</dependency>
6962
<dependency>
7063
<groupId>commons-validator</groupId>
7164
<artifactId>commons-validator</artifactId>

acl/src/main/java/org/apache/rocketmq/acl/common/AclSigner.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@
2222
import javax.crypto.spec.SecretKeySpec;
2323
import org.apache.commons.codec.binary.Base64;
2424
import org.apache.rocketmq.common.constant.LoggerName;
25-
import org.apache.rocketmq.logging.InternalLogger;
26-
import org.apache.rocketmq.logging.InternalLoggerFactory;
25+
import org.apache.rocketmq.logging.org.slf4j.Logger;
26+
import org.apache.rocketmq.logging.org.slf4j.LoggerFactory;
2727

2828
public class AclSigner {
2929
public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
3030
public static final SigningAlgorithm DEFAULT_ALGORITHM = SigningAlgorithm.HmacSHA1;
31-
private static final InternalLogger log = InternalLoggerFactory.getLogger(LoggerName.ROCKETMQ_AUTHORIZE_LOGGER_NAME);
31+
private static final Logger log = LoggerFactory.getLogger(LoggerName.ROCKETMQ_AUTHORIZE_LOGGER_NAME);
3232
private static final int CAL_SIGNATURE_FAILED = 10015;
3333
private static final String CAL_SIGNATURE_FAILED_MSG = "[%s:signature-failed] unable to calculate a request signature. error=%s";
3434

acl/src/main/java/org/apache/rocketmq/acl/common/AclUtils.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727

2828
import org.apache.commons.lang3.StringUtils;
2929
import org.apache.rocketmq.common.constant.LoggerName;
30-
import org.apache.rocketmq.logging.InternalLogger;
31-
import org.apache.rocketmq.logging.InternalLoggerFactory;
30+
import org.apache.rocketmq.logging.org.slf4j.Logger;
31+
import org.apache.rocketmq.logging.org.slf4j.LoggerFactory;
3232
import org.apache.rocketmq.remoting.RPCHook;
3333
import org.apache.rocketmq.remoting.protocol.RemotingCommand;
3434
import org.yaml.snakeyaml.Yaml;
@@ -37,7 +37,7 @@
3737

3838
public class AclUtils {
3939

40-
private static final InternalLogger log = InternalLoggerFactory.getLogger(LoggerName.COMMON_LOGGER_NAME);
40+
private static final Logger log = LoggerFactory.getLogger(LoggerName.COMMON_LOGGER_NAME);
4141

4242
public static byte[] combineRequestContent(RemotingCommand request, SortedMap<String, String> fieldsMap) {
4343
try {

acl/src/main/java/org/apache/rocketmq/acl/plain/PlainPermissionManager.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@
4545
import org.apache.rocketmq.common.PlainAccessConfig;
4646
import org.apache.rocketmq.common.constant.LoggerName;
4747
import org.apache.rocketmq.common.topic.TopicValidator;
48-
import org.apache.rocketmq.logging.InternalLogger;
49-
import org.apache.rocketmq.logging.InternalLoggerFactory;
48+
import org.apache.rocketmq.logging.org.slf4j.Logger;
49+
import org.apache.rocketmq.logging.org.slf4j.LoggerFactory;
5050
import org.apache.rocketmq.remoting.protocol.DataVersion;
5151
import org.apache.rocketmq.srvutil.AclFileWatchService;
5252

5353
public class PlainPermissionManager {
5454

55-
private static final InternalLogger log = InternalLoggerFactory.getLogger(LoggerName.COMMON_LOGGER_NAME);
55+
private static final Logger log = LoggerFactory.getLogger(LoggerName.COMMON_LOGGER_NAME);
5656

5757
private String fileHome = System.getProperty(MixAll.ROCKETMQ_HOME_PROPERTY,
5858
System.getenv(MixAll.ROCKETMQ_HOME_ENV));

acl/src/main/java/org/apache/rocketmq/acl/plain/RemoteAddressStrategyFactory.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@
2323
import org.apache.rocketmq.acl.common.AclException;
2424
import org.apache.rocketmq.acl.common.AclUtils;
2525
import org.apache.rocketmq.common.constant.LoggerName;
26-
import org.apache.rocketmq.logging.InternalLogger;
27-
import org.apache.rocketmq.logging.InternalLoggerFactory;
26+
import org.apache.rocketmq.logging.org.slf4j.Logger;
27+
import org.apache.rocketmq.logging.org.slf4j.LoggerFactory;
2828

2929
public class RemoteAddressStrategyFactory {
3030

31-
private static final InternalLogger log = InternalLoggerFactory.getLogger(LoggerName.COMMON_LOGGER_NAME);
31+
private static final Logger log = LoggerFactory.getLogger(LoggerName.COMMON_LOGGER_NAME);
3232

3333
public static final NullRemoteAddressStrategy NULL_NET_ADDRESS_STRATEGY = new NullRemoteAddressStrategy();
3434

acl/src/test/resources/logback-test.xml acl/src/test/resources/rmq.logback-test.xml

+12-10
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,20 @@
1717
-->
1818
<configuration>
1919

20-
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
21-
<encoder>
22-
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>
23-
<charset class="java.nio.charset.Charset">UTF-8</charset>
24-
</encoder>
20+
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
21+
<layout class="ch.qos.logback.classic.PatternLayout">
22+
<Pattern>
23+
%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n
24+
</Pattern>
25+
</layout>
2526
</appender>
2627

27-
<logger name="RocketmqCommon" level="INFO" additivity="false">
28-
<appender-ref ref="STDOUT"/>
28+
<logger name="org.apache.rocketmq" level="error" additivity="false">
29+
<appender-ref ref="CONSOLE"/>
2930
</logger>
30-
<root level="INFO">
31-
<appender-ref ref="STDOUT"/>
31+
32+
<root level="error">
33+
<appender-ref ref="CONSOLE"/>
3234
</root>
3335

34-
</configuration>
36+
</configuration>

broker/BUILD.bazel

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ java_library(
2525
"//client",
2626
"//common",
2727
"//filter",
28-
"//logging",
2928
"//remoting",
3029
"//srvutil",
3130
"//store",
@@ -50,6 +49,8 @@ java_library(
5049
"@maven//:org_apache_commons_commons_lang3",
5150
"@maven//:org_lz4_lz4_java",
5251
"@maven//:org_slf4j_slf4j_api",
52+
"@maven//:io_github_aliyun_mq_rocketmq_slf4j_api",
53+
"@maven//:io_github_aliyun_mq_rocketmq_logback_classic",
5354
],
5455
)
5556

@@ -60,7 +61,7 @@ java_library(
6061
"src/test/resources/META-INF/service/org.apache.rocketmq.acl.AccessValidator",
6162
"src/test/resources/META-INF/service/org.apache.rocketmq.broker.transaction.AbstractTransactionalMessageCheckListener",
6263
"src/test/resources/META-INF/service/org.apache.rocketmq.broker.transaction.TransactionalMessageService",
63-
"src/test/resources/logback-test.xml",
64+
"src/test/resources/rmq.logback-test.xml",
6465
],
6566
visibility = ["//visibility:public"],
6667
deps = [
@@ -70,7 +71,6 @@ java_library(
7071
"//client",
7172
"//common",
7273
"//filter",
73-
"//logging",
7474
"//remoting",
7575
"//store",
7676
"@maven//:com_alibaba_fastjson",

broker/pom.xml

+6-10
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,12 @@
3535
<artifactId>rocketmq-store</artifactId>
3636
</dependency>
3737
<dependency>
38-
<groupId>${project.groupId}</groupId>
39-
<artifactId>rocketmq-remoting</artifactId>
38+
<groupId>io.github.aliyun-mq</groupId>
39+
<artifactId>rocketmq-slf4j-api</artifactId>
40+
</dependency>
41+
<dependency>
42+
<groupId>io.github.aliyun-mq</groupId>
43+
<artifactId>rocketmq-logback-classic</artifactId>
4044
</dependency>
4145
<dependency>
4246
<groupId>${project.groupId}</groupId>
@@ -58,10 +62,6 @@
5862
<groupId>commons-io</groupId>
5963
<artifactId>commons-io</artifactId>
6064
</dependency>
61-
<dependency>
62-
<groupId>ch.qos.logback</groupId>
63-
<artifactId>logback-classic</artifactId>
64-
</dependency>
6565
<dependency>
6666
<groupId>com.alibaba</groupId>
6767
<artifactId>fastjson</artifactId>
@@ -70,10 +70,6 @@
7070
<groupId>org.javassist</groupId>
7171
<artifactId>javassist</artifactId>
7272
</dependency>
73-
<dependency>
74-
<groupId>org.slf4j</groupId>
75-
<artifactId>slf4j-api</artifactId>
76-
</dependency>
7773
<dependency>
7874
<groupId>org.bouncycastle</groupId>
7975
<artifactId>bcpkix-jdk15on</artifactId>

broker/src/main/java/org/apache/rocketmq/broker/BrokerController.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@
116116
import org.apache.rocketmq.common.message.MessageExtBrokerInner;
117117
import org.apache.rocketmq.common.stats.MomentStatsItem;
118118
import org.apache.rocketmq.common.utils.ServiceProvider;
119-
import org.apache.rocketmq.logging.InternalLogger;
120-
import org.apache.rocketmq.logging.InternalLoggerFactory;
119+
import org.apache.rocketmq.logging.org.slf4j.Logger;
120+
import org.apache.rocketmq.logging.org.slf4j.LoggerFactory;
121121
import org.apache.rocketmq.remoting.Configuration;
122122
import org.apache.rocketmq.remoting.RPCHook;
123123
import org.apache.rocketmq.remoting.RemotingServer;
@@ -159,9 +159,9 @@
159159
import org.apache.rocketmq.store.timer.TimerMetrics;
160160

161161
public class BrokerController {
162-
protected static final InternalLogger LOG = InternalLoggerFactory.getLogger(LoggerName.BROKER_LOGGER_NAME);
163-
private static final InternalLogger LOG_PROTECTION = InternalLoggerFactory.getLogger(LoggerName.PROTECTION_LOGGER_NAME);
164-
private static final InternalLogger LOG_WATER_MARK = InternalLoggerFactory.getLogger(LoggerName.WATER_MARK_LOGGER_NAME);
162+
protected static final Logger LOG = LoggerFactory.getLogger(LoggerName.BROKER_LOGGER_NAME);
163+
private static final Logger LOG_PROTECTION = LoggerFactory.getLogger(LoggerName.PROTECTION_LOGGER_NAME);
164+
private static final Logger LOG_WATER_MARK = LoggerFactory.getLogger(LoggerName.WATER_MARK_LOGGER_NAME);
165165
protected static final int HA_ADDRESS_MIN_LENGTH = 6;
166166

167167
protected final BrokerConfig brokerConfig;

broker/src/main/java/org/apache/rocketmq/broker/BrokerPreOnlineService.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
import org.apache.rocketmq.common.MixAll;
3030
import org.apache.rocketmq.common.ServiceThread;
3131
import org.apache.rocketmq.common.constant.LoggerName;
32-
import org.apache.rocketmq.logging.InternalLogger;
33-
import org.apache.rocketmq.logging.InternalLoggerFactory;
32+
import org.apache.rocketmq.logging.org.slf4j.Logger;
33+
import org.apache.rocketmq.logging.org.slf4j.LoggerFactory;
3434
import org.apache.rocketmq.remoting.common.RemotingHelper;
3535
import org.apache.rocketmq.remoting.protocol.BrokerSyncInfo;
3636
import org.apache.rocketmq.remoting.protocol.body.BrokerMemberGroup;
@@ -41,7 +41,7 @@
4141
import org.apache.rocketmq.store.timer.TimerCheckpoint;
4242

4343
public class BrokerPreOnlineService extends ServiceThread {
44-
private static final InternalLogger LOGGER = InternalLoggerFactory.getLogger(LoggerName.BROKER_LOGGER_NAME);
44+
private static final Logger LOGGER = LoggerFactory.getLogger(LoggerName.BROKER_LOGGER_NAME);
4545
private final BrokerController brokerController;
4646

4747
private int waitBrokerIndex = 0;

0 commit comments

Comments
 (0)