util

Documentation

Index

• func CompareYAML(a, b interface{}) bool
• func DefaultConfigFromFlags(cfg interface{}) interface{}
• func GoKitLogger(l log.Logger) logging.Interface
• func MarshalYAMLMerged(vv ...interface{}) ([]byte, error)
• func TestLogger(t *testing.T) log.Logger
• func UnmarshalYAMLMerged(bb []byte, vv ...interface{}) error
• func Untab(s string) string
• type ConfigFlags
• type Logger
  • func NewLogger(cfg *server.Config) *Logger
  • func NewLoggerFromLevel(lvl logging.Level, fmt logging.Format) *Logger
  • func (l *Logger) ApplyConfig(cfg *server.Config) error
  • func (l *Logger) Log(kvps ...interface{}) error
• type PrefixedConfigFlags
• type RawYAML
  • func (r RawYAML) Map() (yaml.MapSlice, error)
  • func (r RawYAML) MarshalYAML() (interface{}, error)
  • func (r *RawYAML) UnmarshalYAML(unmarshal func(interface{}) error) error
• 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
• type WaitTrigger
  • func NewWaitTrigger() *WaitTrigger
  • func (wt *WaitTrigger) Trigger()
  • func (wt *WaitTrigger) Wait(timeout time.Duration) error
  • func (wt *WaitTrigger) WaitContext(ctx context.Context) error

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.

func MarshalYAMLMerged

func MarshalYAMLMerged(vv ...interface{}) ([]byte, error)

MarshalYAMLMerged marshals all values from vv into a single object.

func TestLogger

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

TestLogger generates a logger for a test.

func UnmarshalYAMLMerged

func UnmarshalYAMLMerged(bb []byte, vv ...interface{}) error

UnmarshalYAMLMerged performs a strict unmarshal of bb into all values from vv.

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 NewLoggerFromLevel

func NewLoggerFromLevel(lvl logging.Level, fmt logging.Format) *Logger

NewLoggerFromLevel creates a new logger from logging.Level and logging.Format.

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 RawYAML

type RawYAML []byte

RawYAML is similar to json.RawMessage and allows for deferred YAML decoding.

func (RawYAML) Map

func (r RawYAML) Map() (yaml.MapSlice, error)

Map converts the raw YAML into a yaml.MapSlice.

func (RawYAML) MarshalYAML

func (r RawYAML) MarshalYAML() (interface{}, error)

MarshalYAML implements yaml.Marshaler.

func (*RawYAML) UnmarshalYAML

func (r *RawYAML) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

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.

type WaitTrigger

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

WaitTrigger allows for waiting for a specific condition to be met. Useful for tests.

func NewWaitTrigger

func NewWaitTrigger() *WaitTrigger

NewWaitTrigger creates a new WaitTrigger.

func (*WaitTrigger) Trigger

func (wt *WaitTrigger) Trigger()

Trigger completes the trigger and alerts all waiting. Calling Trigger again after the first invocation is a no-op.

func (*WaitTrigger) Wait

func (wt *WaitTrigger) Wait(timeout time.Duration) error

Wait waits for trigger to complete up to the specified timeout. Returns an error if the timeout expires.

func (*WaitTrigger) WaitContext

func (wt *WaitTrigger) WaitContext(ctx context.Context) error

WaitContext waits for trigger to complete or for the context to cancel. Returns an error if ctx gets canceled.