server

Documentation

Overview

Package server provides a generic server implementation which is used by the different applications to serve their build info, health status and API.

Index

• Constants
• type Config
  • func (c Config) Validate() error
• type Option
  • func With(fn func(app *Server) Option) Option
  • func WithBuildInfo(bld *buildinfo.BuildInfo) Option
  • func WithRoutes(r serv.RoutesRegisterer) Option
  • func WithTelemetry(tc telemetry.Config) Option
  • func WithTelemetryAndPrometheus(tc telemetry.Config, pc PrometheusConfig) Option
• type PrometheusConfig
  • func (c PrometheusConfig) Validate() error
• type Server
  • func New(name string, conf Config, log zerolog.Logger, handler http.Handler, ...) (*Server, error)
  • func (app *Server) MeterProvider() telemetry.MeterProvider
  • func (app *Server) Name() string
  • func (app *Server) Router() serv.Router
  • func (app *Server) Run(ctx context.Context) error
  • func (app *Server) Shutdown(ctx context.Context) error
  • func (app *Server) TracerProvider() telemetry.TracerProvider

Constants

const (
	BuildInfoRoute         = buildinfo.MetricName
	HealthCheckRoute       = "healthcheck"
	PrometheusMetricsRoute = "prometheus-metrics"

	ErrInvalidPrometheusPath errors.Msg = "invalid prometheus path"
	ConfigValidationError               = youlessclient.ConfigValidationError
)

Types

type Config

type Config struct {
	Port      serv.Port `default:"2512"`
	AccessLog bool      `default:"true"`
	TLS       serv.TLSConfig
}

func (Config) Validate

func (c Config) Validate() error

type Option

type Option interface {
	// contains filtered or unexported methods
}

func With

func With(fn func(app *Server) Option) Option

func WithBuildInfo

func WithBuildInfo(bld *buildinfo.BuildInfo) Option

func WithRoutes

func WithRoutes(r serv.RoutesRegisterer) Option

func WithTelemetry

func WithTelemetry(tc telemetry.Config) Option

func WithTelemetryAndPrometheus

func WithTelemetryAndPrometheus(tc telemetry.Config, pc PrometheusConfig) Option

type PrometheusConfig

type PrometheusConfig struct {
	Enabled bool
	Path    string `default:"/metrics"`
}

func (PrometheusConfig) Validate

func (c PrometheusConfig) Validate() error

type Server

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

func New

func New(name string, conf Config, log zerolog.Logger, handler http.Handler, opts ...Option) (*Server, error)

func (*Server) MeterProvider

func (app *Server) MeterProvider() telemetry.MeterProvider

func (*Server) Name

func (app *Server) Name() string

func (*Server) Router

func (app *Server) Router() serv.Router

func (*Server) Run

func (app *Server) Run(ctx context.Context) error

func (*Server) Shutdown

func (app *Server) Shutdown(ctx context.Context) error

func (*Server) TracerProvider

func (app *Server) TracerProvider() telemetry.TracerProvider