webbase

package module

v1.5.5 Latest Latest Go to latest Published: Mar 18, 2024 License: MIT Imports: 12 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

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

View Source

var (
	FunctionName string
)

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 WithSentryClientOptions(options sentry.ClientOptions) serveOption

WithSentryClientOptions configures the sentry client sdk

func WithSentryDebug(debug bool) serveOption

WithSentryDebug sets the debug flag for sentry This option will be overwritten by WithSentryClientOptions if used together

Deprecated: Use WithSentryClientOptions instead

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.