optimize: datasource manager branch rollback exception log (apache#1775)

core/src/main/java/io/seata/core/constants/ConfigurationKeys.java

@@ -303,6 +303,11 @@ public class ConfigurationKeys {
      */
     public static final String TRANSACTION_UNDO_LOG_TABLE = CLIENT_UNDO_PREFIX + "log.table";
 
+    /**
+     * The constant TRANSACTION_UNDO_LOG_EXCEPTION_RATE
+     */
+    public static final String TRANSACTION_LOG_EXCEPTION_RATE = CLIENT_PREFIX + "log.exceptionRate";
+
     /**
      * The constant TRANSACTION_UNDO_LOG_DEFAULT_TABLE.
      */

core/src/main/java/io/seata/core/logger/StackTraceLogger.java

@@ -0,0 +1,41 @@
+/*
+ *  Copyright 1999-2019 Seata.io Group.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package io.seata.core.logger;
+
+import io.seata.config.Configuration;
+import io.seata.config.ConfigurationFactory;
+import io.seata.core.constants.ConfigurationKeys;
+import org.slf4j.Logger;
+
+/**
+ * @author jsbxyyx
+ */
+public final class StackTraceLogger {
+
+    private static final Configuration CONFIG = ConfigurationFactory.getInstance();
+
+    public static void info(Logger logger, Throwable cause, String format1, Object[] args1, String format2, Object[] args2) {
+        if (logger.isInfoEnabled()) {
+            int rate = CONFIG.getInt(ConfigurationKeys.TRANSACTION_LOG_EXCEPTION_RATE, 100);
+            if (System.currentTimeMillis() % rate == 0) {
+                logger.info(format1, args1, cause);
+            } else {
+                logger.info(format2, args2);
+            }
+        }
+    }
+
+}

rm-datasource/src/main/java/io/seata/rm/datasource/DataSourceManager.java

@@ -30,6 +30,7 @@
 import io.seata.core.exception.RmTransactionException;
 import io.seata.core.exception.TransactionException;
 import io.seata.core.exception.TransactionExceptionCode;
+import io.seata.core.logger.StackTraceLogger;
 import io.seata.core.model.BranchStatus;
 import io.seata.core.model.BranchType;
 import io.seata.core.model.Resource;
@@ -179,9 +180,10 @@ public BranchStatus branchRollback(BranchType branchType, String xid, long branc
         try {
             UndoLogManagerFactory.getUndoLogManager(dataSourceProxy.getDbType()).undo(dataSourceProxy, xid, branchId);
         } catch (TransactionException te) {
-            if (LOGGER.isInfoEnabled()) {
-                LOGGER.info("branchRollback failed reason [{}]", te.getMessage());
-            }
+            StackTraceLogger.info(LOGGER, te,
+                "[stacktrace]branchRollback failed. branchType:[{}], xid:[{}], branchId:[{}], resourceId:[{}], applicationData:[{}]. stacktrace:[{}]",
+                new Object[]{branchType, xid, branchId, resourceId, applicationData, te.getMessage()},
+                "branchRollback failed reason [{}]", new Object[]{te.getMessage()});
             if (te.getCode() == TransactionExceptionCode.BranchRollbackFailed_Unretriable) {
                 return BranchStatus.PhaseTwo_RollbackFailed_Unretryable;
             } else {

script/client/conf/file.conf

@@ -58,6 +58,9 @@ client {
     log.serialization = "jackson"
     log.table = "undo_log"
   }
+  log {
+    exceptionRate = 100
+  }
   support {
     # auto proxy the DataSource bean
     spring.datasource.autoproxy = false

script/config-center/nacos/nacos-config.txt

@@ -53,6 +53,7 @@ client.undo.log.serialization=jackson
 server.undo.log.save.days=7
 server.undo.log.delete.period=86400000
 client.undo.log.table=undo_log
+client.log.exceptionRate=100
 transport.serialization=seata
 transport.compressor=none
 metrics.enabled=false

seata-spring-boot-starter/src/main/java/io/seata/spring/boot/autoconfigure/StarterConstants.java

@@ -15,17 +15,16 @@
  */
 package io.seata.spring.boot.autoconfigure;
 
-import java.util.HashMap;
-
 import io.seata.spring.boot.autoconfigure.properties.file.ClientProperties;
 import io.seata.spring.boot.autoconfigure.properties.file.LockProperties;
+import io.seata.spring.boot.autoconfigure.properties.file.LogProperties;
 import io.seata.spring.boot.autoconfigure.properties.file.ServiceProperties;
 import io.seata.spring.boot.autoconfigure.properties.file.ShutdownProperties;
 import io.seata.spring.boot.autoconfigure.properties.file.SpringProperties;
 import io.seata.spring.boot.autoconfigure.properties.file.SupportProperties;
 import io.seata.spring.boot.autoconfigure.properties.file.ThreadFactoryProperties;
-import io.seata.spring.boot.autoconfigure.properties.file.UndoProperties;
 import io.seata.spring.boot.autoconfigure.properties.file.TransportProperties;
+import io.seata.spring.boot.autoconfigure.properties.file.UndoProperties;
 import io.seata.spring.boot.autoconfigure.properties.registry.ConfigApolloProperties;
 import io.seata.spring.boot.autoconfigure.properties.registry.ConfigConsulProperties;
 import io.seata.spring.boot.autoconfigure.properties.registry.ConfigEtcd3Properties;
@@ -43,6 +42,8 @@
 import io.seata.spring.boot.autoconfigure.properties.registry.RegistrySofaProperties;
 import io.seata.spring.boot.autoconfigure.properties.registry.RegistryZooKeeperProperties;
 
+import java.util.HashMap;
+
 /**
  * @author xingfudeshi@gmail.com
  * @date 2019/09/30
@@ -59,6 +60,7 @@ public class StarterConstants {
     public static final String CLIENT_RM_PREFIX = CLIENT_PREFIX + ".rm";
     public static final String LOCK_PREFIX = CLIENT_RM_PREFIX + ".lock";
     public static final String UNDO_PREFIX = CLIENT_PREFIX + ".undo";
+    public static final String LOG_PREFIX = CLIENT_PREFIX + ".log";
     public static final String SUPPORT_PREFIX = CLIENT_PREFIX + ".support";
     public static final String SPRING_PREFIX = SUPPORT_PREFIX + ".spring";
 
@@ -92,6 +94,7 @@ public class StarterConstants {
             put(SUPPORT_PREFIX, SupportProperties.class);
             put(THREAD_FACTORY_PREFIX, ThreadFactoryProperties.class);
             put(UNDO_PREFIX, UndoProperties.class);
+            put(LOG_PREFIX, LogProperties.class);
             put(TRANSPORT_PREFIX, TransportProperties.class);
             put(CONFIG_PREFIX, ConfigProperties.class);
             put(CONFIG_FILE_PREFIX, ConfigFileProperties.class);

seata-spring-boot-starter/src/main/java/io/seata/spring/boot/autoconfigure/properties/file/LogProperties.java

@@ -0,0 +1,40 @@
+/*
+ *  Copyright 1999-2019 Seata.io Group.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package io.seata.spring.boot.autoconfigure.properties.file;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+
+import static io.seata.spring.boot.autoconfigure.StarterConstants.LOG_PREFIX;
+
+/**
+ * @author jsbxyyx
+ */
+@Component
+@ConfigurationProperties(prefix = LOG_PREFIX)
+public class LogProperties {
+
+    private int exceptionRate = 100;
+
+    public int getExceptionRate() {
+        return exceptionRate;
+    }
+
+    public LogProperties setExceptionRate(int exceptionRate) {
+        this.exceptionRate = exceptionRate;
+        return this;
+    }
+}

server/src/main/resources/file.conf.example

@@ -58,6 +58,9 @@ client {
     log.serialization = "jackson"
     log.table = "undo_log"
   }
+  log {
+    exceptionRate = 100
+  }
   support {
     # auto proxy the DataSource bean
     spring.datasource.autoproxy = false