serverkit

Oct 29, 2026

Changes in this version

+ const StreamTypeAttr

type DBPoolTuning

+ SpareConns int

Oct 29, 2026

Changes in this version

+ const DefaultLivenessPath

+ const DefaultReadinessPath

+ const DefaultSlowAfter

+ const DefaultSlowRepeat

+ const DefaultUnaryDeadline

+ var ErrReceiveAborted = errors.New("serverkit: request body reads aborted by the handler")

+ func AbortReceive(ctx context.Context) bool

+ func AwaitMigrationsContext(ctx context.Context, cfg Config, logger *slog.Logger, ...) error

+ func CanAbortReceive(ctx context.Context) bool

+ func LogTelemetryFlushError(ctx context.Context, logger *slog.Logger, msg string, err error)

+ func PgxConn(driverConn any) (*pgx.Conn, bool)

+ func ProbePathList(s string) []string

type Authenticator

+ func AuthWithCaller(audience string, interceptor connect.Interceptor, caller CallerLookup) Authenticator

+ Caller func() CallerLookup

type BootProbes

+ func (b *BootProbes) Constructing(node string) (done func(err error))

+ type CallerLookup = func(ctx context.Context) (*authn.Claims, bool)

type ChainDeps

+ Activity connect.Interceptor

+ Deadline connect.Interceptor

type Config

+ Probes ProbePaths

+ type Deadline = observe.Deadline

type Listener

+ func NewProbeListener(deps ProbeListenerDeps) (*Listener, error)

type Omit

+ const NoActivity

+ const NoDeadline

+ func (o Omit) OmittedSlot() string

+ type ProbeListenerDeps struct

+ Config ListenerConfig

+ Logger *slog.Logger

+ Probes *Probes

+ type ProbePaths struct

+ Live []string

+ Ready []string

+ func (p ProbePaths) Validate() error

+ func (p ProbePaths) WithDefaults() ProbePaths

type Probes

+ Paths ProbePaths

+ func (p *Probes) Handle(path string, h http.Handler) error

+ type SlowCall = observe.SlowCall

Oct 20, 2026

Changes in this version

+ const AudienceUser

+ const DefaultDrainReserve

+ const DefaultMaxBytes

+ const DrainedTrailer

+ func AfterDrain(ctx context.Context, f func()) (stop func() bool)

+ func DrainDeadline(ctx context.Context) (deadline time.Time, ok bool)

+ func DrainHTTP(ctx context.Context, srv *http.Server, streams *Streams) error

+ func Draining(ctx context.Context) <-chan struct

+ func Ended(ctx context.Context) bool

+ func LongLived(h http.Handler) http.Handler

+ func NewHTTPServer(cfg Config, handler http.Handler, streams *Streams) *http.Server

+ func ServiceAudience(sd protoreflect.ServiceDescriptor) string

+ func SetupTelemetry(ctx context.Context, cfg Config) (func(context.Context) error, http.Handler, error)

+ func StreamDrainInterceptor() connect.Interceptor

+ type Authenticator interface

+ Audience func() string

+ func AuthFor(audience string, interceptor connect.Interceptor) Authenticator

+ type Chain struct

+ func NewChain(deps ChainDeps) (*Chain, error)

+ func (c *Chain) Audience() string

+ func (c *Chain) HandlerOptions() []connect.HandlerOption

+ func (c *Chain) Interceptors() []connect.Interceptor

+ type ChainDeps struct

+ Audit connect.Interceptor

+ Auth Authenticator

+ Extras []connect.Interceptor

+ LogOptions []observe.LogOption

+ Logger *slog.Logger

+ RateLimit connect.Interceptor

+ ReadMaxBytes int

+ SendMaxBytes int

+ StreamDrain connect.Interceptor

+ Trace connect.Interceptor

+ Validate connect.Interceptor

type Config

+ DrainReserve time.Duration

+ HTTP2MaxConcurrentStreams int

+ IdleTimeout time.Duration

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ RedialOnDrain []string

+ func (c Config) Listener() ListenerConfig

+ type DrainReport struct

+ Claimed int

+ ConnsClosed int

+ Ended int

+ HardEnded int

+ StillRunning int

+ type Drainer struct

+ Logger *slog.Logger

+ Meter metric.Meter

+ PreStopDelay time.Duration

+ ShutdownTimeout time.Duration

+ func NewDrainer(cfg Config) *Drainer

+ func (d *Drainer) Begin()

+ func (d *Drainer) Complete()

+ func (d *Drainer) Draining() bool

+ func (d *Drainer) MarkReady()

+ func (d *Drainer) Phase(name string, start time.Time, msg string, attrs ...any) time.Time

+ func (d *Drainer) ReadinessHandler(checks []ReadyCheck, timeout time.Duration, logger *slog.Logger) http.HandlerFunc

+ func (d *Drainer) Ready() bool

+ func (d *Drainer) ShutdownContext() (context.Context, context.CancelFunc)

+ type Edge struct

+ CORS func(origins []string, allowCredentials bool) func(http.Handler) http.Handler

+ Outer func(http.Handler) http.Handler

+ RequestID func() func(http.Handler) http.Handler

+ SecurityHeaders func(production bool) func(http.Handler) http.Handler

+ func (e Edge) Wrap(cfg Config) (func(http.Handler) http.Handler, error)

+ type Listener struct

+ func NewListener(deps ListenerDeps) (*Listener, error)

+ func (l *Listener) Addr() net.Addr

+ func (l *Listener) Audience() string

+ func (l *Listener) Close(context.Context) error

+ func (l *Listener) Drain(ctx context.Context) error

+ func (l *Listener) Listen(ctx context.Context) error

+ func (l *Listener) Ready(context.Context) error

+ func (l *Listener) Run(ctx context.Context) error

+ func (l *Listener) Services() []string

+ func (l *Listener) Streams() *Streams

+ type ListenerConfig struct

+ Addr string

+ DrainReserve time.Duration

+ HTTP2MaxConcurrentStreams int

+ IdleTimeout time.Duration

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ RedialOnDrain []string

+ TLSCertPath string

+ TLSKeyPath string

+ WriteStallTimeout time.Duration

+ type ListenerDeps struct

+ Chain *Chain

+ Config ListenerConfig

+ Edge func(http.Handler) http.Handler

+ Front map[string]http.Handler

+ Logger *slog.Logger

+ REST bool

+ Routes Routes

+ type Omit string

+ const NoAudit

+ const NoStreamDrain

+ const NoTrace

+ const NoValidate

+ func (Omit) WrapStreamingClient(next connect.StreamingClientFunc) connect.StreamingClientFunc

+ func (Omit) WrapStreamingHandler(next connect.StreamingHandlerFunc) connect.StreamingHandlerFunc

+ func (Omit) WrapUnary(next connect.UnaryFunc) connect.UnaryFunc

+ type Pprof struct

+ func NewPprof(cfg Config, logger *slog.Logger) *Pprof

+ func (p *Pprof) Close(ctx context.Context) error

+ func (p *Pprof) Run(ctx context.Context) error

+ type Probes struct

+ Drainer *Drainer

+ Logger *slog.Logger

+ Metrics http.Handler

+ Timeout time.Duration

+ func (p *Probes) AddReadyCheck(checks ...ReadyCheck)

+ func (p *Probes) Front() map[string]http.Handler

+ func (p *Probes) ReadyChecks() []ReadyCheck

+ type Routes interface

+ Register func(mux *http.ServeMux, opts ...connect.HandlerOption) []string

+ type RoutesFunc func(mux *http.ServeMux, opts ...connect.HandlerOption) []string

+ func (f RoutesFunc) Register(mux *http.ServeMux, opts ...connect.HandlerOption) []string

type Server

+ Chain *Chain

+ type Streams struct

+ DrainReserve time.Duration

+ Logger *slog.Logger

+ Meter metric.Meter

+ RedialOnDrain []string

+ func NewStreams() *Streams

+ func StreamsFrom(ctx context.Context) *Streams

+ func (s *Streams) Active() int

+ func (s *Streams) BeginDrain() (ended, left int)

+ func (s *Streams) Bind(parent context.Context) (ctx context.Context, release context.CancelFunc)

+ func (s *Streams) CloseHijacked() int

+ func (s *Streams) Drain(ctx context.Context) error

+ func (s *Streams) End() int

+ func (s *Streams) Install(h http.Handler) http.Handler

+ func (s *Streams) Report() DrainReport

+ func (s *Streams) Wait(ctx context.Context) bool

Oct 14, 2026

Changes in this version

+ const DefaultDBConnectTimeout

+ const DefaultWriteStallTimeout

+ const EnvDevelopment

+ func ApplyDBPoolTuning(db *sql.DB, t DBPoolTuning)

+ func AutoMigrate(cfg Config, logger *slog.Logger, migrate func(*sql.DB, *slog.Logger) error) error

+ func AutoMigrateContext(ctx context.Context, cfg Config, logger *slog.Logger, ...) error

+ func Boot(cfg Config) (*slog.Logger, *http.ServeMux)

+ func NewLogger(cfg Config) *slog.Logger

+ func OpenDB(ctx context.Context, driver, dsn string, pool DBPoolTuning, p ConnectPolicy) (*sql.DB, error)

+ func RESTHandler(mux *http.ServeMux, connectPaths []string, logger *slog.Logger) http.Handler

+ func RequireMounted(srv *Server, src DescriptorSource) error

+ func RetryConnect(ctx context.Context, p ConnectPolicy, attempt func(ctx context.Context) error) error

+ func Run(ctx context.Context, cfg Config, srv Server) error

+ func WriteStallGuard(h http.Handler, stall time.Duration) http.Handler

+ type BootProbes struct

+ func BootProbesFrom(ctx context.Context) *BootProbes

+ func StartBootProbes(ctx context.Context, cfg Config, logger *slog.Logger) (context.Context, *BootProbes, error)

+ func (b *BootProbes) Close()

+ type Config struct

+ Addr string

+ AutoMigrate bool

+ CORSAllowCredentials bool

+ CORSOrigins []string

+ DBConnectTimeout time.Duration

+ DBDriver string

+ DBPoolTuning DBPoolTuning

+ DatabaseURL string

+ Environment string

+ FailurePolicy FailurePolicy

+ LogFormat string

+ LogLevel slog.Level

+ OTLPEndpoint string

+ OperatorHealthProbeAddr string

+ PprofAddr string

+ PreStopDelay time.Duration

+ ReadMaxBytes int

+ ReadinessTimeout time.Duration

+ SecurityHeaders bool

+ SendMaxBytes int

+ ServiceName string

+ ServiceVersion string

+ ShutdownTimeout time.Duration

+ TLSCertPath string

+ TLSKeyPath string

+ WriteStallTimeout time.Duration

+ func (c *Config) Normalize()

+ func (c Config) CORSEnabled() bool

+ func (c Config) ConnectPolicy(logger *slog.Logger) ConnectPolicy

+ func (c Config) IsDevelopment() bool

+ type ConnectPolicy struct

+ AttemptTimeout time.Duration

+ InitialBackoff time.Duration

+ LogEvery time.Duration

+ Logger *slog.Logger

+ MaxBackoff time.Duration

+ Name string

+ Timeout time.Duration

+ type ConnectTimeoutError struct

+ Attempts int

+ Class string

+ Elapsed time.Duration

+ Last error

+ Name string

+ func (e *ConnectTimeoutError) Error() string

+ func (e *ConnectTimeoutError) Unwrap() error

+ type ContextWorker interface

+ RunContext func(ctx context.Context) error

+ type DBPoolTuning struct

+ ConnMaxIdleTime time.Duration

+ ConnMaxLifetime time.Duration

+ MaxIdleConns int

+ MaxOpenConns int

+ type DescriptorSource interface

+ RangeFiles func(func(protoreflect.FileDescriptor) bool)

+ type FailurePolicy int

+ const FailProcess

+ const Ignore

+ type FlowCheck struct

+ Check func(ctx context.Context) FlowResult

+ Name string

+ type FlowResult struct

+ OK bool

+ Summary string

+ type Operator interface

+ Name func() string

+ type ReadyCheck struct

+ Check func(ctx context.Context) error

+ Name string

+ func DBReadyCheck(name string, db *sql.DB) ReadyCheck

+ type Server struct

+ CORSMiddleware func(origins []string, allowCredentials bool) func(http.Handler) http.Handler

+ FlowChecks []FlowCheck

+ HTTPMiddleware func(http.Handler) http.Handler

+ Handler http.Handler

+ HandlerOpts []connect.HandlerOption

+ Logger *slog.Logger

+ Mux *http.ServeMux

+ OnShutdown func(context.Context) error

+ Operators []Operator

+ ReadyChecks []ReadyCheck

+ RequestIDMiddleware func() func(http.Handler) http.Handler

+ RunOperators func(ctx context.Context, logger *slog.Logger, healthProbeAddr string) error

+ SecurityHeadersMiddleware func(production bool) func(http.Handler) http.Handler

+ Workers []Worker

+ func (s *Server) AddFlowCheck(c FlowCheck)

+ func (s *Server) AddOperator(o Operator)

+ func (s *Server) AddReadyCheck(c ReadyCheck)

+ func (s *Server) AddWorker(w Worker)

+ func (s *Server) AddWorkers(workers []Worker)

+ func (s *Server) Mount(connectPath string, svc any, mountOpts ...mountkit.Option)

+ func (s *Server) Mounted(name string)

+ func (s *Server) MountedNames() []string

+ func (s *Server) RecordMounted(connectPaths []string)

+ func (s *Server) RequireComplete(inv []inventory.ComponentInfo) error

+ func (s *Server) RequireMounted(src DescriptorSource) error

+ type Worker interface

+ Name func() string

+ Start func(ctx context.Context) error

+ Stop func(ctx context.Context) error