handlers

Documentation

Index

• Constants
• func ErrorPage() http.Handler
• func Health() http.Handler
• func Metrics() http.Handler
• type HealthResponse

Constants

const (
	// FormatHeader name of the header used to extract the format
	FormatHeader = "X-Format"

	// CodeHeader name of the header used as source of the HTTP status code to return
	CodeHeader = "X-Code"

	// ContentType name of the header that defines the format of the reply
	ContentType = "Content-Type"

	// OriginalURI name of the header with the original URL from NGINX
	OriginalURI = "X-Original-URI"

	// Namespace name of the header that contains information about the Ingress namespace
	Namespace = "X-Namespace"

	// IngressName name of the header that contains the matched Ingress
	IngressName = "X-Ingress-Name"

	// ServiceName name of the header that contains the matched Service in the Ingress
	ServiceName = "X-Service-Name"

	// ServicePort name of the header that contains the matched Service port in the Ingress
	ServicePort = "X-Service-Port"

	// RequestID is a unique ID that identifies the request - same as for backend service
	RequestID = "X-Request-ID"

	// JSON content-type for json
	JSON = "application/json"

	// HTML content-type for html
	HTML = "text/html"
)

Functions

func ErrorPage

func ErrorPage() http.Handler

ErrorPage error handler

func Health

func Health() http.Handler

Health handler

func Metrics

func Metrics() http.Handler

Metrics handler

Types

type HealthResponse

type HealthResponse struct {
	Message string `json:"message"`
}

HealthResponse health response