api

Documentation

Index

• Constants
• func MetricsHandler(cfg MetricsConfig) func(next http.Handler) http.Handler
• func TraceEnhancer(next http.Handler) http.Handler
• type Handler
• type MetricsConfig

Constants

const MetricsEndpoint = "/metrics"

MetricsEndpoint endpoint subpath for metrics

const TenantHeaderKey = "tenant"

TenantHeaderKey in this header the right tenant should be inserted

const URLParamTenantID = "tntid"

URLParamTenantID url parameter for the tenant id

Functions

func MetricsHandler

func MetricsHandler(cfg MetricsConfig) func(next http.Handler) http.Handler

MetricsHandler creates a new directly usable handler

func TraceEnhancer

func TraceEnhancer(next http.Handler) http.Handler

TraceEnhancer is a middleware that will set the http method and url as operation-name of the top level span.

Types

type Handler

type Handler interface {
	// Routes get the routes
	Routes() (string, *chi.Mux)
}

Handler a http REST interface handler

type MetricsConfig

type MetricsConfig struct {
	// Skip particular requests from the handler
	SkipFunc func(r *http.Request) bool
}

MetricsConfig defining a handler for checking system id and api key