Release/v0.2.2 (#18)

zouxyan · dawn-to-dusk · web-flow · commit a3894ab07578 · 2024-02-21T14:08:38.000+08:00
* [feat][*][0.2.2]: support bbc log print

* [doc][*][0.2.2]: update README.md about bbc log

* [feat][*][*]: add interceptor to log request trace

---------

Co-authored-by: dawn-to-dusk &lt;37816460+dawn-to-dusk@users.noreply.github.com&gt;
diff --git a/README.md b/README.md
@@ -202,6 +202,24 @@ systemctl status plugin-server.service
 
 日志文件存储在`log`目录之下。
 
+## 插件
+
+将你的插件放在配置`pluginserver.plugin.repo`的路径之下，然后启动插件服务即可加载所有插件。
+
+插件运行中使用`BBCLogger`打印的日志，比如[这里](https://github.com/AntChainOpenLabs/AntChainBridgePluginSDK/blob/604c5b97305ee77cfa1e14454f5b99f1f905f6ea/pluginset/ethereum/offchain-plugin/src/main/java/com/alipay/antchain/bridge/plugins/ethereum/EthereumBBCService.java#L74)，插件服务将会按照插件的`product`和BBCService对象的`domain`，打印到不同文件`logs/bbc/${product}/${domain}`，比如下面`product`为`simple-ethereum`和域名为`domainB`的日志文件。
+
+```
+logs/
+├── antchain-bridge-pluginserver
+│   ├── application.log
+│   └── error.log
+└── bbc
+    └── simple-ethereum
+        └── domainB.log
+
+3 directories, 3 files
+```
+
 ## 运行测试
 
 在运行测试之前，请使用`ps-bootstrap/src/main/resources/scripts/init_tls_certs.sh`生成证书，并将`server.key`和`server.crt` 放到`ps-bootstrap/src/test/resources`之下，运行下述命令即可运行测试用例：
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>2.5.8</version>
+        <version>2.7.16</version>
         <relativePath/>
     </parent>
     <packaging>pom</packaging>
@@ -19,22 +19,24 @@
 
     <properties>
         <java.version>8</java.version>
-        <pluginserver.version>0.2.1</pluginserver.version>
+        <pluginserver.version>0.2.2</pluginserver.version>
         <grpc-starter.version>2.13.1.RELEASE</grpc-starter.version>
         <netty-tcnative-boringssl-static.version>2.0.59.Final</netty-tcnative-boringssl-static.version>
         <protobuf.version>3.19.1</protobuf.version>
         <protobuf-plugin.version>0.6.1</protobuf-plugin.version>
         <grpc.version>1.42.2</grpc.version>
         <jakarta.annotation-api.version>1.3.5</jakarta.annotation-api.version>
         <junit.version>4.13.2</junit.version>
-        <antchain-bridge.sdk.version>0.1.2</antchain-bridge.sdk.version>
+        <antchain-bridge.sdk.version>0.2.1</antchain-bridge.sdk.version>
         <jline.version>3.3.0</jline.version>
         <groovy.version>3.0.17</groovy.version>
         <commons-cli.version>1.5.0</commons-cli.version>
         <hutool.version>5.8.10</hutool.version>
         <fastjson.version>1.2.83_noneautotype</fastjson.version>
         <pf4j.version>3.8.0</pf4j.version>
         <slf4j.version>1.7.28</slf4j.version>
+        <jetty.alpnAgent.version>2.0.0</jetty.alpnAgent.version>
+        <jetty.alpnAgent.path>${settings.localRepository}/org/mortbay/jetty/alpn/jetty-alpn-agent/${jetty.alpnAgent.version}/jetty-alpn-agent-${jetty.alpnAgent.version}.jar</jetty.alpnAgent.path>
     </properties>
 
     <repositories>
@@ -49,7 +51,7 @@
 
     <groupId>com.alipay.antchain.bridge</groupId>
     <artifactId>antchain-bridge-pluginserver</artifactId>
-    <version>0.2.1</version>
+    <version>0.2.2</version>
 
     <name>antchain-bridge-pluginserver</name>
     <description>antchain-bridge-pluginserver</description>
@@ -215,8 +217,7 @@
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>3.0.0-M5</version>
                 <configuration>
-                    <excludes>
-                    </excludes>
+                    <argLine>-javaagent:${jetty.alpnAgent.path}</argLine>
                 </configuration>
             </plugin>
         </plugins>
diff --git a/ps-bootstrap/pom.xml b/ps-bootstrap/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.alipay.antchain.bridge</groupId>
         <artifactId>antchain-bridge-pluginserver</artifactId>
-        <version>0.2.1</version>
+        <version>0.2.2</version>
     </parent>
 
     <artifactId>ps-bootstrap</artifactId>
diff --git a/ps-bootstrap/src/main/java/com/alipay/antchain/bridge/pluginserver/config/PluginManagerConfiguration.java b/ps-bootstrap/src/main/java/com/alipay/antchain/bridge/pluginserver/config/PluginManagerConfiguration.java
@@ -16,59 +16,27 @@
 
 package com.alipay.antchain.bridge.pluginserver.config;
 
-import cn.hutool.core.collection.ListUtil;
+import java.io.IOException;
+import java.net.InetAddress;
+import java.net.InetSocketAddress;
+
 import cn.hutool.core.util.StrUtil;
-import com.alipay.antchain.bridge.pluginserver.pluginmanager.IPluginManagerWrapper;
-import com.alipay.antchain.bridge.pluginserver.pluginmanager.PluginManagerWrapperImpl;
 import com.alipay.antchain.bridge.pluginserver.server.PluginManagementServiceImpl;
 import io.grpc.Server;
 import io.grpc.netty.shaded.io.grpc.netty.NettyServerBuilder;
 import lombok.extern.slf4j.Slf4j;
-import org.pf4j.ClassLoadingStrategy;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-import java.io.IOException;
-import java.net.InetAddress;
-import java.net.InetSocketAddress;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
-
 @Configuration
 @Slf4j
 public class PluginManagerConfiguration {
-    @Value("${pluginserver.plugin.repo}")
-    private String pluginPath;
 
-    @Value("${pluginserver.plugin.policy.classloader.resource.ban-with-prefix.APPLICATION}")
-    private String[] resourceBannedPrefixOnAppLevel;
-
-    @Value("${pluginserver.managerserver.host}")
+    @Value("${pluginserver.managerserver.host:localhost}")
     private String managementHost;
 
-    @Bean
-    public IPluginManagerWrapper pluginManagerWrapper() {
-        return new PluginManagerWrapperImpl(
-                pluginPath,
-                convertPathPrefixBannedMap(resourceBannedPrefixOnAppLevel)
-        );
-    }
-
-    private Map<ClassLoadingStrategy.Source, Set<String>> convertPathPrefixBannedMap(
-            String[] resourceBannedPrefixOnAppLevel
-    ) {
-        Map<ClassLoadingStrategy.Source, Set<String>> result = new HashMap<>();
-
-        Set<String> appSet = new HashSet<>(ListUtil.of(resourceBannedPrefixOnAppLevel));
-        result.put(ClassLoadingStrategy.Source.APPLICATION, appSet);
-
-        return result;
-    }
-
     @Value("${pluginserver.managerserver.port}")
     private String pluginServerMgrPort;
 
diff --git a/ps-bootstrap/src/main/resources/logback-spring.xml b/ps-bootstrap/src/main/resources/logback-spring.xml
@@ -85,6 +85,35 @@
         </filter>
     </appender>
 
+    <appender name="reqTraceAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <file>${logging.path}/${APP_NAME}/req_trace.log</file>
+        <encoder>
+            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} -
+                %msg%n
+            </pattern>
+            <charset>UTF-8</charset>
+        </encoder>
+        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
+            <FileNamePattern>${logging.path}/${APP_NAME}/req_trace.log.%d{yyyy-MM-dd}.%i</FileNamePattern>
+            <maxHistory>7</maxHistory>
+            <maxFileSize>50MB</maxFileSize>
+            <totalSizeCap>500MB</totalSizeCap>
+            <cleanHistoryOnStart>true</cleanHistoryOnStart>
+        </rollingPolicy>
+    </appender>
+    <appender name="full-req-trace" class="ch.qos.logback.classic.AsyncAppender">
+        <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
+        <discardingThreshold>0</discardingThreshold>
+        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
+        <queueSize>256</queueSize>
+        <!-- 添加附加的appender,最多只能添加一个 -->
+        <appender-ref ref="reqTraceAppender"/>
+    </appender>
+
+    <logger name="req-trace" level="INFO" additivity="false">
+        <appender-ref ref="full-req-trace"/>
+    </logger>
+
     <root level="INFO">
         <appender-ref ref="CONSOLE"/>
         <appender-ref ref="full-application"/>
diff --git a/ps-cli/pom.xml b/ps-cli/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.alipay.antchain.bridge</groupId>
         <artifactId>antchain-bridge-pluginserver</artifactId>
-        <version>0.2.1</version>
+        <version>0.2.2</version>
     </parent>
 
     <artifactId>ps-cli</artifactId>
diff --git a/ps-pluginmanager/pom.xml b/ps-pluginmanager/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.alipay.antchain.bridge</groupId>
         <artifactId>antchain-bridge-pluginserver</artifactId>
-        <version>0.2.1</version>
+        <version>0.2.2</version>
     </parent>
 
     <artifactId>ps-pluginmanager</artifactId>
diff --git a/ps-pluginmanager/src/main/java/com/alipay/antchain/bridge/pluginserver/pluginmanager/PluginManagerWrapperImpl.java b/ps-pluginmanager/src/main/java/com/alipay/antchain/bridge/pluginserver/pluginmanager/PluginManagerWrapperImpl.java
@@ -16,34 +16,88 @@
 
 package com.alipay.antchain.bridge.pluginserver.pluginmanager;
 
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.*;
+import java.util.stream.Collectors;
+
+import ch.qos.logback.classic.AsyncAppender;
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.LoggerContext;
+import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.rolling.RollingFileAppender;
+import ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy;
+import ch.qos.logback.core.util.FileSize;
+import cn.hutool.core.collection.ListUtil;
 import cn.hutool.core.util.ObjectUtil;
+import cn.hutool.core.util.StrUtil;
 import com.alipay.antchain.bridge.commons.core.base.CrossChainDomain;
 import com.alipay.antchain.bridge.plugins.manager.AntChainBridgePluginManagerFactory;
 import com.alipay.antchain.bridge.plugins.manager.core.IAntChainBridgePlugin;
 import com.alipay.antchain.bridge.plugins.manager.core.IAntChainBridgePluginManager;
 import com.alipay.antchain.bridge.plugins.spi.bbc.IBBCService;
 import lombok.extern.slf4j.Slf4j;
 import org.pf4j.ClassLoadingStrategy;
-
-import java.nio.file.Paths;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.stream.Collectors;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Component;
 
 @Slf4j
+@Component
 public class PluginManagerWrapperImpl implements IPluginManagerWrapper {
 
     private final IAntChainBridgePluginManager manager;
 
-    public PluginManagerWrapperImpl(String path, Map<ClassLoadingStrategy.Source, Set<String>> pathPrefixBannedMap) {
+    private final String bbcLoggerDir;
+
+    @Value("${pluginserver.plugin.log.bbc.max_history:3}")
+    private int maxBBCLogHistory;
+
+    @Value("${pluginserver.plugin.log.bbc.max_file_size:30mb}")
+    private String maxBBCLogFileSize;
+
+    @Value("${pluginserver.plugin.log.bbc.level:info}")
+    private String bbcLogLevel;
+
+    @Value("${pluginserver.plugin.log.bbc.on:true}")
+    private boolean isBBCLogOn;
+
+    private final Map<String, Logger> bbcLoggerMap = new HashMap<>();
+
+    @Autowired
+    public PluginManagerWrapperImpl(
+            @Value("${pluginserver.plugin.repo}") String path,
+            @Value("${logging.file.path}") String appLogDir,
+            @Value("${pluginserver.plugin.policy.classloader.resource.ban-with-prefix.APPLICATION:}") String[] resourceBannedPrefixOnAppLevel
+    ) {
         log.info("plugins path: {}", Paths.get(path).toAbsolutePath());
-        manager = AntChainBridgePluginManagerFactory.createPluginManager(path, ObjectUtil.defaultIfNull(pathPrefixBannedMap, new HashMap<>()));
+
+        this.bbcLoggerDir = Paths.get(appLogDir, "bbc").toAbsolutePath().toString();
+        log.info("bbc logger base dir: {}", Paths.get(bbcLoggerDir).toAbsolutePath());
+
+        this.manager = AntChainBridgePluginManagerFactory.createPluginManager(
+                path,
+                ObjectUtil.defaultIfNull(convertPathPrefixBannedMap(resourceBannedPrefixOnAppLevel), new HashMap<>())
+        );
         loadPlugins();
         startPlugins();
     }
 
+    private Map<ClassLoadingStrategy.Source, Set<String>> convertPathPrefixBannedMap(
+            String[] resourceBannedPrefixOnAppLevel
+    ) {
+        Map<ClassLoadingStrategy.Source, Set<String>> result = new HashMap<>();
+
+        Set<String> appSet = new HashSet<>(ListUtil.of(resourceBannedPrefixOnAppLevel));
+        result.put(ClassLoadingStrategy.Source.APPLICATION, appSet);
+
+        return result;
+    }
+
     @Override
     public void loadPlugins() {
         manager.loadPlugins();
@@ -101,7 +155,7 @@ public List<String> allSupportProducts() {
 
     @Override
     public IBBCService createBBCService(String product, String domain) {
-        return manager.createBBCService(product, new CrossChainDomain(domain));
+        return manager.createBBCService(product, new CrossChainDomain(domain), createBBCServiceLogger(product, domain));
     }
 
     @Override
@@ -118,4 +172,66 @@ public boolean hasDomain(String domain) {
     public List<String> allRunningDomains() {
         return manager.allRunningDomains().stream().map(CrossChainDomain::toString).collect(Collectors.toList());
     }
+
+    private Logger createBBCServiceLogger(String product, String domain) {
+        if (!isBBCLogOn) {
+            return null;
+        }
+        String loggerName = getLoggerName(product, domain);
+        if (bbcLoggerMap.containsKey(loggerName) && ObjectUtil.isNotNull(bbcLoggerMap.get(loggerName))) {
+            return bbcLoggerMap.get(loggerName);
+        }
+        Path logFile = Paths.get(bbcLoggerDir, product, domain + ".log");
+        Logger logger = LoggerFactory.getLogger(loggerName);
+        if (logger instanceof ch.qos.logback.classic.Logger) {
+            log.debug("using logback for bbc logger");
+
+            LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
+
+            PatternLayoutEncoder encoder = new PatternLayoutEncoder();
+            encoder.setContext(context);
+            encoder.setPattern("%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n");
+            encoder.setCharset(StandardCharsets.UTF_8);
+            encoder.start();
+
+            SizeAndTimeBasedRollingPolicy rollingPolicy = new SizeAndTimeBasedRollingPolicy<>();
+            rollingPolicy.setContext(context);
+            rollingPolicy.setFileNamePattern(logFile + ".%d{yyyy-MM-dd}.%i");
+            rollingPolicy.setMaxHistory(maxBBCLogHistory);
+            rollingPolicy.setMaxFileSize(FileSize.valueOf(maxBBCLogFileSize));
+
+            RollingFileAppender<ILoggingEvent> appender = new RollingFileAppender<>();
+            appender.setContext(context);
+            appender.setEncoder(encoder);
+            appender.setFile(logFile.toString());
+            appender.setRollingPolicy(rollingPolicy);
+
+            rollingPolicy.setParent(appender);
+            rollingPolicy.start();
+            appender.start();
+
+            AsyncAppender asyncAppender = new AsyncAppender();
+            asyncAppender.setContext(context);
+            asyncAppender.setName(loggerName);
+            asyncAppender.addAppender(appender);
+            asyncAppender.start();
+
+            ch.qos.logback.classic.Logger loggerLogback = (ch.qos.logback.classic.Logger) logger;
+            loggerLogback.setLevel(Level.toLevel(bbcLogLevel));
+            loggerLogback.setAdditive(false);
+            loggerLogback.addAppender(asyncAppender);
+
+            bbcLoggerMap.put(loggerName, loggerLogback);
+            log.info("bbc logger {} created", loggerName);
+
+            return loggerLogback;
+        }
+
+        log.debug("logger library not support for now");
+        return null;
+    }
+
+    private String getLoggerName(String product, String domain) {
+        return StrUtil.format("{}::{}", product, domain);
+    }
 }
diff --git a/ps-server/pom.xml b/ps-server/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.alipay.antchain.bridge</groupId>
         <artifactId>antchain-bridge-pluginserver</artifactId>
-        <version>0.2.1</version>
+        <version>0.2.2</version>
     </parent>
 
     <artifactId>ps-server</artifactId>
diff --git a/ps-server/src/main/java/com/alipay/antchain/bridge/pluginserver/server/CrossChainServiceImpl.java b/ps-server/src/main/java/com/alipay/antchain/bridge/pluginserver/server/CrossChainServiceImpl.java
diff --git a/ps-server/src/main/java/com/alipay/antchain/bridge/pluginserver/server/PluginManagementServiceImpl.java b/ps-server/src/main/java/com/alipay/antchain/bridge/pluginserver/server/PluginManagementServiceImpl.java
diff --git a/ps-server/src/main/java/com/alipay/antchain/bridge/pluginserver/server/interceptor/RequestTraceInterceptor.java b/ps-server/src/main/java/com/alipay/antchain/bridge/pluginserver/server/interceptor/RequestTraceInterceptor.java
diff --git a/ps-service/pom.xml b/ps-service/pom.xml
