我们的aliyunlog-spring-boot-starter开源了

前言

日志服务是一个企业软件平台里的重要一环，也有很多可选的成熟方案，比如业界熟知的ELK开源方案。也有很多的云厂商的日志服务产品，比如aliyunlog服务等。我们在综合了资源成本加人工运维成本和日志整体应用后最终选择了aliyunlog服务。为了更好的接入aliyunlog服务，我们开发了aliyunlog-spring-boot-starter，用于在微服务中使用spring boot starter自动装配的特性快速集成。这个不是广告贴所有不会说aliyunlog服务的功能特性，主要写写咱们这个项目的设计及思考，以及使用方式，如果你也在使用aliyunlog的服务，强烈推荐你使用我们的组件来接入

aliyunlog-spring-boot-starter 项目地址：https://github.com/kekingcn/aliyunlog-spring-boot-starter

原生SDK接入痛点

aliyunlog服务在应用接入层面做的还不错，提供了各种语言的SDK，而且项目都是开源的，代码都是直接托管在github上。官方javaSDK的设计是基于常用java日志框架做的基础适配，比如如果你的应用使用的loaback，可以使用aliyun-log-logback-appender包，如果你的应用使用的Log4j，就可以使用aliyun-log-log4j2-appender包。 而如果你的团队比较大，可能即会有logback，也会有log4j的使用。项目一多的话，在接入成本上就会更高，所以我们总结了应用直接使用官方SDK接入会有如下问题：

• 1、相同开发语言，接入方式不一致，学习成本比较高
• 2、日志服务账号信息明文配置在各个系统不安全
• 3、通用的配置需要在每个应用里都配置一遍比较繁琐
• 4、需要收集更多的信息，比如登录用户的信息，每个应用都需要开发，太耗费人力

aliyunlog-spring-boot-starter的设计

针对上面的问题，我们开发了统一接入日志平台的组件，上面提到的问题都一一得到了解决，下面是我们的一些设计要点，提供参考：

• 1、首先考虑到spring boot应用，采用了starter包自动装配的特性，只要应用导入依赖，就会自动完成集成
• 2、抽象了基础的账号信息，打进jar里，接入的应用不需要在配置这些信息了，同时考虑到starter包的灵活性，可以使用spring的env配置覆盖默认的信息
• 3、具体装载逻辑选在了spring 应用加载完自身的env配置资源后，也就是通过实现EnvironmentAware接口，来触发Environment加载完钩子的调用
• 4、我们通过检测classloder里加载的日志类型，自动装配日志实现，实现了logback和log4j框架的统一接入

aliyunlog-spring-boot-starter功能详情

aliyunlog-spring-boot-starter能够自动感知应用环境内引入的的日志实现（Log4j2及Logback）并自动接入阿里云日志服务，在保留灵活配置的同时，大幅度简化开发配置，让应用适配日志服务更简单。

一、使用场景

1. 简化繁琐的阿里云日志服务接入的配置，kk-aliyun-log-appender已集成不同日志框架的阿里云日志服务接入实现，且能自动感知引入的日志实现，无需根据不同的日志实现去配置不同的接入逻辑。

2. 提供了默认配置，大多数场景下仅需要配置topic属性即可接入。

3. 提供了灵活的配置方案。

4. 接入了新版Aliyun LOG Java Producer

   Aliyun LOG Java Producer 是对老版 log-loghub-producer 的全面升级，解决了上一版存在的多个问题，包括网络异常情况下 CPU 占用率过高、关闭 producer 可能出现少量数据丢失等问题。另外，在容错方面也进行了加强，即使您存在误用，在资源、吞吐、隔离等方面都有较好的保证。

5. 对原有的log4j2.xml或logback.xml中的配置无影响

二、快速开始

2.1 springboot项目接入

1.添加maven依赖

<dependency>
    <groupId>com.github.kekingcn</groupId>
    <artifactId>aliyunlog-spring-boot-starter</artifactId>
    <version>0.1-SNAPSHOT</version>
</dependency>

2.配置必备属性topic 
topic用以标记一批日志,例如可以通过配置topic属性来区分不同的应用及应用profile(kk-call-center-prod)

aliyun.log.enable=true aliyun.log.topic=test-topic

3.kk-aliyun-log-appender默认为所有的logger接入阿里云日志服务，且日志级别为logger上定义的日志级别。 
4.启动应用
如果接入成功，则会打印如下log

[main] INFO  cn.keking.common.log.LogAppenderAutoConfiguration - kk aliyun log appender has been successfully initialized

2.2 spring mvc项目接入

和spring boot相似，需要在spring-xx.xml配置中添加类扫描即可

<context:component-scan base-package="cn.keking.common.log">context:component-scan>

三、配置参数

仅aliyun.log.topic为必填属性

四、使用限制

1. jdk1.8
2. Spring4以上
3. 需要统一日志编程接口至slf4j
4. 应用内的日志框架logback 1.2.3版本以上或log4j2 2.0.2版本以上（与原阿里SDK一致）
5. 如果已接入阿里SDK，则本日志组件将不会起任何作用

五、常见场景

5.1 开发环境不上传日志到阿里云

在application-dev.properties中配置关闭上传日志

aliyun.log.enable=false

该参数默认为false，在生产环境中应当设置enable=true

5.2 自定义logger上传日志

例如在log4j2中有如下的配置

<Loggers>
    <Logger name="mylog1" level="trace" additivity="false">
        <AppenderRef ref="Console" />
    Logger>
    <Logger name="mylog2" level="trace" additivity="false">
        <AppenderRef ref="Console" />
    Logger>
    <Root level="error">
        <AppenderRef ref="Console" />
    Root>
Loggers>

如果想要达到只有自定义的mylog1的log上传至阿里云 可以在application.properties中配置

aliyun.log.logger.filter=ROOT,mylog2

5.3 关闭日志发送失败重试

可以在application.properties中配置

aliyun.log.producer.reties=0

5.4 配置上传日志pattern

可以在application.properties中配置

aliyun.log.pattern=%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n

格式参阅: log4j2 logback

5.5 整合skywalking traceId

已集成skywalking toolkit，log4j2请使用[%traceId]，logback请使用[%tid]

aliyun.log.pattern=%d{HH:mm:ss.SSS} [%traceId] [%t] %-5level %logger{36} - %msg%n