添加各插件拦截请求前后的finest级别日志

sermant-io · Mar 25, 2023 · 96fcbc6 · 96fcbc6
1 parent 643638f
commit 96fcbc6
Show file tree

Hide file tree

Showing 23 changed files with 207 additions and 18 deletions.
diff --git a/...ore/sermant-agentcore-core/src/main/java/com/huaweicloud/sermant/core/utils/LogUtils.java b/...ore/sermant-agentcore-core/src/main/java/com/huaweicloud/sermant/core/utils/LogUtils.java
@@ -0,0 +1,96 @@
+/*
+ * Copyright (C) 2023-2023 Huawei Technologies Co., Ltd. All rights reserved.
+ *
+ * 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 com.huaweicloud.sermant.core.utils;
+
+import com.huaweicloud.sermant.core.common.LoggerFactory;
+import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
+
+import java.util.Locale;
+import java.util.logging.Logger;
+
+/**
+ * 日志工具类
+ *
+ * @author lilai
+ * @since 2023-03-24
+ */
+public class LogUtils {
+    private static final Logger LOGGER = LoggerFactory.getLogger();
+
+    private LogUtils() {
+    }
+
+    /**
+     * 打印Dubbo请求拦截Before切面日志
+     *
+     * @param context 拦截上下文
+     */
+    public static void printDubboRequestBeforePoint(ExecuteContext context) {
+        LOGGER.finest(() -> String.format(Locale.ROOT, "[Request Intercepted by Sermant][Before] Dubbo request: %s",
+                context));
+    }
+
+    /**
+     * 打印Dubbo请求拦截After切面日志
+     *
+     * @param context 拦截上下文
+     */
+    public static void printDubboRequestAfterPoint(ExecuteContext context) {
+        LOGGER.finest(() -> String.format(Locale.ROOT, "[Request Intercepted by Sermant][After] Dubbo request: %s",
+                context));
+    }
+
+    /**
+     * 打印Dubbo请求拦截OnThrow切面日志
+     *
+     * @param context 拦截上下文
+     */
+    public static void printDubboRequestOnThrowPoint(ExecuteContext context) {
+        LOGGER.finest(String.format(Locale.ROOT, "[Request Intercepted by Sermant][OnThrow] Dubbo request: %s",
+                context));
+    }
+
+    /**
+     * 打印HTTP请求拦截Before切面日志
+     *
+     * @param context 拦截上下文
+     */
+    public static void printHttpRequestBeforePoint(ExecuteContext context) {
+        LOGGER.finest(String.format(Locale.ROOT, "[Request Intercepted by Sermant][Before] HTTP request: %s",
+                context));
+    }
+
+    /**
+     * 打印HTTP请求拦截After切面日志
+     *
+     * @param context 拦截上下文
+     */
+    public static void printHttpRequestAfterPoint(ExecuteContext context) {
+        LOGGER.finest(String.format(Locale.ROOT, "[Request Intercepted by Sermant][After] HTTP request: %s",
+                context));
+    }
+
+    /**
+     * 打印HTTP请求拦截OnThrow切面日志
+     *
+     * @param context 拦截上下文
+     */
+    public static void printHttpRequestOnThrowPoint(ExecuteContext context) {
+        LOGGER.finest(String.format(Locale.ROOT, "[Request Intercepted by Sermant][OnThrow] HTTP request: %s",
+                context));
+    }
+}
diff --git a/...trol/flowcontrol-plugin/src/main/java/com/huawei/flowcontrol/AlibabaDubboInterceptor.java b/...trol/flowcontrol-plugin/src/main/java/com/huawei/flowcontrol/AlibabaDubboInterceptor.java
@@ -28,6 +28,7 @@
 
 import com.huaweicloud.sermant.core.common.LoggerFactory;
 import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
+import com.huaweicloud.sermant.core.utils.LogUtils;
 
 import com.alibaba.dubbo.common.URL;
 import com.alibaba.dubbo.rpc.Invocation;
@@ -97,6 +98,7 @@ private String getApplication(URL url, String interfaceName, boolean isProvider)
 
     @Override
     protected final ExecuteContext doBefore(ExecuteContext context) {
+        LogUtils.printDubboRequestBeforePoint(context);
         final Object[] allArguments = context.getArguments();
         final FlowControlResult result = new FlowControlResult();
         if (allArguments[1] instanceof Invocation) {
@@ -156,12 +158,14 @@ protected final ExecuteContext doAfter(ExecuteContext context) {
         if (isProvider) {
             FlowControlContext.INSTANCE.clear();
         }
+        LogUtils.printDubboRequestAfterPoint(context);
         return context;
     }
 
     @Override
     protected final ExecuteContext doThrow(ExecuteContext context) {
         chooseDubboService().onThrow(className, context.getThrowable(), isProvider(context));
+        LogUtils.printDubboRequestOnThrowPoint(context);
         return context;
     }
 

diff --git a/...ntrol/flowcontrol-plugin/src/main/java/com/huawei/flowcontrol/ApacheDubboInterceptor.java b/...ntrol/flowcontrol-plugin/src/main/java/com/huawei/flowcontrol/ApacheDubboInterceptor.java
@@ -28,6 +28,7 @@
 
 import com.huaweicloud.sermant.core.common.LoggerFactory;
 import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
+import com.huaweicloud.sermant.core.utils.LogUtils;
 import com.huaweicloud.sermant.core.utils.ReflectUtils;
 
 import org.apache.dubbo.common.URL;
@@ -105,6 +106,7 @@ private String getApplication(URL url, String interfaceName, boolean isProvider)
 
     @Override
     protected final ExecuteContext doBefore(ExecuteContext context) {
+        LogUtils.printDubboRequestBeforePoint(context);
         final Object[] allArguments = context.getArguments();
         if (allArguments[1] instanceof Invocation) {
             final FlowControlResult result = new FlowControlResult();
@@ -197,12 +199,14 @@ protected final ExecuteContext doAfter(ExecuteContext context) {
         if (isProvider) {
             FlowControlContext.INSTANCE.clear();
         }
+        LogUtils.printDubboRequestAfterPoint(context);
         return context;
     }
 
     @Override
     protected final ExecuteContext doThrow(ExecuteContext context) {
         chooseDubboService().onThrow(className, context.getThrowable(), isProvider(context));
+        LogUtils.printDubboRequestOnThrowPoint(context);
         return context;
     }
 

diff --git a/...flowcontrol-plugin/src/main/java/com/huawei/flowcontrol/DispatcherServletInterceptor.java b/...flowcontrol-plugin/src/main/java/com/huawei/flowcontrol/DispatcherServletInterceptor.java
@@ -23,6 +23,7 @@
 import com.huawei.flowcontrol.service.InterceptorSupporter;
 
 import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
+import com.huaweicloud.sermant.core.utils.LogUtils;
 
 import java.util.Collections;
 import java.util.Enumeration;
@@ -80,6 +81,7 @@ private Map<String, String> getHeaders(HttpServletRequest request) {
 
     @Override
     protected final ExecuteContext doBefore(ExecuteContext context) throws Exception {
+        LogUtils.printHttpRequestBeforePoint(context);
         final Object[] allArguments = context.getArguments();
         final HttpServletRequest argument = (HttpServletRequest) allArguments[0];
         final FlowControlResult result = new FlowControlResult();
@@ -102,12 +104,14 @@ protected final ExecuteContext doBefore(ExecuteContext context) throws Exception
     @Override
     protected final ExecuteContext doAfter(ExecuteContext context) {
         chooseHttpService().onAfter(className, context.getResult());
+        LogUtils.printHttpRequestAfterPoint(context);
         return context;
     }
 
     @Override
     protected final ExecuteContext doThrow(ExecuteContext context) {
         chooseHttpService().onThrow(className, context.getThrowable());
+        LogUtils.printHttpRequestOnThrowPoint(context);
         return context;
     }
 }
diff --git a/.../monitor-plugin/src/main/java/com/huawei/monitor/interceptor/AlibabaDubboInterceptor.java b/.../monitor-plugin/src/main/java/com/huawei/monitor/interceptor/AlibabaDubboInterceptor.java
@@ -23,6 +23,7 @@
 
 import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
 import com.huaweicloud.sermant.core.plugin.agent.interceptor.AbstractInterceptor;
+import com.huaweicloud.sermant.core.utils.LogUtils;
 
 import com.alibaba.dubbo.rpc.Invocation;
 import com.alibaba.dubbo.rpc.Invoker;
@@ -43,6 +44,7 @@ public class AlibabaDubboInterceptor extends AbstractInterceptor {
 
     @Override
     public ExecuteContext before(ExecuteContext context) {
+        LogUtils.printDubboRequestBeforePoint(context);
         if (context == null || context.getArguments() == null || context.getArguments().length < 1) {
             return context;
         }
@@ -65,6 +67,7 @@ public ExecuteContext before(ExecuteContext context) {
     @Override
     public ExecuteContext after(ExecuteContext context) {
         if (context.getExtMemberFieldValue(MONITOR_NAME) == null) {
+            LogUtils.printDubboRequestAfterPoint(context);
             return context;
         }
         String name = (String) context.getExtMemberFieldValue(MONITOR_NAME);
@@ -73,18 +76,21 @@ public ExecuteContext after(ExecuteContext context) {
         long startTime = (Long) context.getExtMemberFieldValue(START_TIME);
         metricCalEntity.getConsumeReqTimeNum().addAndGet(System.currentTimeMillis() - startTime);
         metricCalEntity.getSuccessFulReqNum().incrementAndGet();
+        LogUtils.printDubboRequestAfterPoint(context);
         return context;
     }
 
     @Override
     public ExecuteContext onThrow(ExecuteContext context) {
         if (context.getExtMemberFieldValue(MONITOR_NAME) == null) {
+            LogUtils.printDubboRequestOnThrowPoint(context);
             return context;
         }
         String name = (String) context.getExtMemberFieldValue(MONITOR_NAME);
         MetricCalEntity metricCalEntity = MonitorCacheUtil.getMetricCalEntity(name);
         metricCalEntity.getFailedReqNum().incrementAndGet();
         metricCalEntity.getReqNum().incrementAndGet();
+        LogUtils.printDubboRequestOnThrowPoint(context);
         return context;
     }
 

diff --git a/...r/monitor-plugin/src/main/java/com/huawei/monitor/interceptor/ApacheDubboInterceptor.java b/...r/monitor-plugin/src/main/java/com/huawei/monitor/interceptor/ApacheDubboInterceptor.java
@@ -23,6 +23,7 @@
 
 import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
 import com.huaweicloud.sermant.core.plugin.agent.interceptor.AbstractInterceptor;
+import com.huaweicloud.sermant.core.utils.LogUtils;
 
 import org.apache.dubbo.rpc.Invocation;
 import org.apache.dubbo.rpc.Invoker;
@@ -43,6 +44,7 @@ public class ApacheDubboInterceptor extends AbstractInterceptor {
 
     @Override
     public ExecuteContext before(ExecuteContext context) {
+        LogUtils.printDubboRequestBeforePoint(context);
         if (context == null || context.getArguments() == null || context.getArguments().length < 1) {
             return context;
         }
@@ -65,6 +67,7 @@ public ExecuteContext before(ExecuteContext context) {
     @Override
     public ExecuteContext after(ExecuteContext context) {
         if (context.getExtMemberFieldValue(MONITOR_NAME) == null) {
+            LogUtils.printDubboRequestAfterPoint(context);
             return context;
         }
         String name = (String) context.getExtMemberFieldValue(MONITOR_NAME);
@@ -73,18 +76,21 @@ public ExecuteContext after(ExecuteContext context) {
         long startTime = (Long) context.getExtMemberFieldValue(START_TIME);
         metricCalEntity.getConsumeReqTimeNum().addAndGet(System.currentTimeMillis() - startTime);
         metricCalEntity.getSuccessFulReqNum().incrementAndGet();
+        LogUtils.printDubboRequestAfterPoint(context);
         return context;
     }
 
     @Override
     public ExecuteContext onThrow(ExecuteContext context) {
         if (context.getExtMemberFieldValue(MONITOR_NAME) == null) {
+            LogUtils.printDubboRequestOnThrowPoint(context);
             return context;
         }
         String name = (String) context.getExtMemberFieldValue(MONITOR_NAME);
         MetricCalEntity metricCalEntity = MonitorCacheUtil.getMetricCalEntity(name);
         metricCalEntity.getFailedReqNum().incrementAndGet();
         metricCalEntity.getReqNum().incrementAndGet();
+        LogUtils.printDubboRequestOnThrowPoint(context);
         return context;
     }
 

diff --git a/...tor-plugin/src/main/java/com/huawei/monitor/interceptor/DispatcherServletInterceptor.java b/...tor-plugin/src/main/java/com/huawei/monitor/interceptor/DispatcherServletInterceptor.java
@@ -22,6 +22,7 @@
 
 import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
 import com.huaweicloud.sermant.core.plugin.agent.interceptor.AbstractInterceptor;
+import com.huaweicloud.sermant.core.utils.LogUtils;
 
 import javax.servlet.http.HttpServletRequest;
 
@@ -36,6 +37,7 @@ public class DispatcherServletInterceptor extends AbstractInterceptor {
 
     @Override
     public ExecuteContext before(ExecuteContext context) {
+        LogUtils.printHttpRequestBeforePoint(context);
         if (checkContext(context)) {
             return context;
         }
@@ -46,6 +48,7 @@ public ExecuteContext before(ExecuteContext context) {
     @Override
     public ExecuteContext after(ExecuteContext context) {
         if (checkContext(context) || context.getExtMemberFieldValue(START_TIME) == null) {
+            LogUtils.printHttpRequestAfterPoint(context);
             return context;
         }
         HttpServletRequest request = (HttpServletRequest) context.getArguments()[0];
@@ -54,6 +57,7 @@ public ExecuteContext after(ExecuteContext context) {
         long startTime = (Long) context.getExtMemberFieldValue(START_TIME);
         metricCalEntity.getConsumeReqTimeNum().addAndGet(System.currentTimeMillis() - startTime);
         metricCalEntity.getSuccessFulReqNum().incrementAndGet();
+        LogUtils.printHttpRequestAfterPoint(context);
         return context;
     }
 
@@ -64,12 +68,14 @@ private static boolean checkContext(ExecuteContext context) {
     @Override
     public ExecuteContext onThrow(ExecuteContext context) {
         if (checkContext(context)) {
+            LogUtils.printHttpRequestOnThrowPoint(context);
             return context;
         }
         HttpServletRequest request = (HttpServletRequest) context.getArguments()[0];
         MetricCalEntity metricCalEntity = MonitorCacheUtil.getMetricCalEntity(request.getRequestURI());
         metricCalEntity.getReqNum().incrementAndGet();
         metricCalEntity.getFailedReqNum().incrementAndGet();
+        LogUtils.printHttpRequestOnThrowPoint(context);
         return context;
     }
 }
diff --git a/...n/java/com/huaweicloud/sermant/router/dubbo/interceptor/AbstractDirectoryInterceptor.java b/...n/java/com/huaweicloud/sermant/router/dubbo/interceptor/AbstractDirectoryInterceptor.java
@@ -19,6 +19,7 @@
 import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
 import com.huaweicloud.sermant.core.plugin.agent.interceptor.AbstractInterceptor;
 import com.huaweicloud.sermant.core.service.ServiceManager;
+import com.huaweicloud.sermant.core.utils.LogUtils;
 import com.huaweicloud.sermant.router.dubbo.service.AbstractDirectoryService;
 
 /**
@@ -39,13 +40,15 @@ public AbstractDirectoryInterceptor() {
 
     @Override
     public ExecuteContext before(ExecuteContext context) {
+        LogUtils.printDubboRequestBeforePoint(context);
         return context;
     }
 
     @Override
     public ExecuteContext after(ExecuteContext context) {
         context.changeResult(abstractDirectoryService.selectInvokers(context.getObject(), context.getArguments(),
                 context.getResult()));
+        LogUtils.printDubboRequestAfterPoint(context);
         return context;
     }
 }
diff --git a/.../java/com/huaweicloud/sermant/router/spring/interceptor/ClientHttpRequestInterceptor.java b/.../java/com/huaweicloud/sermant/router/spring/interceptor/ClientHttpRequestInterceptor.java
@@ -18,6 +18,7 @@
 
 import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
 import com.huaweicloud.sermant.core.plugin.agent.interceptor.AbstractInterceptor;
+import com.huaweicloud.sermant.core.utils.LogUtils;
 import com.huaweicloud.sermant.router.common.request.RequestData;
 import com.huaweicloud.sermant.router.common.request.RequestTag;
 import com.huaweicloud.sermant.router.common.utils.ThreadLocalUtils;
@@ -39,6 +40,7 @@
 public class ClientHttpRequestInterceptor extends AbstractInterceptor {
     @Override
     public ExecuteContext before(ExecuteContext context) {
+        LogUtils.printHttpRequestBeforePoint(context);
         Object obj = context.getObject();
         if (obj instanceof HttpRequest) {
             HttpRequest request = (HttpRequest) obj;
@@ -53,12 +55,14 @@ public ExecuteContext before(ExecuteContext context) {
     @Override
     public ExecuteContext after(ExecuteContext context) {
         ThreadLocalUtils.removeRequestData();
+        LogUtils.printHttpRequestAfterPoint(context);
         return context;
     }
 
     @Override
     public ExecuteContext onThrow(ExecuteContext context) {
         ThreadLocalUtils.removeRequestData();
+        LogUtils.printHttpRequestOnThrowPoint(context);
         return context;
     }