webbase

package module

v1.4.1 Latest Latest Go to latest Published: Jan 5, 2024 License: MIT Imports: 12 Imported by: 1

Details

View Source

const (
	DefaultFunctionAddress = ":8080"
	DefaultMetricsAddress  = ":8081"
)

View Source

var (
	FunctionName string
)

func NewResponseWriter(w http.ResponseWriter) *responseWriter

func NewRouter() *mux.Router

NewRouter creates a new router with the default webbase middleware

func Serve(name string, functionHandler http.HandlerFunc)

Serve is a helper function to start a server with a single function handler

Deprecated: Use ServeFunction instead

func ServeFunction(name string, functionHandler http.HandlerFunc, options ...serveOption)

ServeFunction starts a server with a single handler function

func ServeRouter(name string, router *mux.Router, options ...serveOption)

ServeRouter starts a server with a set of routes

func WithHealthCheckHandlerFunc(handlerFunc http.HandlerFunc) serveOption

WithHealthCheckHandlerFunc sets the handler function for the healthcheck endpoint

func WithSentryDebug(debug bool) serveOption

WithSentryDebug sets the debug flag for sentry

func WithServiceListenAddress(address string) serveOption

WithServiceListenAddress sets the address for the service (healthcheck/metrics) listener

func WithWebListenAddress(address string) serveOption

WithWebListenAddress sets the address for the web listener

func WithoutServiceEndpoint() serveOption

WithoutServiceEndpoint disables the metrics/healthcheck endpoint

This section is empty.