使用logbcak框架让日志输出ip

前言

最近在看日志时，由于现在系统都是容器化部署，导致日志采集工具elk无法正常输出主机ip，没有输出准确的容器ip而是输出物理机的ip，对定位问题有一定阻碍，所以尝试自行在日志中全局输出本机ip。

全局输出ip

自定义获取ip的类

需要我们自己实现一个获取ip的类，这个类需要继承 ClassiConverter这个类。

public class IpConverter extends ClassicConverter{
    private static String ipAddr=null;
    try{
      // 可以用任何方法写，这里的写法是抄的，实际应用中要考虑多网卡的情况
      ipAddr = "globalIp:".concat(InetAddress.getLocalHost().getHostAddress());
    }catch(Exception e){
      // 避免出现异常导致日志输出失败
      return "unknown";
    }
}

添加conversionRule

在logback-spring.xml或者logback.xml文件里，添加以下内容,把类路径替换成实际的类路径

<conversionRule  conversionWord="ipAddr" converterClass="com.xxx.xxx.log.IpConverter"/>

并在日志输出的pattern中加入 [%ipAddr]，如下

<pattern> %d{yyyy-MM-dd HH:mm:ss.SSS} [%ipAddr] [%thread] %-5level %logger{48}:%line - [%tid] - %msg%n </pattern>

最后启动后，日志输出就会包含本机的IP啦。

---

非全局输出ip

非全局输出可以使用MDC.

MDC 是logback 和 log4j 等日志框架提供的一种上下文管理工具，全称为 Mapped Diagnostic Context（映射诊断上下文），可以在同一个线程的多个日志记录过程中实现上下文信息的共享（这段是纯复制的）。

使用MDC来完成这个功能只需要在线程启动的时候，往MDC里填充ip信息，后续的日志输出就可以自然而然的获取到这个共享的上下文信息。
举个例子：

定义一个变量输出

在<appender></appender> 的<pattern></pattern>里定义一个%X{ipAddr}变量输出

<pattern> %d{yyyy-MM-dd HH:mm:ss.SSS} [%X{ipAddr}] [%thread] %-5level %logger{48}:%line - [%tid] - %msg%n </pattern>

在代码中填充值

这个变量的实际值将会在代码中填充。譬如在Filter里面把值放入MDC中：

public class IpFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        String ipAddr = null;
        try {
            // 可以用任何方法写，这里的写法是抄的，实际应用中要考虑多网卡的情况
            ipAddr = "globalIp:".concat(InetAddress.getLocalHost().getHostAddress());
        } catch (Exception e) {
            // 避免出现异常导致日志输出失败
            ipAddr = "unknown";
        }
        MDC.put("ipAddr", ipAddr);
        chain.doFilter(request, response);
        // 使用完毕后要将 MDC 变量删除
        MDC.remove("ipAddr"); 
    }
}

这样这个请求往下的日志输出都会包含ip信息。

使用这样的方式不仅可以用来输出ip，还可以输出其他有用的信息