Installation 💎

source"https://rubygems.org"gem"redacting-logger","~> X.X.X"# Replace X.X.X with the latest version

Usage 💻

Basic

require"redacting_logger"# Create a new loggerlogger=RedactingLogger.new(redact_patterns:[/topsecret/])# Log a message that contains some redacted patternlogger.info("This is a topsecret message.")

I, [timestamp]  INFO -- : This is a [REDACTED] message.

Advanced

require"redacting_logger"# Create a new loggerlogger=RedactingLogger.new(  $stdout,# The device to log to (defaults to $stdout if not provided)redact_patterns:[/REDACTED_PATTERN1/,/REDACTED_PATTERN2/],# An array of Regexp patterns to redact from the logslevel:Logger::INFO,# The log level to useredacted_msg:"[REDACTED]",# The message to replace the redacted patterns withuse_default_patterns:true# Whether to use the default built-in patterns or not)# Log a message that contains some redacted patternslogger.info("This is a message with a REDACTED_PATTERN1 and REDACTED_PATTERN2 in it.")

I, [timestamp]  INFO -- : This is a message with a [REDACTED] and [REDACTED] in it.

Default Redaction Patterns

logger=RedactingLogger.new(use_default_patterns:false# Whether to use the default built-in patterns or not)