Documentation ¶
Index ¶
- func EncodeLivenessResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
- func EncodeReadinessResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
- func LivenessHealthPath() string
- func Mount(mux goahttp.Muxer, h *Server)
- func MountLivenessHandler(mux goahttp.Muxer, h http.Handler)
- func MountReadinessHandler(mux goahttp.Muxer, h http.Handler)
- func NewLivenessHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
- func NewReadinessHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
- func ReadinessHealthPath() string
- type LivenessResponseBody
- type MountPoint
- type ReadinessResponseBody
- type Server
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EncodeLivenessResponse ¶
func EncodeLivenessResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
EncodeLivenessResponse returns an encoder for responses returned by the health Liveness endpoint.
func EncodeReadinessResponse ¶
func EncodeReadinessResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error
EncodeReadinessResponse returns an encoder for responses returned by the health Readiness endpoint.
func LivenessHealthPath ¶
func LivenessHealthPath() string
LivenessHealthPath returns the URL path to the health service Liveness HTTP endpoint.
func MountLivenessHandler ¶
MountLivenessHandler configures the mux to serve the "health" service "Liveness" endpoint.
func MountReadinessHandler ¶
MountReadinessHandler configures the mux to serve the "health" service "Readiness" endpoint.
func NewLivenessHandler ¶
func NewLivenessHandler( endpoint goa.Endpoint, mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder, encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, errhandler func(context.Context, http.ResponseWriter, error), formatter func(ctx context.Context, err error) goahttp.Statuser, ) http.Handler
NewLivenessHandler creates a HTTP handler which loads the HTTP request and calls the "health" service "Liveness" endpoint.
func NewReadinessHandler ¶
func NewReadinessHandler( endpoint goa.Endpoint, mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder, encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, errhandler func(context.Context, http.ResponseWriter, error), formatter func(ctx context.Context, err error) goahttp.Statuser, ) http.Handler
NewReadinessHandler creates a HTTP handler which loads the HTTP request and calls the "health" service "Readiness" endpoint.
func ReadinessHealthPath ¶
func ReadinessHealthPath() string
ReadinessHealthPath returns the URL path to the health service Readiness HTTP endpoint.
Types ¶
type LivenessResponseBody ¶
type LivenessResponseBody struct { // Service name. Service string `form:"service" json:"service" xml:"service"` // Status message. Status string `form:"status" json:"status" xml:"status"` // Service runtime version. Version string `form:"version" json:"version" xml:"version"` }
LivenessResponseBody is the type of the "health" service "Liveness" endpoint HTTP response body.
func NewLivenessResponseBody ¶
func NewLivenessResponseBody(res *health.HealthResponse) *LivenessResponseBody
NewLivenessResponseBody builds the HTTP response body from the result of the "Liveness" endpoint of the "health" service.
type MountPoint ¶
type MountPoint struct { // Method is the name of the service method served by the mounted HTTP handler. Method string // Verb is the HTTP method used to match requests to the mounted handler. Verb string // Pattern is the HTTP request path pattern used to match requests to the // mounted handler. Pattern string }
MountPoint holds information about the mounted endpoints.
type ReadinessResponseBody ¶
type ReadinessResponseBody struct { // Service name. Service string `form:"service" json:"service" xml:"service"` // Status message. Status string `form:"status" json:"status" xml:"status"` // Service runtime version. Version string `form:"version" json:"version" xml:"version"` }
ReadinessResponseBody is the type of the "health" service "Readiness" endpoint HTTP response body.
func NewReadinessResponseBody ¶
func NewReadinessResponseBody(res *health.HealthResponse) *ReadinessResponseBody
NewReadinessResponseBody builds the HTTP response body from the result of the "Readiness" endpoint of the "health" service.
type Server ¶
type Server struct { Mounts []*MountPoint Liveness http.Handler Readiness http.Handler }
Server lists the health service endpoint HTTP handlers.
func New ¶
func New( e *health.Endpoints, mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder, encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, errhandler func(context.Context, http.ResponseWriter, error), formatter func(ctx context.Context, err error) goahttp.Statuser, ) *Server
New instantiates HTTP handlers for all the health service endpoints using the provided encoder and decoder. The handlers are mounted on the given mux using the HTTP verb and path defined in the design. errhandler is called whenever a response fails to be encoded. formatter is used to format errors returned by the service methods prior to encoding. Both errhandler and formatter are optional and can be nil.
func (*Server) MethodNames ¶
MethodNames returns the methods served.