io.confluent.log4j2.redactor

Class RedactorPolicy

java.lang.Object

io.confluent.log4j2.redactor.RedactorPolicy

All Implemented Interfaces:

org.apache.logging.log4j.core.appender.rewrite.RewritePolicy

@Plugin(name="RedactorPolicy",
        category="Core",
        elementType="layout",
        printObject=true)
public class RedactorPolicy
extends Object
implements org.apache.logging.log4j.core.appender.rewrite.RewritePolicy

RewritePolicy implementation that applies the redaction rules defined in the configuration of the RedactorPolicy in the Log4j Properties configuration file. Use with RewriteAppender.

Method Summary

Modifier and Type	Method and Description
static RedactorPolicy	createPolicy(String name, String rules, Long refreshInterval, Integer timeOut, LogRedactorMetrics metrics)
org.apache.logging.log4j.core.LogEvent	rewrite(org.apache.logging.log4j.core.LogEvent source) Given a LoggingEvent, potentially modify it and return an altered copy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createPolicy

@PluginFactory
public static RedactorPolicy createPolicy(@PluginAttribute(value="name")
                                                         String name,
                                                         @PluginAttribute(value="rules")
                                                         String rules,
                                                         @PluginAttribute(value="refreshInterval")
                                                         Long refreshInterval,
                                                         @PluginAttribute(value="timeOut")
                                                         Integer timeOut,
                                                         @PluginElement(value="metrics")
                                                         LogRedactorMetrics metrics)

rewrite

public org.apache.logging.log4j.core.LogEvent rewrite(org.apache.logging.log4j.core.LogEvent source)

Given a LoggingEvent, potentially modify it and return an altered copy. This implements the RewritePolicy interface.

Specified by:

rewrite in interface org.apache.logging.log4j.core.appender.rewrite.RewritePolicy

Parameters:

source - LoggingEvent to examine

Returns:

Either the original (no changes) or a redacted copy.