【Log4j2】Log4j2动态获取Linux主机名实战、环境变量解析原理(踩坑指南)
文章目录
- 配置方式
- Hostname的来源
- ${env:HOSTNAME} 解析机制
- Log4j2配置示例
- 踩坑案例
更多相关内容可查看
业务背景:在已成型很多年的项目的基础上,进行日志改造,例如在程序中已经通过lg4j2打印了很多日志了,通过改每一条输出日志不显示,可以通过插件挂载,动态读取的方式来改造日志
对log4j2日志不了解的可查看主页log4j2相关文章,此篇不做详细log4j2框架讲解
官网地址:https://www.docs4dev.com/docs/zh/log4j2/2.x/all/manual-index.html
配置方式
#全局配置
<Properties><Property name="HOSTNAME">${env:HOSTNAME}</Property>
</Properties>
#读取${HOSTNAME}部分就是读取的方式
fileName="${LOG_HOME}/proc-${LOG_VERSION}-${APP_Name}-${HOSTNAME}-1.log"
输出示例(这个node0406就是主机名):
Hostname的来源
大多数 Linux 发行版(如 CentOS、Ubuntu)会自动将主机名注入到 Shell 的环境变量中,可通过以下命令验证:
echo $HOSTNAME # 直接输出主机名
env | grep HOSTNAME # 查看所有环境变量中的HOSTNAME
主机名实际存储在 /etc/hostname
文件中,修改后需执行 hostnamectl set-hostname
<新主机名> 生效。
${env:HOSTNAME} 解析机制
当配置文件(如 Properties 或 XML)中出现 ${env:XXX} 时,日志框架(如 Log4j2、Spring Boot)会按以下流程处理:
步骤 1:识别占位符
日志框架检测到 ${env:HOSTNAME} 格式时,识别为 环境变量引用,其中:
- env 表示从系统环境变量中查找
- HOSTNAME 是具体的变量名
步骤 2:环境变量查找
框架调用 System.getenv("HOSTNAME")
方法,从 Java 进程的环境变量中获取值。
(底层通过 JNI 调用 Linux 系统的 getenv() C 函数)
步骤 3:值替换
将 ${env:HOSTNAME} 替换为实际的主机名(如 ubuntu-server),最终生成日志内容。
Log4j2配置示例
<?xml version="1.0" encoding="UTF-8"?>
<!--status : 这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,会看到log4j2内部各种详细输出monitorInterval : Log4j能够自动检测修改配置文件和重新配置本身, 设置间隔秒数。
-->
<Configuration status="WARN" monitorInterval="10" packages="com.server.util"><Properties><!-- 配置日志文件输出目录 --><Property name="LOG_HOME">/opt/log</Property><Property name="ARCHIVE_HOME">${LOG_HOME}/aaa</Property><Property name="APP_Name" value="sss"/><!-- 版本号属性 --><Property name="LOG_VERSION">v01</Property><!-- 主机号 --><Property name="HOSTNAME">xxx</Property><Property name="Pattern">[%d{yyyy-MM-dd HH:mm:ss.SSS}]|%level|${APP_Name}|%X{UUID}|%X{GlobalSeqNo}|%pid|%thread|%class{1.}:%line|%X{NestedLevel}|%msg%n</Property></Properties><Appenders><!--这个输出控制台的配置--><Console name="STDOUT" target="SYSTEM_OUT"><!-- 控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch) --><ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/><!-- 输出日志的格式 --><PatternLayout pattern="${Pattern}"/></Console><RollingRandomAccessFile name="FILE"immediateFlush="true" fileName="${LOG_HOME}/proc-${xxx}-${APP_Name}-${HOSTNAME}-1.log"filePattern="${ARCHIVE_HOME}/proc-${xxx}-${APP_Name}-${HOSTNAME}-%d{yyyyMMdd}-%i.log.zip"></RollingRandomAccessFile></Appenders>
踩坑案例
问题 1:日志中未显示主机名
原因:环境变量 HOSTNAME 未被注入到 Java 进程
在启动脚本中显式导出变量:
export HOSTNAME=$(hostname)java -jar your_app.jar
或在 Java 代码中硬编码:
System.setProperty("HOSTNAME", InetAddress.getLocalHost().getHostName());
问题 2:环境变量冲突
现象:${env:HOSTNAME} 返回空值
原因:某些容器化环境(如 Docker/K8s)可能覆盖了 HOSTNAME
# 在容器内执行
printenv HOSTNAME # 查看实际值
hostname # 查看系统真实主机名
问题 3:权限限制
场景:SELinux 或容器安全策略阻止读取环境变量
#解决:调整安全策略或改用文件读取:
String hostname = Files.readString(Path.of("/etc/hostname")).trim();