serverutil

Documentation

Overview

Package serverutil provides helper functions to main.go files.

Index

• func Healthz() http.HandlerFunc
• func ListenTLS(ctx context.Context, listenAddr, certFile, keyFile string) (net.Listener, *grpc.ClientConn, func(), error)
• func Readyz(db *sql.DB) http.HandlerFunc
• func RootHealthHandler(otherHandler http.Handler) http.HandlerFunc
• func ServeHTTPAPIAndGRPC(ctx context.Context, lis net.Listener, grpcServer *grpc.Server, ...) error
• func ServeHTTPMetrics(addr string, ready http.HandlerFunc) error
• type RegisterServiceFromConn

Functions

func Healthz

func Healthz() http.HandlerFunc

Healthz is a liveness handler that always responds with HTTP 200.

func ListenTLS

func ListenTLS(ctx context.Context, listenAddr, certFile, keyFile string) (net.Listener, *grpc.ClientConn, func(), error)

ListenTLS binds to listenAddr and returns a gRPC connection to it.

func Readyz

func Readyz(db *sql.DB) http.HandlerFunc

Readyz is a readiness probe.

func RootHealthHandler

func RootHealthHandler(otherHandler http.Handler) http.HandlerFunc

RootHeaalthHandler handles liveness checks at "/". All other requests are passed through to `otherHandler`.

func ServeHTTPAPIAndGRPC

func ServeHTTPAPIAndGRPC(ctx context.Context, lis net.Listener,
	grpcServer *grpc.Server, conn *grpc.ClientConn,
	services ...RegisterServiceFromConn) error

ServeAPIGatewayAndGRPC serves the given services over HTTP / JSON and gRPC.

func ServeHTTPMetrics

func ServeHTTPMetrics(addr string, ready http.HandlerFunc) error

ServeHTTPMetrics serves monitoring APIs

Types

type RegisterServiceFromConn

type RegisterServiceFromConn func(context.Context, *runtime.ServeMux, *grpc.ClientConn) error

RegisterServiceFromConn registers services with a grpc server's ServeMux