Class: Tracebook::RedactionRule

Inherits:
ApplicationRecord show all
Defined in:
app/models/tracebook/redaction_rule.rb

Overview

Rule for redacting PII from interaction payloads.

Defines a regex pattern to detect and replace sensitive data before persistence. Runs on request, response, or both payloads.

Fields

  • name - Human-readable name for this rule
  • pattern - Regular expression pattern to match
  • replacement - Replacement string (e.g., "[REDACTED]", "[EMAIL]")
  • applies_to - Where to apply: :request, :response, :both, :metadata
  • enabled - Whether this rule is active

Built-in Rules

TraceBook includes default redactors for:

  • Email addresses
  • Phone numbers (US format)
  • Credit card PANs

Examples:

Creating a custom redaction rule

RedactionRule.create!(
  name: "API Keys",
  pattern: 'api_key["\s]*[:=]["\s]*\K[\w-]+',
  replacement: "[API_KEY]",
  applies_to: :both,
  enabled: true
)

Email redaction

RedactionRule.create!(
  name: "Email Addresses",
  pattern: '\b[\w\.-]+@[\w\.-]+\.\w{2,}\b',
  replacement: "[EMAIL]",
  applies_to: :both,
  enabled: true
)

SSN redaction

RedactionRule.create!(
  name: "Social Security Numbers",
  pattern: '\b\d{3}-\d{2}-\d{4}\b',
  replacement: "[SSN]",
  applies_to: :both,
  enabled: true
)

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#applies_to ⇒ Symbol

Returns Where to apply redaction (:request, :response, :both, :metadata).

Returns:

  • Where to apply redaction (:request, :response, :both, :metadata)



57
 
# File 'app/models/tracebook/redaction_rule.rb', line 57

enum :applies_to, { request: 0, response: 1, both: 2, metadata: 3 }

Instance Method Details

#compiled_pattern ⇒ Regexp

Returns the compiled regex pattern.

Caches the compiled pattern for performance. If pattern is invalid, falls back to escaped literal match.

Examples:

rule = RedactionRule.new(pattern: '\b\d{3}-\d{2}-\d{4}\b')
rule.compiled_pattern.match("123-45-6789") # => MatchData

Returns:

  • Compiled regular expression with MULTILINE flag



73
74
75
76
77
 
# File 'app/models/tracebook/redaction_rule.rb', line 73

def compiled_pattern
  @compiled_pattern ||= Regexp.new(pattern, Regexp::MULTILINE)
rescue RegexpError
  Regexp.new(Regexp.escape(pattern.to_s))
end