Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

v8

package module

Go to main page

Versions in this module

v8

v8.0.2

May 19, 2021

v8.0.1

Apr 12, 2021

v8.0.0

Mar 9, 2021

Changes in this version

+ const AcceptHeader

+ const ContentTypeHeader

+ const ContentTypeJSON

+ const ContentTypeXML

+ var DefaultMiddlewares = []Middleware

+ var MethodsForGet = []string

+ var MethodsForPost = []string

+ func NewExitFunc(log Logger, shutdownFunc ShutdownFunc) func(int)

+ type BuildVersion struct

+ BuildDate string

+ GitHash string

+ VersionNumber string

+ type CORSOptions struct

+ AllowedHeaders []string

+ AllowedMethods []string

+ AllowedOrigins []string

+ ExposedHeaders []string

+ MaxAge int

+ type ErrorResponse struct

+ Message string

+ type ExitFunc func(int)

+ type Handle func(WrappedResponseWriter, *http.Request, RouterParams)

+ type Handlers struct

+ HealthHandler HealthHandler

+ LivenessHandler LivenessHandler

+ MetricsHandler MetricsHandler

+ PreFlightHandler PreFlightHandler

+ QuitHandler QuitHandler

+ ReadinessHandler ReadinessHandler

+ RootHandler RootHandler

+ VersionHandler VersionHandler

+ type HealthHandler interface

+ NewHealthHandler func() Handle

+ type HistogramVec interface

+ RecordDuration func(start time.Time, unit time.Duration)

+ RecordTimeElapsed func(start time.Time)

+ type LivenessHandler interface

+ NewLivenessHandler func() Handle

+ type LogFactory interface

+ NewLogger func(meta map[string]string) Logger

+ func NewLogFactory(logFilter string, baseMeta map[string]string) LogFactory

+ type Logger interface

+ Debug func(event, formatOrMsg string, a ...interface{})

+ Error func(event, formatOrMsg string, a ...interface{})

+ Info func(event, formatOrMsg string, a ...interface{})

+ Warn func(event, formatOrMsg string, a ...interface{})

+ type MetaFunc func(*http.Request, RouterParams) map[string]string

+ type Metrics interface

+ AddHistogramVec func(subsystem, name, help string, labels, labelValues []string) HistogramVec

+ AddSummaryVec func(subsystem, name, help string, labels, labelValues []string) SummaryVec

+ Count func(subsystem, name, help string)

+ CountLabels func(subsystem, name, help string, labels, values []string)

+ IncreaseCounter func(subsystem, name, help string, increment int)

+ SetGauge func(value float64, subsystem, name, help string)

+ func NewMetrics(namespace string, logger Logger) Metrics

+ type MetricsHandler interface

+ NewMetricsHandler func() Handle

+ type Middleware int

+ const CORS

+ const Counter

+ const Histogram

+ const NoCaching

+ const PanicTo500

+ const RequestLogging

+ const RequestMetrics

+ type MiddlewareWrapper interface

+ Wrap func(subsystem, name string, middleware Middleware, handler Handle, ...) Handle

+ func NewMiddlewareWrapper(logFactory LogFactory, metrics Metrics, corsOptions *CORSOptions, ...) MiddlewareWrapper

+ type PreFlightHandler interface

+ NewPreFlightHandler func() Handle

+ type QuitHandler interface

+ NewQuitHandler func() Handle

+ type ReadinessHandler interface

+ NewReadinessHandler func() Handle

+ type RootHandler interface

+ NewRootHandler func() Handle

+ type Router struct

+ Router *httprouter.Router

+ type RouterFactory interface

+ NewRouter func() *Router

+ func NewRouterFactory() RouterFactory

+ type RouterParams struct

+ Params httprouter.Params

+ type Service interface

+ AddRoute func(name string, routes []string, methods []string, middlewares []Middleware, ...)

+ Run func(ctx context.Context)

+ func NewCustomService(options ServiceOptions) Service

+ func NewService(group, name string, allowedMethods []string, shutdownFunc ShutdownFunc, ...) Service

+ type ServiceGlobals struct

+ AppName string

+ DeployEnvironment string

+ GroupName string

+ ServerName string

+ VersionNumber string

+ type ServiceHandlerFactory interface

+ NewHandlers func() *Handlers

+ func NewServiceHandlerFactory(middlewareWrapper MiddlewareWrapper, versionBuilder VersionBuilder, ...) ServiceHandlerFactory

+ type ServiceOptions struct

+ ExitFunc ExitFunc

+ Globals ServiceGlobals

+ Handlers *Handlers

+ IdleTimeout time.Duration

+ InternalPort int

+ LogFactory LogFactory

+ Metrics Metrics

+ MiddlewareWrapper MiddlewareWrapper

+ Port int

+ ReadinessPort int

+ RouterFactory RouterFactory

+ ServerTimeout time.Duration

+ ServiceStateReader ServiceStateReader

+ ShutdownFunc ShutdownFunc

+ UsePublicRootHandler bool

+ VersionBuilder VersionBuilder

+ WrapHandler WrapHandler

+ func NewServiceOptions(group, name string, allowedMethods []string, shutdownFunc ShutdownFunc, ...) ServiceOptions

+ func (o *ServiceOptions) SetHandlers()

+ type ServiceStateReader interface

+ IsHealthy func() bool

+ IsLive func() bool

+ IsReady func() bool

+ func NewServiceStateReader() ServiceStateReader

+ type ShutdownFunc func(log Logger)

+ type SummaryVec interface

+ RecordDuration func(start time.Time, unit time.Duration)

+ RecordTimeElapsed func(start time.Time)

+ type VersionBuilder interface

+ ToMap func() map[string]string

+ ToString func() string

+ func NewVersionBuilder(version BuildVersion) VersionBuilder

+ type VersionHandler interface

+ NewVersionHandler func() Handle

+ type WrapHandler interface

+ Wrap func(string, string, []Middleware, Handle, MetaFunc) httprouter.Handle

+ type WrappedResponseWriter interface

+ AcceptsXML func(r *http.Request) bool

+ JSON func(statusCode int, content interface{})

+ SetCaching func(maxAge int)

+ Status func() int

+ WriteResponse func(r *http.Request, statusCode int, content interface{})

+ XML func(statusCode int, content interface{})

+ func NewWrappedResponseWriter(w http.ResponseWriter) WrappedResponseWriter

v8.0.0-alpha4

Mar 9, 2021

v8.0.0-alpha3

Mar 9, 2021

v8.0.0-alpha2

Mar 9, 2021

Other modules containing this package

github.com/Travix-International/go-servicefoundation