redact

package

v0.20.3 Latest Latest Go to latest Published: Oct 8, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/nexssp/flow

Links

Open Source Insights

Documentation ¶

Overview ¶

Package redact masks well-known credential-shaped field names before a value is handed to a logger. It is deliberately conservative: only keys whose name indicates a credential are masked, and the original value is never mutated. Callers that log user data should route it through Map first; callers that log their own internal state do not need to.

Index ¶

Constants
func Map(m map[string]any) map[string]any

Constants ¶

View Source

const Placeholder = "[REDACTED]"

Placeholder is the value every masked field becomes. It is exported so tests and downstream sinks can recognize a redacted field without guessing the format.

Variables ¶

This section is empty.

Functions ¶

func Map ¶

func Map(m map[string]any) map[string]any

Map returns a shallow copy of m with credential-shaped values masked. Nested maps and slices are redacted recursively. The input is not mutated; callers can log the result and keep using the original.

Types ¶

This section is empty.

Source Files ¶

View all Source files

redact.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL