log4j设置日志的时区

1. 问题场景

技术栈：Spring Cloud 微服务框架 + Log4j日志框架

我们的服务部署在多个地区，没个地区的时区不一样，服务端为了保证时间的一致性，将时区统一设置为UTC时间，从而导致日志打印的时间也为UTC时间。

测试和运维人员认为日志打印的时区和前端用户的时区不一样，对于定位问题非常不方便。比如在中国，用户提单说问题发生的时间是上午10：00左右，那开发人员就需要寻找凌晨02:00左右的日志。

因此，测试和运维要求提供配置，可以调整日志打印的时区。

2. 解决方案

系统中的日志打印框架采用的是Log4j，通过xml文件配置日志打印的格式，部分内容如下：

2.1 方案1：通过配置中心为配置Log4j的配置文件

修改Log4j的配置文件：

<Configuration status="info" monitorInterval="10">
   <Properties>
       <Property name="TIME_ZONE">UTC-8</Property>
       <Property name="LOG_PATTERN">%d{yyyy-MM-dd HH:mm:ss}{${TIME_ZONE}}</Property>

将该配置文件放到配置中心，在不同的地区配置不同的配置文件，可以支持调整日志的打印时区。

2.2 方案2：读取系统配置属性设置Log4j的日志打印时区

对于采用容器化部署的服务来说，通常使用K8S进行容器编排，可以借助K8S配置容器的环境变量：

containers:
  env:
  - name: LOG_TIMEZONE
    value: Asia/Shanghai

接下来修改Log4j的配置文件：

<Configuration status="info" monitorInterval="10">
   <Properties>
       <Property name="TIME_ZONE">${env: LOG_TIMEZONE}<</Property>
       <Property name="LOG_PATTERN">%d{yyyy-MM-dd HH:mm:ss}{${TIME_ZONE}}</Property>

参考

1. https://logging.apache.org/log4j/2.x/manual/configuration.html
2. https://www.ibm.com/support/pages/how-change-timezone-logging-appenders