io.confluent.logredactor.internal

Class StringRedactor

java.lang.Object

io.confluent.logredactor.internal.StringRedactor

public class StringRedactor
extends Object

This class contains the logic for redacting Strings. It is initialized from rules contained in a JSON file.

Method Summary

Modifier and Type	Method and Description
static StringRedactor	createFromJsonFile(String fileName) Create a StringRedactor based on the JSON found in a file.
static StringRedactor	createFromJsonFile(String fileName, io.confluent.log4j.redactor.LogRedactorMetrics metrics)
static StringRedactor	createFromJsonString(String json, String rulesLocation) Create a StringRedactor based on the JSON found in the given String.
static StringRedactor	createFromJsonString(String json, String rulesLocation, io.confluent.log4j.redactor.LogRedactorMetrics metrics)
static StringRedactor	emptyStringRedactor(io.confluent.log4j.redactor.LogRedactorMetrics metrics, Map<String,String> tags)
void	measureRuleCount()
String	redact(String msg) The actual redaction - given a message, look through the list of redaction rules and apply if matching.
Throwable	redact(Throwable t)

Methods inherited from class java.lang.Object

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

Method Detail

emptyStringRedactor

public static StringRedactor emptyStringRedactor(io.confluent.log4j.redactor.LogRedactorMetrics metrics,
                                                 Map<String,String> tags)

createFromJsonFile

public static StringRedactor createFromJsonFile(String fileName)
                                         throws IOException

Create a StringRedactor based on the JSON found in a file. The file format looks like this:

 {
   "version": "1",
   "rules": [
     { "description": "This is the first rule",
       "trigger": "triggerstring 1",
       "search": "regex 1",
       "replace": "replace 1"
     },
     { "description": "This is the second rule",
       "trigger": "triggerstring 2",
       "search": "regex 2",
       "replace": "replace 2"
     }
   ]
 }
 

Parameters:

fileName - The name of the file to read

Returns:

A freshly allocated StringRedactor

Throws:

IOException - We convert jackson exceptions to RedactionPolicyParseExceptions because we shade and relocate jackson and don't want to expose it.

createFromJsonFile

public static StringRedactor createFromJsonFile(String fileName,
                                                io.confluent.log4j.redactor.LogRedactorMetrics metrics)
                                         throws IOException

Throws:

IOException

createFromJsonString

public static StringRedactor createFromJsonString(String json,
                                                  String rulesLocation)
                                           throws IOException

Create a StringRedactor based on the JSON found in the given String. The format is identical to that described in createFromJsonFile().

Parameters:

json - String containing json formatted rules.

rulesLocation - String containing location of the redaction rules.

Returns:

A freshly allocated StringRedactor

Throws:

IOException - We convert jackson exceptions to RedactionPolicyParseExceptions because we shade and relocate jackson and don't want to expose it.

createFromJsonString

public static StringRedactor createFromJsonString(String json,
                                                  String rulesLocation,
                                                  io.confluent.log4j.redactor.LogRedactorMetrics metrics)
                                           throws IOException

Throws:

IOException

redact

public String redact(String msg)

The actual redaction - given a message, look through the list of redaction rules and apply if matching. If so, return the redacted String, else return the original string.

Parameters:

msg - The message to examine.

Returns:

The (potentially) redacted message.

redact

public Throwable redact(Throwable t)

measureRuleCount

public void measureRuleCount()