io.confluent.log4j.redactor

Class RedactorAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

org.apache.log4j.rewrite.RewriteAppender

io.confluent.log4j.redactor.RedactorAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.AppenderAttachable, org.apache.log4j.spi.OptionHandler, org.apache.log4j.xml.UnrecognizedElementHandler

public class RedactorAppender
extends org.apache.log4j.rewrite.RewriteAppender

RewriteAppender that redacts the message of LoggingEvents and delegates to the referenced Appender.

The redaction rules are enforced by a RedactorPolicy.

The RedactorAppender configuration is as follows:

 log4j.appender.redactor=io.confluent.log4j.redactor.RedactorAppender
 log4j.appender.redactor.appenderRefs=[APPENDERS]
 log4j.appender.redactor.policy=io.confluent.log4j.redactor.RedactorPolicy
 log4j.appender.redactor.policy.rules=/full/path/to/rule/file.json
 log4j.appender.redactor.policy.refreshInterval=60000
 log4j.appender.redactor.policy.metrics=com.example.CustomizedMetrics
 

[APPENDERS] should be the list of appenderRefs, comma separated, to wrap for redaction.

All the appenderRefs listed in [APPENDERS] must match the appenders listed for the logger that you wish to redact.

The redactor appender itself must be added to the logger that you wish to redact.

The format of the rules file in policy.rules is described in the StringRedactor class.

Field Summary

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
RedactorAppender()

Method Summary

Modifier and Type	Method and Description
void	activateOptions() Called after all options are read in so that they can be acted on at one time.
protected void	append(org.apache.log4j.spi.LoggingEvent event)
void	setAppenderRefs(String refs) Log4j configurator calls this with the contents found in the config file.
void	setPolicy(RedactorPolicy policy) Log4j configurator calls this with the contents found in the config file.

Methods inherited from class org.apache.log4j.rewrite.RewriteAppender

addAppender, close, getAllAppenders, getAppender, isAttached, parseUnrecognizedElement, removeAllAppenders, removeAppender, removeAppender, requiresLayout, setRewritePolicy

Methods inherited from class org.apache.log4j.AppenderSkeleton

addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

RedactorAppender

public RedactorAppender()

Method Detail

setPolicy

public void setPolicy(RedactorPolicy policy)

Log4j configurator calls this with the contents found in the config file.

Parameters:

policy - The policy that is being set.

setAppenderRefs

public void setAppenderRefs(String refs)

Log4j configurator calls this with the contents found in the config file.

Parameters:

refs - The appenderRefs that are being set.

activateOptions

public void activateOptions()

Called after all options are read in so that they can be acted on at one time. Here we wrap all the necessary appenderRefs with RedactorAppender()s.

Specified by:

activateOptions in interface org.apache.log4j.spi.OptionHandler

Overrides:

activateOptions in class org.apache.log4j.AppenderSkeleton

append

protected void append(org.apache.log4j.spi.LoggingEvent event)

Overrides:

append in class org.apache.log4j.rewrite.RewriteAppender