用于屏蔽特定日志数据的回退配置

Question

我有一个Spring Boot web应用程序，正在使用logback作为我的日志解决方案。我一直在查看文档，找不到一种简单或“正确”的方法来掩盖私人/特定数据（个人信息、信用卡等）。

我能找到的最接近的是Logback过滤器，然而，围绕这些过滤器的用例似乎更多地是关于省略符合特定标准的日志，我只是想屏蔽所有应用程序范围的日志。

这似乎是一个如此基本的问题，我确信我错过了一些超级基本的东西，但是任何朝着正确方向的推动或指出都是非常值得赞赏的。

我也没有被锁定在logback中，因此如果有一种更简单/更好的方法，例如使用log4j2，我洗耳恭听

Answer 1

要屏蔽可配置字段，您需要像下面这样创建MaskingPatternLayout，

import java.util.Arrays;
import java.util.List;
import java.util.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import ch.qos.logback.classic.PatternLayout;
import ch.qos.logback.classic.spi.ILoggingEvent;

public class MaskingPatternLayout extends PatternLayout {

  private String patternsProperty;
  private Optional<Pattern> pattern;

  public String getPatternsProperty() {
    return patternsProperty;
  }

  public void setPatternsProperty(String patternsProperty) {
    this.patternsProperty = patternsProperty;
    if (this.patternsProperty != null) {
      this.pattern = Optional.of(Pattern.compile(patternsProperty, Pattern.MULTILINE));
    } else {
      this.pattern = Optional.empty();
    }
  }

  @Override
  public String doLayout(ILoggingEvent event) {
    final StringBuilder message = new StringBuilder(super.doLayout(event));

    if (pattern.isPresent()) {
      Matcher matcher = pattern.get().matcher(message);
      while (matcher.find()) {

        int group = 1;
        while (group <= matcher.groupCount()) {
          if (matcher.group(group) != null) {
            final int startGrpIndex = matcher.start(group);
            final int endGrpIndex = matcher.end(group);
            final int diff = endGrpIndex - startGrpIndex + 1;
            int startIndex = startGrpIndex + diff;
            final int endIndex1 = message.indexOf(",", startIndex);
            final int endIndex2 = message.indexOf(" ", startIndex);
            final int endIndex3 = message.indexOf(")", startIndex);
            final int endIndex4 = message.indexOf("\n", startIndex);

            final Integer endIndex = getSmallestInt(
              Arrays.asList(Integer.valueOf(endIndex1), Integer.valueOf(endIndex2), Integer.valueOf(endIndex3), Integer.valueOf(endIndex4)));
            if (endIndex == null || endIndex <= 0) {
              continue;
            }

            for (int i = startIndex; i < endIndex; i++) {
              message.setCharAt(i, '*');
            }
          }
          group++;
        }
      }
    }
    return message.toString();
  }

  private Integer getSmallestInt(List<Integer> integerList) {

    return integerList.stream().filter(integer -> integer > 0).reduce((x, y) -> x < y ? x : y).get();
  }

}

需要在logback中添加编码器。xml附加器-

<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
      <layout class="com.adgiants.config.MaskingPatternLayout">
        <patternsProperty>(password)|(email)</patternsProperty>
        <pattern>%d [%thread] %-5level %logger{35} - %msg%n</pattern>
      </layout>
</encoder>

此配置将扫描所有日志语句，并匹配“password”或“email”（无论您在logback.xml编码器中配置了哪个），其值将替换为****

e. g

log.info("Received sign-up request, password=DummyPassword@123");

在日志中，上述语句将显示为，

Received sign-up request, password=*****************