编写版本:3.5.3;
适用版本:3.5.3+;

配置日志模块

  • 菜单入口:系统管理->系统日志管理->日志模块
  • 业务对象日志配置,模块别名字段值填写业务对象编码;
  • 系统功能日志配置,模块别名字段值填写对应接口编码(也就是接口地址的第一个路径,如:role/save,那么接口编码就是role);

默认接口日志无需配置,会与接口信息自动匹配并默认记录日志;
需要关闭接口日志则手动在日志模块菜单中维护该接口并将是否启用设置为不启用即可;

添加依赖

建议在应用启动项目中添加,如:provider-business等

  • 添加日志Aop依赖

      <dependency>
          <groupId>com.lc.ibps.cloud</groupId>
          <artifactId>ibps-basic-validator</artifactId>
      </dependency>
  • 添加日志监听依赖

      <dependency>
          <groupId>com.lc.ibps.provider.base</groupId>
          <artifactId>ibps-provider-platform-client</artifactId>
      </dependency>

增加包扫描

  • @SpringBootApplication注解类上增加注解
    //TODO 配置基础包名!重要步骤!!!把ibps的基础包加到扫描中
    @ComponentScan(basePackages = {"com.xxx","com.lc.ibps"})

添加切面配置

  • 修改配置文件application-common.yml增加自己的切点pointcut
    com:
    lc:
      system:
        log:
          enabled: ${SYSTEM_LOG_ENABLED:false}
          pointcut:
            - execution(public * com.lc.ibps..*.provider..*.*(..))
            - xxxx # 自己的切点

配置系统日志开关

  • 每个服务都要配置
  • 修改response工程下配置文件application-common.yml
  • 将配置com.lc.system.log.enabled改为true
    • 方式一: com.lc.system.log.enabled: ${SYSTEM_LOG_ENABLED:true}
    • 方式二:启动时设置系统变量
      • Linux系统export SYSTEM_LOG_ENABLED=true
      • Windows系统set SYSTEM_LOG_ENABLED=true
    • 方式三
      • Java启动参数-DSYSTEM_LOG_ENABLED=true
    • 方式四
      • Java启动参数-Dcom.lc.system.log.enabled=true

开启ES存储

  • 修改platform服务工程下配置文件application-app.yml
    • 方式一:
      • elasticsearch.com.lc.ibps.common.log.repository.impl.LogRepositoryImpl.query.enabled: ${ES_LOG_QUERY_ENABLED:true}
      • elasticsearch.com.lc.ibps.common.log.repository.impl.LogRepositoryImpl.get.enabled: ${ES_LOG_GET_ENABLED:true}
    • 方式二:启动时设置系统变量
      • Linux系统export ES_LOG_QUERY_ENABLED=true
      • Linux系统export ES_LOG_GET_ENABLED=true
      • Windows系统set ES_LOG_QUERY_ENABLED=true
      • Windows系统set ES_LOG_GET_ENABLED=true
    • 方式三
      • Java启动参数-DES_LOG_QUERY_ENABLED=true
      • Java启动参数-DES_LOG_GET_ENABLED=true
    • 方式三
      • Java启动参数-Delasticsearch.com.lc.ibps.common.log.repository.impl.LogRepositoryImpl.query.enabled=true
      • Java启动参数-Delasticsearch.com.lc.ibps.common.log.repository.impl.LogRepositoryImpl.get.enabled=true

注:这两个参数必须同时设置为true或false,因为开启ES存储之后,数据只在ES中保存!

文档更新时间: 2023-10-16 10:31   作者:Eddy