A Go package for redacting sensitive information from slog-based logs using a configurable pipeline.
The redact package provides a way to redact sensitive information from logs generated by the slog package. It does so by creating a pipeline of redaction stages that can be configured to redact specific fields from the log records.
flowchart TD
subgraph Application
A[Log Record Created]
end
subgraph RedactionHandler
G[Handle Log Record]
end
subgraph RedactionPipeline
direction TB
C[Process Log Record]
D[Redaction Stage 1]
E[Redaction Stage 2]
F[Redaction Stage N]
end
subgraph BaseHandler
direction TB
H[Output Redacted Log Record]
end
A -->|Passes to| G
G -->|Invokes| C
C -->|Applies| D
D -->|Then| E
E -->|Then| F
F -->|Returns Processed Log to| C
C -->|Returns to| G
G -->|Delegates to| H
package main
import (
"log/slog"
"os"
"github.com/alesr/redact"
)
func main() {
// Create a base handler
handler := slog.NewTextHandler(os.Stdout, nil)
// Create a redaction pipeline
pipeline := redact.NewRedactionPipeline()
pipeline.AddRedactField("email")
pipeline.AddRedactField("password")
// Create a RedactionHandler that wraps the original handler
redactionHandler := redact.NewRedactionHandler(handler, pipeline)
// Create a logger with the RedactionHandler
logger := slog.New(redactionHandler)
logger.Info("Test log", slog.String("user", "rigoletto"), slog.String("email", "[email protected]"), slog.String("password", "abc123"))
}
// Output: time=2025-02-08T19:49:23.826+02:00 level=INFO msg="Test log" user=rigoletto email=[REDACTED] password=[REDACTED]Check the examples directory for a testable example.