operations

Documentation

Index

• type Logger
• type MetricsOptions
• type Options
• type Statsd
• type System
  • func NewSystem(o Options) *System
  • func (s *System) Addr() string
  • func (s *System) Log(keyvals ...interface{}) error
  • func (s *System) RegisterChecker(component string, checker healthz.HealthChecker) error
  • func (s *System) RegisterHandler(pattern string, handler http.Handler)
  • func (s *System) Run(signals <-chan os.Signal, ready chan<- struct{}) error
  • func (s *System) Start() error
  • func (s *System) Stop() error
• type TLS
  • func (t TLS) Config() (*tls.Config, error)
• type VersionInfoHandler
  • func (m *VersionInfoHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request)

Types

type Logger

type Logger interface {
	Warn(args ...interface{})
	Warnf(template string, args ...interface{})
}

type MetricsOptions

type MetricsOptions struct {
	Provider string
	Statsd   *Statsd
}

type Options

type Options struct {
	Logger        Logger
	ListenAddress string
	Metrics       MetricsOptions
	TLS           TLS
	Version       string
}

type Statsd

type Statsd struct {
	Network       string
	Address       string
	WriteInterval time.Duration
	Prefix        string
}

type System

type System struct {
	metrics.Provider
	// contains filtered or unexported fields
}

func NewSystem

func NewSystem(o Options) *System

func (*System) Addr

func (s *System) Addr() string

func (*System) Log

func (s *System) Log(keyvals ...interface{}) error

func (*System) RegisterChecker

func (s *System) RegisterChecker(component string, checker healthz.HealthChecker) error

func (*System) RegisterHandler

func (s *System) RegisterHandler(pattern string, handler http.Handler)

RegisterHandler registers into the ServeMux a handler chain that borrows its security properties from the operations.System. This method is thread safe because ServeMux.Handle() is thread safe, and options are immutable. This method can be called either before or after System.Start(). If the pattern exists the method panics.

func (*System) Run

func (s *System) Run(signals <-chan os.Signal, ready chan<- struct{}) error

func (*System) Start

func (s *System) Start() error

func (*System) Stop

func (s *System) Stop() error

type TLS

type TLS struct {
	Enabled            bool
	CertFile           string
	KeyFile            string
	ClientCertRequired bool
	ClientCACertFiles  []string
}

func (TLS) Config

func (t TLS) Config() (*tls.Config, error)

type VersionInfoHandler

type VersionInfoHandler struct {
	CommitSHA string `json:"CommitSHA,omitempty"`
	Version   string `json:"Version,omitempty"`
}

func (*VersionInfoHandler) ServeHTTP

func (m *VersionInfoHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request)