redact

Documentation

Index

• Constants
• Variables
• func Decorator() logger.Decorator
• type Func
  • func (f Func) Redacted() interface{}
• type Interface
  • func Blackout(s string) Interface
• type Simple
  • func (x Simple) Redacted() interface{}

Constants

const Label = "xxREDACTEDxx"

Label is generated by the Simple redactor

Variables

var Default = Decorator()

Default is the default redacting logger.Decorator

Functions

func Decorator

func Decorator() logger.Decorator

Decorator returns a decorator scans log arguments for those that implement Interface and, when found, invokes Redacted to obtain a replacement value.

Types

type Func

type Func func() interface{}

Func is a functional adapter for Interface

func (Func) Redacted

func (f Func) Redacted() interface{}

Redacted implements Interface

type Interface

type Interface interface {
	Redacted() interface{}
}

Interface is implemented by types containing possibly sensitive information that should not appear in a log stream.

func Blackout

func Blackout(s string) Interface

Blackout generates a redactor that replaces each char of the given string with 'x'

type Simple

type Simple int

Simple impements Interface

func (Simple) Redacted

func (x Simple) Redacted() interface{}

Redacted returns the contents of Label