app

type API ¶

type API interface {
	RegisterHandler(mux *httprouter.Router)
}

API is a service that exposes API routes

type App ¶

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

An App is a modular application with HTTP server. It allows users to register custom Services and automatically deals with the lifecycle of those services on call to Run()

func New(cfg *Config) (*App, error)

func (app *App) Logger() *logrus.Logger

func (app *App) RegisterService(svc interface{})

func (app *App) Run() error

func (app *App) SetLogger(logger *logrus.Logger)

type Checkable ¶

type Checkable interface {
	RegisterCheck(h *health.Health) error
}

Checkable is a service that can expose its health status

type Closable ¶

type Closable interface {
	Close() error
}

Closable is a service that needs to clean its state at the end of its execution

type Config ¶

type Config struct {
	Logger       *kilnlog.Config
	Server       *kilnhttp.ServerConfig
	Healthz      *kilnhttp.ServerConfig
	StartTimeout *types.Duration
	StopTimeout  *types.Duration
}

func ConfigFromViper(v *viper.Viper) *Config

func (cfg *Config) SetDefault() *Config

type Initializable ¶

type Initializable interface {
	Init(context.Context) error
}

Initializable is a service that can initialize

type Loggable ¶

type Loggable interface {
	SetLogger(logger logrus.FieldLogger)
}

Loggaable is a service that holds a logger

type Measurable ¶

type Measurable interface {
	RegisterMetrics(prometheus.Registerer) error
}

Checkable is a service that can expose metrics

type Middleware ¶

type Middleware interface {
	RegisterMiddleware(chain alice.Chain) alice.Chain
}

Middleware is a service that exposes a middleware to be set on an App

type Runnable ¶

type Runnable interface {
	Start(context.Context) error
	Stop(context.Context) error
}

Runnable is a service that maintains long living task(s)