live

Documentation

Index

• type Liveness
• type Server
  • func NewServer(options ...ServerOption) (*Server, error)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type ServerOption
  • func OptionCore(core Liveness) ServerOption
  • func OptionMetricsCollector(collector *metrics.Collector) ServerOption
  • func OptionTracer(tracer opentracing.Tracer) ServerOption
  • func OptionUndefinedHandler(handler http.Handler) ServerOption

Types

type Liveness

type Liveness interface {
	Live(ctx context.Context) bool
}

Liveness defines the method for checking server liveness.

type Server

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

Server is titan's liveness endpoint.

func NewServer

func NewServer(options ...ServerOption) (*Server, error)

NewServer returns a fully initialized Server.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)

type ServerOption

type ServerOption func(*Server)

ServerOption applies a parameter to a Server.

func OptionCore

func OptionCore(core Liveness) ServerOption

OptionCore sets the core to use for Liveness checks.

func OptionMetricsCollector

func OptionMetricsCollector(collector *metrics.Collector) ServerOption

OptionMetricsCollector sets the http.Handler to use for the metrics endpoint.

func OptionTracer

func OptionTracer(tracer opentracing.Tracer) ServerOption

OptionTracer sets the opentracing.Tracer to use for tracing.

func OptionUndefinedHandler

func OptionUndefinedHandler(handler http.Handler) ServerOption

OptionUndefinedHandler sets the http.Handler to use for the unknown endpoint.