core

Documentation

Index

• Constants
• func AnnotateRouter(vrs *VersionedRouterSpec) gin.HandlerFunc
• func ErrorHandler() gin.HandlerFunc
• func NewFxLogAdapter() fxevent.Logger
• func NewPrometheusServer(lc fx.Lifecycle, shutdown fx.Shutdowner, c *Config)
• func NewTracer(lc fx.Lifecycle) (trace.TracerProvider, error)
• func SetupDefaultLoglevel()
• func SetupServer(lc fx.Lifecycle, shutdown fx.Shutdowner, router *Core, config *Config) *http.Server
• type Config
  • func GetConfigDefaults() *Config
• type Core
  • func New(in In) (*Core, error)
• type FxLogAdapter
  • func (l *FxLogAdapter) LogEvent(event fxevent.Event)
• type In
• type Middleware
• type VersionedRouterOut
• type VersionedRouterSpec

Constants

const (
	GIN_KV_ROUTER_VERSION_KEY = "slapi.router_version"
	GIN_KV_ROUTER_NAME_KEY    = "slapi.router_name"
)

Functions

func AnnotateRouter

func AnnotateRouter(vrs *VersionedRouterSpec) gin.HandlerFunc

func ErrorHandler

func ErrorHandler() gin.HandlerFunc

func NewFxLogAdapter

func NewFxLogAdapter() fxevent.Logger

func NewPrometheusServer

func NewPrometheusServer(lc fx.Lifecycle, shutdown fx.Shutdowner, c *Config)

func NewTracer

func NewTracer(lc fx.Lifecycle) (trace.TracerProvider, error)

func SetupDefaultLoglevel

func SetupDefaultLoglevel()

func SetupServer

func SetupServer(lc fx.Lifecycle, shutdown fx.Shutdowner, router *Core, config *Config) *http.Server

Types

type Config

type Config struct {
	ListenAddr           string
	ListenAddrPrometheus string
	LogLevel             string
}

func GetConfigDefaults

func GetConfigDefaults() *Config

type Core

type Core struct {
	*gin.Engine
	// contains filtered or unexported fields
}

func New

func New(in In) (*Core, error)

type FxLogAdapter

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

func (*FxLogAdapter) LogEvent

func (l *FxLogAdapter) LogEvent(event fxevent.Event)

type In

type In struct {
	fx.In

	Config          *Config
	VersionedRouter []*VersionedRouterSpec `group:"router"`
	CorsConfig      *cors.Config           `optional:"true"`
	OtelTracer      trace.TracerProvider
}

type Middleware

type Middleware interface {
	Middleware(c *gin.Context)
}

type VersionedRouterOut

type VersionedRouterOut struct {
	fx.Out

	Router *VersionedRouterSpec `group:"router"`
}

type VersionedRouterSpec

type VersionedRouterSpec struct {
	Prefix         string
	Version        uint
	RegisterRouter func(group *gin.RouterGroup)
}