syncutil

Documentation

Index

• Constants
• func StringifySnapshot(snapshot interface{}) string
• type ProtoRedactor
  • func NewProtoRedactor(tagName, tagValue string) ProtoRedactor

Constants

const (
	Redacted = "[REDACTED]"

	LogRedactorTag      = "logging"
	LogRedactorTagValue = "redact"
)

Functions

func StringifySnapshot

func StringifySnapshot(snapshot interface{}) string

stringify the contents of the snapshot

NOTE that if any of the top-level fields of the snapshot is a SecretList, then the secrets will be stringified by printing just their name and namespace, and "REDACTED" for their data. Secrets may contain sensitive data like TLS private keys, so be sure to use this whenever you'd like to stringify a snapshot rather than Go's %v formatter

Types

type ProtoRedactor

type ProtoRedactor interface {
	// Build a JSON string representation of the proto message, zeroing-out all fields in the proto that match some criteria
	BuildRedactedJsonString(message proto.Message) (string, error)
}

func NewProtoRedactor

func NewProtoRedactor(tagName, tagValue string) ProtoRedactor

build a ProtoRedactor that zeroes out fields that have the given struct tag set to the given value