app

Documentation

Index

• Variables
• type APIHandler
  • func NewAPIHandler(spanReader spanstore.Reader, dependencyReader dependencystore.Reader, ...) *APIHandler
  • func (aH *APIHandler) RegisterRoutes(router *mux.Router)
• type HTTPHandler
• type HandlerOption
• type StaticAssetsHandler
  • func NewStaticAssetsHandler(staticAssetsRoot string) *StaticAssetsHandler
  • func (sH *StaticAssetsHandler) RegisterRoutes(router *mux.Router)

Variables

var (

	// ErrServiceParameterRequired occurs when no service name is defined
	ErrServiceParameterRequired = fmt.Errorf("Parameter '%s' is required", serviceParam)
)

var HandlerOptions handlerOptions

HandlerOptions is a factory for all available HandlerOptions

var StandardAdjusters = []adjuster.Adjuster{
	adjuster.SpanIDDeduper(),
	adjuster.ClockSkew(),
	adjuster.IPTagAdjuster(),
	adjuster.SortLogFields(),
}

StandardAdjusters is a list of model adjusters applied by the query service before returning the data to the API clients.

Types

type APIHandler

type APIHandler struct {
	// contains filtered or unexported fields
}

APIHandler implements the query service public API by registering routes at httpPrefix

func NewAPIHandler

func NewAPIHandler(spanReader spanstore.Reader, dependencyReader dependencystore.Reader, options ...HandlerOption) *APIHandler

NewAPIHandler returns an APIHandler

func (*APIHandler) RegisterRoutes

func (aH *APIHandler) RegisterRoutes(router *mux.Router)

RegisterRoutes registers routes for this handler on the given router

type HTTPHandler

type HTTPHandler interface {
	RegisterRoutes(router *mux.Router)
}

HTTPHandler handles http requests

type HandlerOption

type HandlerOption func(handler *APIHandler)

HandlerOption is a function that sets some option on the APIHandler

type StaticAssetsHandler

type StaticAssetsHandler struct {
	// contains filtered or unexported fields
}

StaticAssetsHandler handles static assets

func NewStaticAssetsHandler

func NewStaticAssetsHandler(staticAssetsRoot string) *StaticAssetsHandler

NewStaticAssetsHandler returns a StaticAssetsHandler

func (*StaticAssetsHandler) RegisterRoutes

func (sH *StaticAssetsHandler) RegisterRoutes(router *mux.Router)

RegisterRoutes registers routes for this handler on the given router