io.confluent.log4j.redactor

Class RedactorPolicy

java.lang.Object

io.confluent.log4j.redactor.RedactorPolicy

All Implemented Interfaces:

org.apache.log4j.rewrite.RewritePolicy, org.apache.log4j.spi.OptionHandler

public class RedactorPolicy
extends Object
implements org.apache.log4j.rewrite.RewritePolicy, org.apache.log4j.spi.OptionHandler

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

See Also:

for the redaction rules definition and syntax.

Constructor Summary

Constructors

Constructor and Description
RedactorPolicy()

Method Summary

Modifier and Type	Method and Description
void	activateOptions() Called after all options are passed in via setter methods so that they can be acted on at one time.
org.apache.log4j.spi.LoggingEvent	rewrite(org.apache.log4j.spi.LoggingEvent source) Given a LoggingEvent, potentially modify it and return an altered copy.
void	setMetrics(String metricsClassName) Log4j configurator calls this method with the value found in the config file.
void	setRefreshInterval(long interval) Log4j configurator calls this method with the value found in the config file.
void	setRules(String rules) Log4j configurator calls this method with the value found in the config file.
void	setTimeOut(int timeOut) Log4j configurator calls this method with the value found in the config file.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedactorPolicy

public RedactorPolicy()

Method Detail

setMetrics

public void setMetrics(String metricsClassName)

Log4j configurator calls this method with the value found in the config file.

Parameters:

metricsClassName - The metrics class name that is being instantiated.

setRules

public void setRules(String rules)

Log4j configurator calls this method with the value found in the config file.

Parameters:

rules - The path to the rules file that is being set.

setRefreshInterval

public void setRefreshInterval(long interval)

Log4j configurator calls this method with the value found in the config file. Sets the time interval in milliseconds to check for updates in redaction rules. We only check for updates when this positive, and it is negative by default.

Parameters:

interval - The refresh interval that is being set.

setTimeOut

public void setTimeOut(int timeOut)

Log4j configurator calls this method with the value found in the config file. Sets timeout for the URL reader. This is undocumented, and intended only for unit testing.

Parameters:

timeOut - The time out that is being set.

activateOptions

public void activateOptions()

Called after all options are passed in via setter methods so that they can be acted on at one time. This implements the OptionHandler interface.

Specified by:

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

rewrite

public org.apache.log4j.spi.LoggingEvent rewrite(org.apache.log4j.spi.LoggingEvent source)

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

Specified by:

rewrite in interface org.apache.log4j.rewrite.RewritePolicy

Parameters:

source - LoggingEvent to examine

Returns:

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