feat: 日志功能

1、操作日志功能
2、异常日志功能

 package org.thingsboard.server.config.yunteng;
 
+import com.datastax.oss.driver.api.core.uuid.Uuids;
 import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.security.access.AccessDeniedException;
-import org.springframework.security.authentication.AccountExpiredException;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.thingsboard.server.common.data.EntityType;
+import org.thingsboard.server.common.data.asset.Asset;
+import org.thingsboard.server.common.data.audit.ActionType;
+import org.thingsboard.server.common.data.exception.ThingsboardErrorCode;
+import org.thingsboard.server.common.data.exception.ThingsboardException;
+import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.yunteng.core.exception.*;
 import org.thingsboard.server.common.data.yunteng.core.message.ErrorMessage;
+import org.thingsboard.server.common.data.yunteng.dto.SysLogOperateDTO;
+import org.thingsboard.server.dao.audit.AuditLogService;
 import org.thingsboard.server.exception.yunteng.YunTengErrorResponseHandler;
+import org.thingsboard.server.service.security.model.SecurityUser;
+import org.thingsboard.server.utils.yunteng.LogUtils;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import java.util.Objects;
+import java.util.UUID;
 
 @ControllerAdvice(basePackages = "org.thingsboard.server.controller.yunteng")
 @RequiredArgsConstructor
+@Slf4j
 public class ControllerExceptionHandler {
 
+  private final AuditLogService auditLogService;
   private final YunTengErrorResponseHandler errorResponseHandler;
 
   @ExceptionHandler(YunTengException.class)
-  public void handleYunTengException(YunTengException ex, HttpServletResponse response) {
+  public void handleYunTengException(YunTengException ex,HttpServletRequest request,  HttpServletResponse response) {
+    produceLog( request, ex);
     errorResponseHandler.handle(ex, response);
   }
 
   @ExceptionHandler(MethodArgumentNotValidException.class)
   public void handleMethodArgumentNotValidException(
-      MethodArgumentNotValidException ex, HttpServletResponse response) {
+      MethodArgumentNotValidException ex,HttpServletRequest request,  HttpServletResponse response) {
+    produceLog( request, ex);
     errorResponseHandler.handle(
         new YunTengException(
             ErrorMessage.INVALID_PARAMETER.setMessage(
@@ -40,6 +59,7 @@ public class ControllerExceptionHandler {
   @ExceptionHandler(YtDataValidationException.class)
   public void handleDataValidationException(
       YtDataValidationException ex, HttpServletRequest request, HttpServletResponse response) {
+    produceLog( request, ex);
     YunTengException YunTengException =
         new YunTengException(
             ErrorMessage.BAD_PARAMETER.setMessage(ex.getMessage()), HttpStatus.BAD_REQUEST);
@@ -54,7 +74,8 @@ public class ControllerExceptionHandler {
   }
 
   @ExceptionHandler(AccessDeniedException.class)
-  public void handleAccessDeniedException(AccessDeniedException ex, HttpServletResponse response) {
+  public void handleAccessDeniedException(AccessDeniedException ex,HttpServletRequest request,  HttpServletResponse response) {
+    produceLog( request, ex);
     errorResponseHandler.handle(
         new YunTengException(
             ErrorMessage.ACCESS_DENIED.setMessage(ex.getMessage()), HttpStatus.FORBIDDEN),
@@ -63,7 +84,8 @@ public class ControllerExceptionHandler {
 
   @ExceptionHandler(NoneTenantAssetException.class)
   public void handleNoneTenantAssetException(
-      NoneTenantAssetException ex, HttpServletResponse response) {
+      NoneTenantAssetException ex, HttpServletRequest request, HttpServletResponse response) {
+    produceLog( request, ex);
     errorResponseHandler.handle(
         new YunTengException(
             ErrorMessage.NONE_TENANT_ASSET.setMessage(ex.getMessage()), HttpStatus.NOT_FOUND),
@@ -77,4 +99,58 @@ public class ControllerExceptionHandler {
             ErrorMessage.SEND_DESTINATION_NOT_FOUND, HttpStatus.PRECONDITION_FAILED),
         response);
   }
+
+
+
+  protected SecurityUser getCurrentUser() throws ThingsboardException {
+    Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+    if (authentication != null && authentication.getPrincipal() instanceof SecurityUser) {
+      return (SecurityUser) authentication.getPrincipal();
+    } else {
+      throw new ThingsboardException("You aren't authorized to perform this operation!", ThingsboardErrorCode.AUTHENTICATION);
+    }
+  }
+
+  /**
+   * 生产日志并缓存到队列中
+   *
+   * @param request  响应头
+   * @param e 异常信息
+   */
+  void produceLog(HttpServletRequest request, Exception e)  {
+
+    try {
+      SecurityUser currentUser =  getCurrentUser();
+
+      Asset entity = new Asset();
+      entity.setName(e.getMessage());
+
+      //请求相关信息
+      SysLogOperateDTO additionalInfo = new SysLogOperateDTO();
+      additionalInfo.setApi(request.getRequestURI());
+      additionalInfo.setClientIp(LogUtils.clientIP(request));
+      additionalInfo.setServerIp(LogUtils.serverIP());
+      additionalInfo.setUserAgent(request.getHeader(HttpHeaders.USER_AGENT));
+      additionalInfo.setMethod(request.getMethod());
+
+
+      EntityId operateId = new EntityId() {
+        @Override
+        public UUID getId() {
+          return Uuids.timeBased();
+        }
+
+        @Override
+        public EntityType getEntityType() {
+          return EntityType.RUNNING_EXCEPTION;
+        }
+      };
+
+
+      auditLogService.logEntityAction(currentUser.getTenantId(),currentUser.getCustomerId(),currentUser.getId(), currentUser.getName(), operateId,entity, ActionType.LOG_EXCEPTION,e,additionalInfo);
+    } catch (ThingsboardException ex) {
+      log.error("异常日志记录异常【{}】",ex);
+    }
+
+  }
 }

@@ -19,6 +19,7 @@ import org.thingsboard.server.common.data.yunteng.dto.SceneLinkageDTO;
 import org.thingsboard.server.common.data.yunteng.dto.TriggerDTO;
 import org.thingsboard.server.common.data.yunteng.utils.tools.YtPageData;
 import org.thingsboard.server.controller.BaseController;
+import org.thingsboard.server.controller.yunteng.aspect.annotation.AutoLog;
 import org.thingsboard.server.dao.yunteng.service.SceneLinkageService;
 
 import java.net.URI;
@@ -71,6 +72,7 @@ public class YtSceneLinkageController extends BaseController {
 
   @ApiOperation("查询(分页列表)")
   @GetMapping(params = {PAGE_SIZE, PAGE})
+  @AutoLog("场景联动分页")
   public YtPageData<SceneLinkageDTO> page(
       @RequestParam(PAGE_SIZE) int pageSize,
       @RequestParam(PAGE) int page,

+package org.thingsboard.server.controller.yunteng.aspect;
+
+
+import com.datastax.oss.driver.api.core.uuid.Uuids;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.http.HttpHeaders;
+import org.aspectj.lang.JoinPoint;
+import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.AfterThrowing;
+import org.aspectj.lang.annotation.Around;
+import org.aspectj.lang.annotation.Aspect;
+import org.aspectj.lang.annotation.Pointcut;
+import org.aspectj.lang.reflect.MethodSignature;
+import org.springframework.core.annotation.Order;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.stereotype.Component;
+import org.springframework.web.context.request.RequestAttributes;
+import org.springframework.web.context.request.RequestContextHolder;
+import org.springframework.web.context.request.ServletRequestAttributes;
+import org.thingsboard.server.common.data.EntityType;
+import org.thingsboard.server.common.data.asset.Asset;
+import org.thingsboard.server.common.data.audit.ActionStatus;
+import org.thingsboard.server.common.data.audit.ActionType;
+import org.thingsboard.server.common.data.audit.AuditLog;
+import org.thingsboard.server.common.data.exception.ThingsboardErrorCode;
+import org.thingsboard.server.common.data.exception.ThingsboardException;
+import org.thingsboard.server.common.data.id.EntityId;
+import org.thingsboard.server.common.data.yunteng.dto.SysLogOperateDTO;
+import org.thingsboard.server.controller.yunteng.aspect.annotation.AutoLog;
+import org.thingsboard.server.dao.audit.AuditLogService;
+import org.thingsboard.server.service.security.model.SecurityUser;
+import org.thingsboard.server.utils.yunteng.LogUtils;
+
+import javax.servlet.http.HttpServletRequest;
+import java.lang.reflect.Method;
+import java.util.UUID;
+
+/**
+ *
+ */
+@Aspect
+@Order()
+@Component
+@Slf4j
+public class OperateLogAspect {
+    private final AuditLogService auditLogService;
+
+    public OperateLogAspect(AuditLogService auditLogService) {
+        this.auditLogService = auditLogService;
+    }
+
+
+    /**
+     * AOP监听的切入点
+     * 注解所在方法的方法体为空
+     * 匹配规则可以和逻辑运算符（&&、||、!）配合使用
+     * 匹配规则：注解【"@annotation(com.lifeontrip.base.annotation.RecordLog)"】
+     * 匹配规则：方法【"execution(public * com.lifeontrip.base.controller..*.*(..))"】
+     * 匹配规则：注解【“@within(com.lifeontrip.base.annotation.RecordLog)”】
+     * 匹配规则：代理对象【“@this”】
+     * 匹配规则：类注解【“@target”】
+     * 匹配规则：方法入参【“@args”】
+     */
+    @Pointcut("@annotation(org.thingsboard.server.controller.yunteng.aspect.annotation.AutoLog)")
+    public void accessLog() {
+    }
+
+
+    @Around("accessLog()")
+    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
+
+        /**执行切入点所在方法的业务逻辑*/
+        Object result = joinPoint.proceed();
+
+
+        produceLog(joinPoint, result);
+        return result;
+
+    }
+
+
+    /**
+     * 切入点方法执行异常，调用该方法
+     *
+     * @param joinPoint 切入点相关信息的实例
+     * @param e         切入点抛出的异常
+     */
+    @AfterThrowing(value = "accessLog()", throwing = "e")
+    public void doException(JoinPoint joinPoint, Exception e) {
+        log.error("日志功能AOP异常【{}】", e);
+    }
+
+
+    /**
+     * 生产日志并缓存到队列中
+     *
+     * @param joinPoint  切入点相关信息的实例
+     * @param jsonResult 切入点执行后返回的结果
+     */
+    void produceLog(final JoinPoint joinPoint, Object jsonResult) throws ThingsboardException {
+
+        SecurityUser currentUser = getCurrentUser();
+
+        //方法注解
+        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
+        Method method = signature.getMethod();
+        AutoLog methodAnnotate = method.getAnnotation(AutoLog.class);
+
+        Asset entity = new Asset();
+        if (methodAnnotate != null) {
+            entity.setName(methodAnnotate.value());
+        }
+        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
+        if(requestAttributes == null){
+            return;
+        }
+        HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
+        //请求相关信息
+        SysLogOperateDTO additionalInfo = new SysLogOperateDTO();
+
+
+        additionalInfo.setUserAgent(request.getHeader(HttpHeaders.USER_AGENT));
+        additionalInfo.setData(request.getMethod());
+        additionalInfo.setApi(request.getRequestURI());
+        additionalInfo.setClientIp(LogUtils.clientIP(request));
+        additionalInfo.setServerIp(LogUtils.serverIP());
+        additionalInfo.setUserAgent(request.getHeader(HttpHeaders.USER_AGENT));
+        additionalInfo.setMethod(request.getMethod());
+
+
+        EntityId operateId = new EntityId() {
+            @Override
+            public UUID getId() {
+                return Uuids.timeBased();
+            }
+
+            @Override
+            public EntityType getEntityType() {
+                return EntityType.REST_API;
+            }
+        };
+
+
+        auditLogService.logEntityAction(currentUser.getTenantId(),currentUser.getCustomerId(),currentUser.getId(), currentUser.getName(), operateId,entity, ActionType.LOG_OPERATE,null,additionalInfo);
+    }
+
+    protected SecurityUser getCurrentUser() throws ThingsboardException {
+        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+        if (authentication != null && authentication.getPrincipal() instanceof SecurityUser) {
+            return (SecurityUser) authentication.getPrincipal();
+        } else {
+            throw new ThingsboardException("You aren't authorized to perform this operation!", ThingsboardErrorCode.AUTHENTICATION);
+        }
+    }
+
+}

+package org.thingsboard.server.controller.yunteng.aspect.annotation;
+
+import java.lang.annotation.*;
+
+/**
+ * 操作日志注解
+ *
+ * @author Administrator
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface AutoLog {
+
+    /**
+     * 功能名称
+     */
+    String value() default "";
+
+}

+/**
+ * Copyright © 2016-2021 The Thingsboard Authors
+ *
+ * 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 org.thingsboard.server.utils.yunteng;
+
+import lombok.Data;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+
+import javax.servlet.http.HttpServletRequest;
+import java.io.Serializable;
+import java.net.InetAddress;
+import java.net.UnknownHostException;
+
+@Data
+@Slf4j
+public class LogUtils implements Serializable {
+
+
+    public static String clientIP(HttpServletRequest request) {
+        String ip = null;
+        try {
+            ip = request.getHeader("x-forwarded-for");
+            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
+                ip = request.getHeader("Proxy-Client-IP");
+            }
+            if (StringUtils.isEmpty(ip) || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
+                ip = request.getHeader("WL-Proxy-Client-IP");
+            }
+            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
+                ip = request.getHeader("HTTP_CLIENT_IP");
+            }
+            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
+                ip = request.getHeader("HTTP_X_FORWARDED_FOR");
+            }
+            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
+                ip = request.getRemoteAddr();
+            }
+        } catch (Exception e) {
+            log.error("客户端IP异常【{}】", e);
+        }
+
+        return ip;
+    }
+
+
+    /**
+     * 当前主机IP
+     * @return
+     * @throws UnknownHostException
+     */
+    public static String serverIP() {
+        String ip = null;
+        try {
+            ip = InetAddress.getLocalHost().getHostAddress();
+        } catch (UnknownHostException e) {
+            log.error("服务端IP异常【{}】 ", e);
+        }
+        return ip;
+    }
+
+}

@@ -562,6 +562,8 @@ audit-log:
       "edge": "${AUDIT_LOG_MASK_EDGE:W}"
       "tb_resource": "${AUDIT_LOG_MASK_RESOURCE:W}"
       "ota_package": "${AUDIT_LOG_MASK_OTA_PACKAGE:W}"
+      "running_exception": "${AUDIT_LOG_RUNNING_EXCEPTION:W}"
+      "rest_api": "${AUDIT_LOG_REST_API:W}"
   sink:
     # Type of external sink. possible options: none, elasticsearch
     type: "${AUDIT_LOG_SINK_TYPE:none}"

@@ -19,5 +19,7 @@ package org.thingsboard.server.common.data;
  * @author Andrew Shvayka
  */
 public enum EntityType {
-    TENANT, CUSTOMER, USER, DASHBOARD, ASSET, DEVICE, ALARM, RULE_CHAIN, RULE_NODE, ENTITY_VIEW, WIDGETS_BUNDLE, WIDGET_TYPE, TENANT_PROFILE, DEVICE_PROFILE, API_USAGE_STATE, TB_RESOURCE, OTA_PACKAGE, EDGE, RPC;
+    TENANT, CUSTOMER, USER, DASHBOARD, ASSET, DEVICE, ALARM, RULE_CHAIN, RULE_NODE, ENTITY_VIEW, WIDGETS_BUNDLE, WIDGET_TYPE, TENANT_PROFILE, DEVICE_PROFILE, API_USAGE_STATE, TB_RESOURCE, OTA_PACKAGE, EDGE, RPC
+    //Thingskit function
+    , RUNNING_EXCEPTION, REST_API;
 }

@@ -48,7 +48,10 @@ public enum ActionType {
     PROVISION_SUCCESS(false),
     PROVISION_FAILURE(false),
     ASSIGNED_TO_EDGE(false), // log edge name
-    UNASSIGNED_FROM_EDGE(false);
+    UNASSIGNED_FROM_EDGE(false),
+    //Thingskit function
+    LOG_EXCEPTION(false),
+    LOG_OPERATE(false);
 
     private final boolean isRead;
 

+package org.thingsboard.server.common.data.yunteng.dto;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+@EqualsAndHashCode(callSuper = false)
+@Data
+public class SysLogOperateDTO {
+
+
+  private String serverIp;
+
+
+  private String remark;
+
+
+  private String clientIp;
+  private String clientAddr;
+  private String userAgent;
+  private String api;
+  private String data;
+  private String method;
+}