使用 log4j 进行条件日志记录

Question

我正在开发的 Web 应用程序偶尔会为某些用户带来数据完整性问题。我想打开跟踪级别日志记录，但由于我们每秒处理 100 个请求，因此跟踪日志记录不可能实现每个请求。

log4j 有没有办法能够有条件地记录？换句话说，我希望仅当特定用户发出请求时才能获取跟踪日志。由于我事先不知道哪些用户会受到影响，所以我不能简单地临时硬编码用户名。

编辑：

我想我需要更清楚一点。我可以轻松地向日志语句添加条件。例如，

Logger logger = Logger.getLogger("foo");
String usernameFilter = "piglet";
String username = request.getParameter("username");
logger.setLevel(usernameFilter.equals(username) ? Level.TRACE : Level.INFO);
if (logger.isTraceEnabled()) {
   logger.trace("blah blah blah");
}

困难在于动态改变设置日志级别的条件。换句话说，在上面的示例中，除了硬编码之外，如何设置 usernameFilter 的值。

Answer 1

您想查看嵌套诊断上下文或映射的诊断上下文在 log4j 或 slf4j 中。 NDC/MDC 允许您将数据插入到可由 log4j 过滤的会话中。

因此，您可以将用户名定义在 NDC 中，然后可以更改 log4j.properties 来更改特定用户的日志记录级别。

MDC 使用 Map，而 NDC 基于堆栈原则。如果您使用 slf4j，您甚至可以根据中的信息创建单独的日志文件你的MDC。

例如，当用户登录网站时我们就这样做了。我们想要跟踪特定用户正在做什么（追溯），因此我们将用户名和会话 ID 添加到 NDC，然后我们可以对这些内容进行后过滤。

代码类似于以下内容：

public class LoggingFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        MDC.put("username", session.getParameter("username")); // or where ever t is stored
        chain.doFilter(request, response);
    }
}

在 log4j.xml 中，此过滤器基于用户：

  <appender name="UserDebug" class="org.apache.log4j.RollingFileAppender">
    <param name="File" value="userdebug.log"/>
    <param name="Append" value="true"/>
    <param name="MaxFileSize" value="5000KB"/>
    <param name="maxBackupIndex" value="5"/> 
          <layout class="org.apache.log4j.PatternLayout">
                  <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} [%t] user:%X{username} %-5p - %m%n" />
          </layout>

          <filter class="org.apache.log4j.varia.StringMatchFilter">
                  <param name="StringToMatch" value="user:fred" />
                  <param name="AcceptOnMatch" value="true" />
          </filter>

      <filter class="org.apache.log4j.varia.DenyAllFilter"/>
  </appender>

%X{key} 输出 MDC 中的 MDC.get(key) 值。如果您想要一个更复杂的过滤器，您可以自己扩展它，并自己查看 MDC 中的值。

Answer 2

Matthew Farwell 的答案（使用 MDC）对我有用，他提到编写你自己的过滤器。我的需要是在某些情况下隐藏日志消息。具体来说，我们有一个运行状况检查调用，其调用频率比典型的用户使用频率高得多，并且不必要地填充了日志。 Matthew 的解决方案不适合我的情况，因为它需要您将 MDC 添加到实际的日志输出中。我只想使用 MDC 进行过滤，因此我使用以下类扩展了 org.apache.log4j.spi.Filter：

/**
 * Log4J filter that stops certain log messages from being logged, based on a
 * value in the MDC (See Log4J docs).
 */
public class Log4JMDCFilter extends Filter
{

private String keyToMatch;
private String valueToMatch;
private boolean denyOnMatch = true;

/**
 * {@inheritDoc}
 */
public int decide(LoggingEvent event)
{
    if (keyToMatch != null && valueToMatch != null
        && valueToMatch.equals(event.getMDC(keyToMatch)))
    {
        return denyOnMatch ? DENY : ACCEPT;
    }

    return denyOnMatch ? ACCEPT : DENY;
}

/**
 * The key on which to filter.
 * 
 * @return key on which to filter
 */
public String getKeyToMatch()
{
    return keyToMatch;
}

/**
 * Sets the key on which to filter.
 * 
 * @param keyToMatch key on which to filter
 */
public void setKeyToMatch(String keyToMatch)
{
    this.keyToMatch = keyToMatch;
}

/**
 * Gets the value to match.
 * 
 * @return the value to match.
 */
public String getValueToMatch()
{
    return valueToMatch;
}

/**
 * Sets the value to match.
 * 
 * @param valueToMatch the value to match.
 */
public void setValueToMatch(String valueToMatch)
{
    this.valueToMatch = valueToMatch;
}

/**
 * Returns true if the log message should not be logged if a match is found.
 * 
 * @return true if the log message should not be logged if a match is found.
 */
public boolean isDenyOnMatch()
{
    return denyOnMatch;
}

/**
 * Set this to "true" if you do not want log messages that match the given
 * key/value to be logged. False if you only want messages that match to be
 * logged.
 * 
 * @param denyOnMatch "true" if you do not want log messages that match the
 *        given key/value to be logged. False if you only want messages that
 *        match to be logged.
 */
public void setDenyOnMatch(String denyOnMatch)
{
    this.denyOnMatch = Boolean.valueOf(denyOnMatch).booleanValue();
}

}

使用以下 log4j.xml 片段来激活过滤器（“HEALTHCHECK”是键和“true”是我要过滤的值）：

    <filter class="com.copart.hh.core.utils.Log4JMDCFilter">
        <param name="keyToMatch" value="HEALTHCHECK" />
        <param name="valueToMatch" value="true" />
        <param name="denyOnMatch" value="true" />
    </filter>

然后，在您想要标记过滤的任何位置，输入如下代码：

MDC.put("HEALTHCHECK", "true");
try
{    
      // do healthcheck stuff that generates unnecessary logs
}
finally
{
    MDC.remove("HEALTHCHECK"); // not sure this is strictly necessary
}

Answer 3

我发现这篇博客文章非常有帮助。这可以帮助您为用户创造登录条件。

Answer 4

我采取了如下解决方法：

在 log4j.xml 中配置您的日志目标，如下所示：

    <appender name="file" class="org.apache.log4j.RollingFileAppender">
    <param name="file" value="${catalina.home}/logs/uploader.log" />
    <param name="append" value="false" />
    <param name="threshold" value="info" />
    <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="%d{ISO8601} %-5p [%c{1}] - %m%n" />
    </layout>

    <filter class="org.apache.log4j.varia.StringMatchFilter">
        <param name="StringToMatch" value="trackfile" />
        <param name="AcceptOnMatch" value="true" />
    </filter>

     <filter class="org.apache.log4j.varia.DenyAllFilter" />   
</appender>

创建一个附加目标标签 [trackfile] 的客户记录器方法，

private void logfile(String msg) {
    logger.info("trackfile: " + msg);
}

使用上述方法记录您的信息：

logfile("your log message")