api指标属性

miaoguoxin
1 parent 119865e8
Showing 12 changed files with 138 additions and 8 deletions
gateway-business/src/main/resources/bootstrap.yml
gateway-core/src/main/java/com/diligrp/xtrade/core/common/utils/HttpUtils.java
gateway-core/src/main/java/com/diligrp/xtrade/core/common/utils/ResponseUtils.java
gateway-core/src/main/java/com/diligrp/xtrade/core/config/property/ApiMetricsProperties.java
gateway-core/src/main/java/com/diligrp/xtrade/core/filters/factory/DispatchGatewayFilterFactory.java
gateway-core/src/main/java/com/diligrp/xtrade/core/filters/web/FacadeWebFilter.java
gateway-core/src/main/java/com/diligrp/xtrade/core/repository/GatewayRepository.java
gateway-core/src/main/java/com/diligrp/xtrade/core/repository/entity/ApiMetricsInfoEntity.java
gateway-core/src/main/java/com/diligrp/xtrade/core/support/ApiMetricsCollector.java
gateway-core/src/main/java/com/diligrp/xtrade/core/support/ApiMetricsInfo.java
gateway-core/src/main/resources/mapper/ApiMetricsMapper.xml
sql/gateway-1.0.0.sql
@@ -25,3 +25,7 @@ mybatis:
 xtrade:
   gateway-loader: cloud
   aggregation-scan-packages: com.diligrp.xtrade.business.application
+  api-metrics:
+    time-unit: seconds
+    collect-num: 5
+    timeout: 10
+package com.diligrp.xtrade.core.common.utils;
+
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.server.reactive.ServerHttpRequest;
+
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * @Auther: miaoguoxin
+ * @Date: 2020/4/24 10:23
+ */
+public class HttpUtils {
+    /**
+     * @Description: 获取客户端IP地址
+     */
+    public static String getIpAddr(ServerHttpRequest request) {
+        if (request==null){
+            return "127.0.0.1";
+        }
+        HttpHeaders headers = request.getHeaders();
+        String ip = headers.getFirst("x-forwarded-for");
+        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
+            ip = headers.getFirst("Proxy-Client-IP");
+        }
+        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
+            ip = headers.getFirst("WL-Proxy-Client-IP");
+        }
+        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
+            ip = request.getRemoteAddress() == null ? "unknown" : request.getRemoteAddress().getHostString();
+        }
+        return "0:0:0:0:0:0:0:1".equals(ip) ? "127.0.0.1" : ip;
+    }
+}
@@ -18,12 +18,12 @@ public class ResponseUtils {
  
  
     public static Mono<Void> writeForbidden(ServerHttpResponse response){
-        Message message = Message.failure(
+        Message<?> message = Message.failure(
                 HttpStatus.FORBIDDEN.value(),HttpStatus.FORBIDDEN.toString());
         return writeResponse(response,message);
     }
  
-    public static Mono<Void> writeResponse(ServerHttpResponse response,Message<Object> message){
+    public static Mono<Void> writeResponse(ServerHttpResponse response,Message<?> message){
         String respJson = JsonUtils.toJsonString(message);
         response.getHeaders().setContentLength(
                 respJson.getBytes(StandardCharsets.UTF_8).length);
+package com.diligrp.xtrade.core.config.property;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+import org.springframework.validation.annotation.Validated;
+
+import javax.validation.constraints.Min;
+import javax.validation.constraints.NotNull;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * @Auther: miaoguoxin
+ * @Date: 2020/4/24 10:54
+ * @Description: api指标收集配置属性
+ */
+@Component
+@ConfigurationProperties(prefix = "xtrade.api-metrics")
+@Validated
+public class ApiMetricsProperties {
+    /**每次收集多少个*/
+    @NotNull
+    @Min(value = 1)
+    private Integer collectNum = 50;
+    /**收集超时时间，表示若每次不满collectNum,但超过了该时间，也会进行收集*/
+    @NotNull
+    @Min(value = 1)
+    private Long timeout = 10L;
+    @NotNull
+    private TimeUnit timeUnit = TimeUnit.SECONDS;
+
+    public Integer getCollectNum() {
+        return collectNum;
+    }
+
+    public void setCollectNum(Integer collectNum) {
+        this.collectNum = collectNum;
+    }
+
+    public Long getTimeout() {
+        return timeout;
+    }
+
+    public void setTimeout(Long timeout) {
+        this.timeout = timeout;
+    }
+
+    public TimeUnit getTimeUnit() {
+        return timeUnit;
+    }
+
+    public void setTimeUnit(TimeUnit timeUnit) {
+        this.timeUnit = timeUnit;
+    }
+}
@@ -3,8 +3,6 @@ package com.diligrp.xtrade.core.filters.factory;
 import com.diligrp.xtrade.core.common.constant.GatewayConst;
 import com.diligrp.xtrade.core.common.utils.ResponseUtils;
 import com.diligrp.xtrade.core.support.dispatch.RequestDispatcher;
-import com.diligrp.xtrade.shared.domain.Message;
-import com.diligrp.xtrade.shared.type.ErrorCode;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.cloud.gateway.filter.GatewayFilter;
 import org.springframework.cloud.gateway.filter.GatewayFilterChain;
@@ -51,7 +51,7 @@ public class FacadeWebFilter implements WebFilter {
         ReactiveExchangeContextHolder.put(exchange);
         return chain.filter(exchange)
                 .onErrorResume(throwable -> {
-                    Message<Object> message = handleException(throwable);
+                    Message<?> message = handleException(throwable);
                     exchange.getAttributes().putIfAbsent(GatewayConst.GATEWAY_EXCEPTION_ATTR, throwable);
                     exchange.getAttributes().putIfAbsent(GatewayConst.CACHED_RESPONSE_BODY_STR_ATTR, JsonUtils.toJsonString(message));
                     return ResponseUtils.writeResponse(exchange.getResponse(), message);
@@ -63,7 +63,7 @@ public class FacadeWebFilter implements WebFilter {
     }
  
  
-    private static Message handleException(Throwable ex) {
+    private static Message<?> handleException(Throwable ex) {
         if (ex instanceof GatewayDispatchException) {
             GatewayDispatchException dispatchEx = (GatewayDispatchException) ex;
             if (dispatchEx.getCause() != null) {
@@ -154,6 +154,7 @@ public class GatewayRepository implements IGatewayRepository {
         entity.setMessage(api.getMessage());
         entity.setServiceId(api.getServiceId());
         entity.setUrl(api.getUrl());
+        entity.setClientIp(api.getClientIp());
         entity.setRequestHeader(api.getRequestHeader());
         entity.setRequestBody(api.getRequestBody());
 //        Throwable throwable = api.getThrowable();
@@ -20,6 +20,8 @@ public class ApiMetricsInfoEntity implements Serializable {
     private String serviceId;
     /**目标地址*/
     private String url;
+    /**客户端Ip*/
+    private String clientIp;
     /**请求头*/
     private String requestHeader;
     /**请求体*/
@@ -33,6 +35,14 @@ public class ApiMetricsInfoEntity implements Serializable {
     /**修改时间*/
     private LocalDateTime modifiedTime;
  
+    public String getClientIp() {
+        return clientIp;
+    }
+
+    public void setClientIp(String clientIp) {
+        this.clientIp = clientIp;
+    }
+
     public Long getId() {
         return id;
     }
 package com.diligrp.xtrade.core.support;
  
+import com.diligrp.xtrade.core.config.property.ApiMetricsProperties;
 import com.diligrp.xtrade.core.repository.IGatewayRepository;
 import com.diligrp.xtrade.shared.util.JsonUtils;
 import com.google.common.collect.Queues;
@@ -16,6 +17,7 @@ import java.util.TimerTask;
 import java.util.concurrent.ArrayBlockingQueue;
 import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
  
 /**
  * @Auther: miaoguoxin
@@ -28,8 +30,12 @@ public class ApiMetricsCollector {
  
     private static final BlockingQueue<ApiMetricsInfo> METRICS_QUEUE = new ArrayBlockingQueue<>(1000, true);
  
+    private static final AtomicBoolean HAS_INIT = new AtomicBoolean(false);
+
     @Autowired
     private IGatewayRepository gatewayRepository;
+    @Autowired
+    private ApiMetricsProperties apiMetricsProperties;
  
     public static void addMetricsInfo(ApiMetricsInfo apiMetricsInfo) {
         METRICS_QUEUE.add(apiMetricsInfo);
@@ -37,6 +43,9 @@ public class ApiMetricsCollector {
  
     @PostConstruct
     public void start() {
+        if (!HAS_INIT.compareAndSet(false, true)) {
+            return;
+        }
         Timer timer = new Timer();
         TimerTask task = new TimerTask() {
             @Override
@@ -58,7 +67,10 @@ public class ApiMetricsCollector {
             // 那按道理就不会消费，但是这样显然不合理，所以需要指定当超多多长时间，即使当前队列中数据低于我们设定的阈值也会消费
             //第五个，指定第四个参数的单位，是秒是分钟还是小时等等
             try {
-                Queues.drain(METRICS_QUEUE, metricsInfos, 50, 1, TimeUnit.MINUTES);
+                Queues.drain(METRICS_QUEUE, metricsInfos,
+                        apiMetricsProperties.getCollectNum(),
+                        apiMetricsProperties.getTimeout(),
+                        apiMetricsProperties.getTimeUnit());
                 gatewayRepository.addApiMetrics(metricsInfos);
             } catch (Exception e) {
                 log.error("collect api metrics error:", e);
 package com.diligrp.xtrade.core.support;
  
 import com.diligrp.xtrade.core.common.constant.GatewayConst;
+import com.diligrp.xtrade.core.common.utils.HttpUtils;
 import com.diligrp.xtrade.shared.domain.Message;
 import com.diligrp.xtrade.shared.util.JsonUtils;
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -11,6 +12,7 @@ import org.slf4j.LoggerFactory;
 import org.springframework.cloud.gateway.route.Route;
 import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
 import org.springframework.http.HttpHeaders;
+import org.springframework.http.server.reactive.ServerHttpRequest;
 import org.springframework.web.server.ServerWebExchange;
  
 import java.net.URI;
@@ -34,6 +36,8 @@ public class ApiMetricsInfo {
     private String serviceId;
     /**目标地址*/
     private String url;
+    /**请求客户端的ip*/
+    private String clientIp;
     /**请求头*/
     private String requestHeader;
     /**请求体*/
@@ -50,6 +54,7 @@ public class ApiMetricsInfo {
                           String message,
                           String serviceId,
                           String url,
+                          String clientIp,
                           String requestHeaders,
                           String requestBody,
                           Throwable throwable,
@@ -58,6 +63,7 @@ public class ApiMetricsInfo {
         this.message = message;
         this.serviceId = serviceId;
         this.url = url;
+        this.clientIp = clientIp;
         this.requestHeader = requestHeaders;
         this.requestBody = requestBody;
         this.throwable = throwable;
@@ -71,6 +77,7 @@ public class ApiMetricsInfo {
             if (Strings.isNotBlank(responseJson)) {
                 Message<Object> message = JsonUtils.fromJsonString(responseJson, new TypeReference<>() {
                 });
+                ServerHttpRequest request = exchange.getRequest();
                 URI uri = exchange.getAttribute(ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR);
                 Route route = exchange.getAttribute(ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR);
                 String requestBody = exchange.getAttribute(GatewayConst.CACHED_REQUEST_BODY_STR_ATTR);
@@ -80,7 +87,8 @@ public class ApiMetricsInfo {
                         message.getMessage(),
                         route != null ? route.getId() : "unknown",
                         uri != null ? uri.toString() : "unknown",
-                        getRequestHeaderJson(exchange.getRequest().getHeaders()),
+                        HttpUtils.getIpAddr(request),
+                        getRequestHeaderJson(request.getHeaders()),
                         requestBody,
                         throwable,
                         time);
@@ -114,6 +122,10 @@ public class ApiMetricsInfo {
         return url;
     }
  
+    public String getClientIp() {
+        return clientIp;
+    }
+
     public String getRequestBody() {
         return requestBody;
     }
@@ -8,6 +8,7 @@
         <result property="message" column="message"/>
         <result property="serviceId" column="service_id"/>
         <result property="url" column="url"/>
+        <result property="clientIp" column="client_ip"/>
         <result property="requestHeader" column="request_header"/>
         <result property="requestBody" column="request_body"/>
         <result property="stackTrace" column="stack_trace"/>
@@ -20,6 +21,7 @@
                                   message,
                                   service_id,
                                   url,
+                                  client_ip,
                                   request_header,
                                   request_body,
                                   stack_trace,
@@ -33,6 +35,7 @@
             #{item.message},
             #{item.serviceId},
             #{item.url},
+            #{item.clientIp},
             #{item.requestHeader},
             #{item.requestBody},
             #{item.stackTrace},
@@ -55,3 +55,6 @@ CREATE TABLE `t_api_metrics`
   ROW_FORMAT = Compact;
  
 SET FOREIGN_KEY_CHECKS = 1;
+
+ALTER TABLE `xtrade_gateway`.`t_api_metrics`
+    ADD COLUMN client_ip` varchar(40) NULL COMMENT '客户端ip' AFTER `url`;