api

Documentation

Index

• func StartServer(logger *log.Logger, p StatusProvider, address string) (func(ctx context.Context), error)
• type StatusProvider

Functions

func StartServer

func StartServer(logger *log.Logger, p StatusProvider, address string) (func(ctx context.Context), error)

StartServer starts an http server that exposes a health check endpoint. A callback is returned that can be used to gracefully shutdown the server.

Types

type StatusProvider

type StatusProvider interface {
	Status() (pipeline.Status, error)
}

StatusProvider is a subset of the Pipeline interface required by the health handler.