添加日志

saleson · saleson · commit 9f375ca795fd · 2020-07-28T19:54:01.000+08:00
diff --git a/spring-cloud-gray-client-netflix/src/main/java/cn/springcloud/gray/client/netflix/RibbonServerChooser.java b/spring-cloud-gray-client-netflix/src/main/java/cn/springcloud/gray/client/netflix/RibbonServerChooser.java
@@ -12,6 +12,7 @@
 import cn.springcloud.gray.servernode.ServerListProcessor;
 import cn.springcloud.gray.servernode.ServerSpec;
 import com.netflix.loadbalancer.Server;
+import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.collections.ListUtils;
 import org.apache.commons.lang3.StringUtils;
@@ -21,6 +22,7 @@
 import java.util.Objects;
 import java.util.stream.Collectors;
 
+@Slf4j
 public class RibbonServerChooser implements ServerChooser<Server> {
 
     private GrayManager grayManager;
@@ -60,7 +62,8 @@ public boolean matchGrayDecisions(Server server) {
     @Override
     public ServerListResult<Server> distinguishServerList(List<Server> servers) {
         String serviceId = getServiceId(servers);
-        if(StringUtils.isEmpty(serviceId)){
+        if (StringUtils.isEmpty(serviceId)) {
+            log.warn("没有获取到当前remote request的service id, 返回null");
             return null;
         }
         return distinguishServerList(serviceId, servers);
@@ -75,23 +78,27 @@ public ServerListResult<Server> distinguishAndMatchGrayServerList(List<Server> s
         }
 
         if (GrayClientHolder.getGraySwitcher().isEanbleGrayRouting()) {
-            serverListResult.setGrayServers(
-                    serverListResult.getGrayServers().stream()
-                            .filter(this::matchGrayDecisions)
-                            .collect(Collectors.toList()));
-        }else{
+            log.debug("开始匹配{}服务的灰度实例", serverListResult.getServiceId());
+            List<Server> matchedGrayServers = serverListResult.getGrayServers().stream()
+                    .filter(this::matchGrayDecisions)
+                    .collect(Collectors.toList());
+            log.debug("{} 服务共有{}个灰度实例，本次匹配到{}个",
+                    serverListResult.getServiceId(), serverListResult.getGrayServers().size(), matchedGrayServers.size());
+            serverListResult.setGrayServers(matchedGrayServers);
+        } else {
+            log.debug("grayRouting未打开,将{}服务的灰度实例清空,使之路由到正常实例", serverListResult.getServiceId());
             serverListResult.setGrayServers(ListUtils.EMPTY_LIST);
         }
 
         return serverListResult;
     }
 
-    private String getServiceId(List<Server> servers){
+    private String getServiceId(List<Server> servers) {
         GrayRequest grayRequest = requestLocalStorage.getGrayRequest();
         if (grayRequest != null && StringUtils.isNotEmpty(grayRequest.getServiceId())) {
             return grayRequest.getServiceId();
         }
-        if(CollectionUtils.isNotEmpty(servers)) {
+        if (CollectionUtils.isNotEmpty(servers)) {
             Server server = servers.get(0);
             if (!Objects.isNull(server)) {
                 return server.getMetaInfo().getServiceIdForDiscovery();
@@ -103,6 +110,7 @@ private String getServiceId(List<Server> servers){
 
     private ServerListResult<Server> distinguishServerList(String serviceId, List<Server> servers) {
         if (!grayManager.hasGray(serviceId)) {
+            log.debug("当前灰度开关未打开，或服务 '{}'没有相关灰度策略", serviceId);
             return null;
         }
 
@@ -119,6 +127,7 @@ private ServerListResult<Server> distinguishServerList(String serviceId, List<Se
             }
         }
 
+        log.debug("区分服务实例灰度状态: 服务 {} 实例数:{total: {}, gray:{}, normal:{}}", serviceId, servers.size(), grayServers.size(), normalServers.size());
         return new ServerListResult<>(serviceId, grayServers, normalServers);
     }
 }
diff --git a/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/GrayClientHolder.java b/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/GrayClientHolder.java
@@ -2,11 +2,14 @@
 
 import cn.springcloud.gray.client.switcher.GraySwitcher;
 import cn.springcloud.gray.local.InstanceLocalInfo;
+import cn.springcloud.gray.request.GrayRequest;
 import cn.springcloud.gray.request.LocalStorageLifeCycle;
 import cn.springcloud.gray.request.RequestLocalStorage;
 import cn.springcloud.gray.servernode.ServerExplainer;
 import cn.springcloud.gray.servernode.ServerListProcessor;
 
+import java.util.Objects;
+
 public class GrayClientHolder {
 
     private static GrayManager grayManager;
@@ -82,4 +85,15 @@ public static <SERVER> ServerChooser<SERVER> getServerChooser() {
     public static void setServerChooser(ServerChooser<?> serverChooser) {
         GrayClientHolder.serverChooser = serverChooser;
     }
+
+
+    /**
+     * 获取当前remote request的service id
+     *
+     * @return
+     */
+    public static String getCurrentRequestServiceId() {
+        GrayRequest grayRequest = getRequestLocalStorage().getGrayRequest();
+        return Objects.isNull(grayRequest) ? null : grayRequest.getServiceId();
+    }
 }
diff --git a/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/ServerChooser.java b/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/ServerChooser.java
@@ -2,7 +2,9 @@
 
 import cn.springcloud.gray.choose.ListChooser;
 import cn.springcloud.gray.servernode.ServerSpec;
+import cn.springcloud.gray.utils.LogUtils;
 import org.apache.commons.collections.CollectionUtils;
+import org.slf4j.Logger;
 
 import java.util.List;
 
@@ -36,15 +38,26 @@ default Server chooseServer(List<Server> servers, ListChooser<Server> chooser) {
             return chooser.choose(servers);
         }
 
-        if (GrayClientHolder.getGraySwitcher().isEanbleGrayRouting()) {
-            if (CollectionUtils.isNotEmpty(serverListResult.getGrayServers())) {
-                Server server = chooser.choose(serverListResult.getGrayServers());
-                if (server != null) {
-                    return server;
-                }
-            }
+        Logger log = LogUtils.logger(ServerChooser.class);
+
+        if (!GrayClientHolder.getGraySwitcher().isEanbleGrayRouting()) {
+            log.warn("grayRouting未打开，从正常实例列表中挑选");
+            return chooser.choose(serverListResult.getNormalServers());
+        }
+
+        if (CollectionUtils.isEmpty(serverListResult.getGrayServers())) {
+            log.debug("没有匹配的灰度实例，从正常实例列表中挑选");
+            return chooser.choose(serverListResult.getNormalServers());
+        }
+
+        log.debug("开始从灰度实例列表中负载挑选...");
+        Server server = chooser.choose(serverListResult.getGrayServers());
+        if (server != null) {
+            log.debug("从灰度实例列表成功负载挑选到 {}", server);
+            return server;
         }
 
+        log.warn("从灰度实例列表负载挑选失败，从正常实例列表中挑选");
         return chooser.choose(serverListResult.getNormalServers());
     }
 
diff --git a/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/choose/DefaultGrayPredicate.java b/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/choose/DefaultGrayPredicate.java
@@ -1,14 +1,20 @@
 package cn.springcloud.gray.choose;
 
 import cn.springcloud.gray.GrayManager;
+import cn.springcloud.gray.decision.BringPolicyDefinitionGrayDecision;
 import cn.springcloud.gray.decision.GrayDecision;
 import cn.springcloud.gray.decision.GrayDecisionInputArgs;
+import cn.springcloud.gray.model.PolicyDefinition;
 import cn.springcloud.gray.request.GrayRequest;
 import cn.springcloud.gray.request.RequestLocalStorage;
 import cn.springcloud.gray.servernode.ServerSpec;
+import cn.springcloud.gray.utils.JsonUtils;
+import lombok.extern.slf4j.Slf4j;
 
+import java.io.IOException;
 import java.util.List;
 
+@Slf4j
 public class DefaultGrayPredicate implements GrayPredicate {
 
     private RequestLocalStorage requestLocalStorage;
@@ -22,30 +28,71 @@ public DefaultGrayPredicate(RequestLocalStorage requestLocalStorage, GrayManager
 
     @Override
     public boolean apply(ServerSpec serverSpec) {
-        GrayDecisionInputArgs decisionInputArgs = GrayDecisionInputArgs
-                .builder().grayRequest(requestLocalStorage.getGrayRequest()).server(serverSpec).build();
+        GrayDecisionInputArgs decisionInputArgs = GrayDecisionInputArgs.builder()
+                .grayRequest(requestLocalStorage.getGrayRequest())
+                .server(serverSpec)
+                .build();
         return apply(decisionInputArgs);
     }
 
     @Override
     public boolean apply(GrayDecisionInputArgs decisionInputArgs) {
         GrayRequest grayRequest = decisionInputArgs.getGrayRequest();
-        if(grayRequest==null){
+        if (grayRequest == null) {
             return false;
         }
         ServerSpec serverSpec = decisionInputArgs.getServer();
-        if(serverSpec==null){
+        if (serverSpec == null) {
             return false;
         }
 
         List<GrayDecision> grayDecisions =
                 grayManager.getGrayDecision(serverSpec.getServiceId(), serverSpec.getInstanceId());
 
-        for (GrayDecision grayDecision : grayDecisions) {
-            if (grayDecision.test(decisionInputArgs)) {
+        for (int i = 0; i < grayDecisions.size(); i++) {
+            GrayDecision grayDecision = grayDecisions.get(i);
+            boolean testValue = grayDecision.test(decisionInputArgs);
+            printGrayPolicyDecisionInfo(decisionInputArgs, grayDecision, testValue, grayDecisions.size(), i);
+            if (testValue) {
                 return true;
             }
         }
         return false;
     }
+
+
+    private void printGrayPolicyDecisionInfo(
+            GrayDecisionInputArgs decisionInputArgs,
+            GrayDecision grayDecision,
+            boolean testValue,
+            int decisionLength,
+            int currentDecisionIndex) {
+        if (!log.isDebugEnabled()) {
+            return;
+        }
+        try {
+            if (grayDecision instanceof BringPolicyDefinitionGrayDecision) {
+                BringPolicyDefinitionGrayDecision policyDefinitionGrayDecision = (BringPolicyDefinitionGrayDecision) grayDecision;
+                PolicyDefinition policyDefinition = policyDefinitionGrayDecision.getPolicyDefinition();
+                log.debug("【灰度决策】服务'{}'的实例'{}' ,'{}-{}'决策结果为'{}'; \ndecisionInputArgs: {}, \npolicyDefinition: {}",
+                        decisionInputArgs.getGrayRequest().getServiceId(),
+                        decisionInputArgs.getServer().getInstanceId(),
+                        decisionLength,
+                        currentDecisionIndex + 1,
+                        testValue,
+                        JsonUtils.toJson(decisionInputArgs),
+                        JsonUtils.toJson(policyDefinition));
+            }
+            log.debug("【灰度决策】服务'{}'的实例'{}' ,'{}-{}'决策结果为'{}'; \ndecisionInputArgs: {}",
+                    decisionInputArgs.getGrayRequest().getServiceId(),
+                    decisionInputArgs.getServer().getInstanceId(),
+                    decisionLength,
+                    currentDecisionIndex + 1,
+                    testValue,
+                    JsonUtils.toJson(decisionInputArgs));
+        } catch (IOException e) {
+            log.error("", e);
+        }
+
+    }
 }
diff --git a/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/decision/BringPolicyDefinitionGrayDecision.java b/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/decision/BringPolicyDefinitionGrayDecision.java
@@ -0,0 +1,22 @@
+package cn.springcloud.gray.decision;
+
+import cn.springcloud.gray.model.PolicyDefinition;
+
+/**
+ * @author saleson
+ * @date 2020-07-28 19:22
+ */
+public class BringPolicyDefinitionGrayDecision extends GrayDecisionDelegater {
+
+    private PolicyDefinition policyDefinition;
+
+    public BringPolicyDefinitionGrayDecision(GrayDecision delegate, PolicyDefinition policyDefinition) {
+        super(delegate);
+        this.policyDefinition = policyDefinition;
+    }
+
+
+    public PolicyDefinition getPolicyDefinition() {
+        return policyDefinition;
+    }
+}
diff --git a/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/decision/GrayDecisionDelegater.java b/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/decision/GrayDecisionDelegater.java
@@ -0,0 +1,19 @@
+package cn.springcloud.gray.decision;
+
+/**
+ * @author saleson
+ * @date 2020-07-28 19:19
+ */
+public class GrayDecisionDelegater implements GrayDecision {
+
+    private GrayDecision delegate;
+
+    public GrayDecisionDelegater(GrayDecision delegate) {
+        this.delegate = delegate;
+    }
+
+    @Override
+    public boolean test(GrayDecisionInputArgs args) {
+        return delegate.test(args);
+    }
+}
diff --git a/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/servernode/AbstractServerListProcessor.java b/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/servernode/AbstractServerListProcessor.java
@@ -3,11 +3,15 @@
 import cn.springcloud.gray.client.config.properties.GrayHoldoutServerProperties;
 import cn.springcloud.gray.model.InstanceStatus;
 import org.apache.commons.collections.CollectionUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.List;
 
 public abstract class AbstractServerListProcessor<S> implements ServerListProcessor<S> {
 
+    private static Logger log = LoggerFactory.getLogger(AbstractServerListProcessor.class);
+
     protected GrayHoldoutServerProperties grayHoldoutServerProperties;
 
     public AbstractServerListProcessor(GrayHoldoutServerProperties grayHoldoutServerProperties) {
@@ -16,14 +20,20 @@ public AbstractServerListProcessor(GrayHoldoutServerProperties grayHoldoutServer
 
     @Override
     public List<S> process(String serviceId, List<S> servers) {
-        if (!grayHoldoutServerProperties.isEnabled() || CollectionUtils.isEmpty(getHoldoutInstanceStatus(serviceId))) {
+        if (!grayHoldoutServerProperties.isEnabled()) {
+            log.debug("破窗开关未打开，返回原实例列表");
+            return servers;
+        }
+
+        if (CollectionUtils.isEmpty(getHoldoutInstanceStatus(serviceId))) {
+            log.debug("未设置服务 {} 的破窗实例状态，返回原实例列表", serviceId);
             return servers;
         }
 
         return getServers(serviceId, servers);
     }
 
-    protected List<InstanceStatus> getHoldoutInstanceStatus(String serviceId){
+    protected List<InstanceStatus> getHoldoutInstanceStatus(String serviceId) {
         return grayHoldoutServerProperties.getServices().get(serviceId);
     }
 
diff --git a/spring-cloud-gray-plugins/spring-cloud-gray-plugin-eureka/src/main/java/cn/springcloud/gray/client/netflix/eureka/EurekaServerListProcessor.java b/spring-cloud-gray-plugins/spring-cloud-gray-plugin-eureka/src/main/java/cn/springcloud/gray/client/netflix/eureka/EurekaServerListProcessor.java
@@ -47,15 +47,28 @@ public EurekaServerListProcessor(GrayHoldoutServerProperties grayHoldoutServerPr
 
     @Override
     public List<Server> process(String serviceId, List<Server> servers) {
-        if (!grayHoldoutServerProperties.isEnabled() || CollectionUtils.isEmpty(grayHoldoutServerProperties.getServices().get(serviceId))) {
+
+        if (!grayHoldoutServerProperties.isEnabled()) {
+            log.debug("破窗开关未打开，返回原实例列表");
+            return servers;
+        }
+
+
+        List<InstanceStatus> holdoutStatus = grayHoldoutServerProperties.getServices().get(serviceId);
+        if (CollectionUtils.isEmpty(holdoutStatus)) {
+            log.debug("未设置服务 {} 的破窗实例状态，返回原实例列表", serviceId);
             return servers;
         }
 
+
+        String cacheKey = serviceId + ";" + StringUtils.join(holdoutStatus, ",");
+
         List<Server> serverList = null;
 
         if (grayHoldoutServerProperties.isCacheable()) {
-            serverList = serversMap.get(serviceId);
+            serverList = serversMap.get(cacheKey);
             if (CollectionUtils.isNotEmpty(serverList)) {
+                log.debug("通过破窗能力，{} 服务从缓存中获取新的实例列表{}", serviceId, serverList);
                 return serverList;
             }
         }
@@ -66,8 +79,9 @@ public List<Server> process(String serviceId, List<Server> servers) {
             serverList = ListUtils.union(servers, unUpServers);
         }
         if (grayHoldoutServerProperties.isCacheable()) {
-            serversMap.put(serviceId, serverList);
+            serversMap.put(cacheKey, serverList);
         }
+        log.debug("通过破窗能力，{} 服务实例列表新增{}个实例，新列表:{}", serviceId, unUpServers.size(), serverList);
         return serverList;
     }
 
diff --git a/spring-cloud-gray-plugins/spring-cloud-gray-plugin-ribbon-nacos-discovery/src/main/java/cn/springcloud/gray/client/plugin/ribbon/nacos/NacosServerListProcessor.java b/spring-cloud-gray-plugins/spring-cloud-gray-plugin-ribbon-nacos-discovery/src/main/java/cn/springcloud/gray/client/plugin/ribbon/nacos/NacosServerListProcessor.java
diff --git a/spring-cloud-gray-utils/pom.xml b/spring-cloud-gray-utils/pom.xml
diff --git a/spring-cloud-gray-utils/src/main/java/cn/springcloud/gray/utils/JsonUtils.java b/spring-cloud-gray-utils/src/main/java/cn/springcloud/gray/utils/JsonUtils.java
