kit

Documentation

Index

• func TraceMiddleware(lg *zap.Logger, m *otelMetrics, tp *trace.TracerProvider, debugHeaders bool) defaultMiddleware
• func WithAfterStart(funcs []func() error) func(*Server)
• func WithAfterStop(funcs []func() error) func(*Server)
• func WithBeforeStart(funcs []func() error) func(*Server)
• func WithBeforeStop(funcs []func() error) func(*Server)
• func WithChiAndGRPCServer(cfg ChiConfig, gcfg GRPCConfig) func(*Server)
• func WithChiServer(cfg ChiConfig) func(*Server)
• func WithCustomGoroutines(funcs []func() error) func(*Server)
• func WithEndToEndTests(configPath string) func(*Server)
• func WithGRPCServer(cfg GRPCConfig) func(*Server)
• func WithGRPCServerPort(port string) func(*Server)
• func WithGinAndGRPCServer(cfg GinConfig, gcfg GRPCConfig) func(*Server)
• func WithGinServer(cfg GinConfig) func(*Server)
• func WithHTTPServerPort(port string) func(*Server)
• func WithParallelMode() func(*Server)
• func WithServerName(name string) func(*Server)
• type ChiConfig
  • func (c *ChiConfig) NewDefaultChi(ctx context.Context, lg *zap.Logger, ...) (*chi.Mux, *trace.TracerProvider)
• type E2eTests
• type GRPCConfig
  • func (c *GRPCConfig) NewDefaultGRPCServer() *grpc.Server
• type GinConfig
  • func (c *GinConfig) NewBlankGin() *gin.Engine
  • func (c *GinConfig) NewDefaultGin() *gin.Engine
• type Server
  • func New(options ...func(*Server)) *Server
  • func (s *Server) Start() error

Functions

func TraceMiddleware

func TraceMiddleware(lg *zap.Logger, m *otelMetrics, tp *trace.TracerProvider, debugHeaders bool) defaultMiddleware

func WithAfterStart

func WithAfterStart(funcs []func() error) func(*Server)

WithAfterStart executes functions after engine start.

func WithAfterStop

func WithAfterStop(funcs []func() error) func(*Server)

WithAfterStop executes functions after engine stop.

func WithBeforeStart

func WithBeforeStart(funcs []func() error) func(*Server)

WithBeforeStart executes functions before engine start.

func WithBeforeStop

func WithBeforeStop(funcs []func() error) func(*Server)

WithBeforeStop executes functions before engine stop.

func WithChiAndGRPCServer

func WithChiAndGRPCServer(cfg ChiConfig, gcfg GRPCConfig) func(*Server)

WithChiAndGRPCServer provides metrics http and grpc engine and runs them after Start.

func WithChiServer

func WithChiServer(cfg ChiConfig) func(*Server)

WithChiServer provides metrics http kit and runs it after Start.

func WithCustomGoroutines

func WithCustomGoroutines(funcs []func() error) func(*Server)

WithCustomGoroutines adds goroutines to main errgroup instance of kit.

func WithEndToEndTests

func WithEndToEndTests(configPath string) func(*Server)

WithEndToEndTests enables server to run end-to-end tests in cli mode.

func WithGRPCServer

func WithGRPCServer(cfg GRPCConfig) func(*Server)

WithGRPCServer provides grpc kit and runs it after Start.

func WithGRPCServerPort

func WithGRPCServerPort(port string) func(*Server)

WithGRPCServerPort sets provided port to grpc kit.

func WithGinAndGRPCServer

func WithGinAndGRPCServer(cfg GinConfig, gcfg GRPCConfig) func(*Server)

WithGinAndGRPCServer provides gin http and grpc engine and runs them after Start.

func WithGinServer

func WithGinServer(cfg GinConfig) func(*Server)

WithGinServer provides gin http kit and runs it after Start.

func WithHTTPServerPort

func WithHTTPServerPort(port string) func(*Server)

WithHTTPServerPort sets provided port to http kit.

func WithParallelMode

func WithParallelMode() func(*Server)

WithParallelMode sets http and grpc engine to bind on one port and segregate requests by headers.

func WithServerName

func WithServerName(name string) func(*Server)

WithServerName sets name of service.

Types

type ChiConfig

type ChiConfig struct {
	Default bool
}

func (*ChiConfig) NewDefaultChi

func (c *ChiConfig) NewDefaultChi(ctx context.Context, lg *zap.Logger, serverName, serverVersion, jaegerHost string, debugHeaders bool) (*chi.Mux, *trace.TracerProvider)

type E2eTests

type E2eTests []e2eTest

type GRPCConfig

type GRPCConfig struct {
	Default bool
}

func (*GRPCConfig) NewDefaultGRPCServer

func (c *GRPCConfig) NewDefaultGRPCServer() *grpc.Server

type GinConfig

type GinConfig struct {
	Default bool
	Blank   bool
}

func (*GinConfig) NewBlankGin

func (c *GinConfig) NewBlankGin() *gin.Engine

func (*GinConfig) NewDefaultGin

func (c *GinConfig) NewDefaultGin() *gin.Engine

type Server

type Server struct {
	// !ATTENTION! Options must be set before Start.
	ServerName    string
	ServerVersion string

	RootCtx context.Context

	GinServer *gincore.Engine
	ChiServer *chicore.Mux

	GRPCServer *grpccore.Server

	// Loggers.
	DefaultLogger *zapl.Logger

	PromCollectors []prometheus.Collector
	// contains filtered or unexported fields
}

Server describes all services configurations, must be executed with Start.

func New

func New(options ...func(*Server)) *Server

New is base constructor function to create service with options, but won't work without Start.

func (*Server) Start

func (s *Server) Start() error

Start starts all engine. Start runs engine with provided options.