util

Documentation

Index

• func CompareYAML(a, b interface{}) bool
• func DefaultConfigFromFlags(cfg interface{}) interface{}
• func GoKitLogger(l log.Logger) logging.Interface
• func TestLogger(t *testing.T) log.Logger
• func Untab(s string) string
• type ConfigFlags
• type Logger
  • func NewLogger(cfg *server.Config) *Logger
  • func (l *Logger) ApplyConfig(cfg *server.Config) error
  • func (l *Logger) Log(kvps ...interface{}) error
• type PrefixedConfigFlags
• type Unregisterer
  • func WrapWithUnregisterer(reg prometheus.Registerer) *Unregisterer
  • func (u *Unregisterer) MustRegister(cs ...prometheus.Collector)
  • func (u *Unregisterer) Register(c prometheus.Collector) error
  • func (u *Unregisterer) Unregister(c prometheus.Collector) bool
  • func (u *Unregisterer) UnregisterAll() bool

Functions

func CompareYAML

func CompareYAML(a, b interface{}) bool

CompareYAML marshals a and b to YAML and ensures that their contents are equal. If either Marshal fails, CompareYAML returns false.

func DefaultConfigFromFlags

func DefaultConfigFromFlags(cfg interface{}) interface{}

DefaultConfigFromFlags will load default values into cfg by retrieving default values that are registered as flags.

cfg must implement either PrefixedConfigFlags or ConfigFlags.

func GoKitLogger

func GoKitLogger(l log.Logger) logging.Interface

GoKitLogger creates a logging.Interface from a log.Logger. A "caller" label will be added.

func TestLogger

func TestLogger(t *testing.T) log.Logger

TestLogger generates a logger for a test.

func Untab

func Untab(s string) string

Untab is a utility function for tests to make it easier to write YAML tests, where some editors will insert tabs into strings by default.

Types

type ConfigFlags

type ConfigFlags interface {
	RegisterFlags(f *flag.FlagSet)
}

ConfigFlags is an interface that will register flags that can control some object.

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

Logger implements Go Kit's log.Logger interface. It supports being dynamically updated at runtime.

func NewLogger

func NewLogger(cfg *server.Config) *Logger

NewLogger creates a new Logger.

func (*Logger) ApplyConfig

func (l *Logger) ApplyConfig(cfg *server.Config) error

ApplyConfig applies configuration changes to the logger.

func (*Logger) Log

func (l *Logger) Log(kvps ...interface{}) error

Log logs a log line.

type PrefixedConfigFlags

type PrefixedConfigFlags interface {
	RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
}

PrefixedConfigFlags is an interface that, given a prefix for flags and a flagset, will register flags that can control some object.

type Unregisterer

type Unregisterer struct {
	// contains filtered or unexported fields
}

Unregisterer is a Prometheus Registerer that can unregister all collectors passed to it.

func WrapWithUnregisterer

func WrapWithUnregisterer(reg prometheus.Registerer) *Unregisterer

WrapWithUnregisterer wraps a prometheus Registerer with capabilities to unregister all collectors.

func (*Unregisterer) MustRegister

func (u *Unregisterer) MustRegister(cs ...prometheus.Collector)

MustRegister implements prometheus.Registerer.

func (*Unregisterer) Register

func (u *Unregisterer) Register(c prometheus.Collector) error

Register implements prometheus.Registerer.

func (*Unregisterer) Unregister

func (u *Unregisterer) Unregister(c prometheus.Collector) bool

Unregister implements prometheus.Registerer.

func (*Unregisterer) UnregisterAll

func (u *Unregisterer) UnregisterAll() bool

UnregisterAll unregisters all collectors that were registered through the Reigsterer.