Package Usage: go: github.com/cockroachdb/redact
Package redact provides facilities for separating “safe” and
“unsafe” pieces of data when logging and constructing error object.
An item is said to be “safe” if it is proven to not contain
PII or otherwise confidential information that should not escape
the boundaries of the current system, for example via telemetry
or crash reporting. Conversely, data is considered “unsafe”
until/unless it is known to be “safe”.
Example use:
When defining your own custom types, you can define
a SafeFormat method, implementing the redact.SafeFormatter
interface in a way you'd otherwise implement fmt.Formatter.
This is then recognized by this package's API automatically.
Alternatively:
- you can implement the SafeValue interface, which tells the
redact package to always the default formatting of a type
as safe and thus not included inside redaction markers.
- you can include a value within redact.Safe() and redact.Unsafe()
in redact.Sprintf / redact.Fprintf calls, to force
the omission or inclusion of redaction markers.
16 versions
Latest release: about 2 years ago
3,276 dependent packages
View more package details: https://packages.ecosystem.code.gouv.fr/registries/proxy.golang.org/packages/github.com/cockroachdb/redact