http

Documentation

Index

• Constants
• func Flags() *pflag.FlagSet
• func NewFileServer(filePath string) *swaggerHandler
• type Option
  • func DisableLoggingMiddleware() Option
  • func HealthEndpoint(endpoint string) Option
  • func LoggingSkipEndpoints(skip ...string) Option
  • func Name(name string) Option
  • func Port(addr string) Option
  • func ShutdownGracePeriod(duration time.Duration) Option
• type Options
• type Server
  • func NewDebugServer(port string) Server
  • func NewServer(opts ...Option) Server

Constants

const (
	PortConfigKey        = "http-port"
	GracePeriodConfigKey = "http-grace-period"
)

const DefaultGracePeriod = 3 * time.Second

const DefaultHealthEndpoint = "/health"

const DefaultLoggingMiddlewareEnabled = true

const DefaultName = "default"

const DefaultPort = "8080"

const DefaultPrometheusMiddlewareEnabled = true

Functions

func Flags

func Flags() *pflag.FlagSet

Flags is a convenience function to quickly add the HTTP server options as CLI flags Implements the cli.FlagProvider type

func NewFileServer

func NewFileServer(filePath string) *swaggerHandler

Types

type Option

type Option func(*Options)

func DisableLoggingMiddleware

func DisableLoggingMiddleware() Option

func HealthEndpoint

func HealthEndpoint(endpoint string) Option

func LoggingSkipEndpoints

func LoggingSkipEndpoints(skip ...string) Option

func Name

func Name(name string) Option

func Port

func Port(addr string) Option

func ShutdownGracePeriod

func ShutdownGracePeriod(duration time.Duration) Option

type Options

type Options struct {
	Port                        string
	Name                        string
	HealthEndpoint              string
	ShutdownGracePeriod         time.Duration
	LoggingMiddlewareEnabled    bool
	PrometheusMiddlewareEnabled bool
	LoggingSkipEndpoints        []string
}

type Server

type Server interface {
	ListenAndServe(ctx context.Context, wg *sync.WaitGroup)
	Handle(endpoint string, handler http.Handler)
}

func NewDebugServer

func NewDebugServer(port string) Server

NewDebugServer is a convenience wrapper to quickly create a HTTP server, serving on port 3000. The server has the prometheus HTTP handler attached to '/metrics'.

func NewServer

func NewServer(opts ...Option) Server