app

Documentation

Index

• Variables
• func AddFlags(flagSet *flag.FlagSet)
• func NewRouter() *mux.Router
• func RegisterStaticHandler(r *mux.Router, logger *zap.Logger, qOpts *QueryOptions)
• type APIHandler
  • func NewAPIHandler(spanReader spanstore.Reader, dependencyReader dependencystore.Reader, ...) *APIHandler
  • func (aH *APIHandler) RegisterRoutes(router *mux.Router)
• type HTTPHandler
• type HandlerOption
• type QueryOptions
  • func (qOpts *QueryOptions) InitFromViper(v *viper.Viper) *QueryOptions
• type StaticAssetsHandler
  • func NewStaticAssetsHandler(staticAssetsRoot string, options StaticAssetsHandlerOptions) (*StaticAssetsHandler, error)
  • func (sH *StaticAssetsHandler) RegisterRoutes(router *mux.Router)
• type StaticAssetsHandlerOptions

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(),
	adjuster.SpanReferences(),
}

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

Functions

func AddFlags

func AddFlags(flagSet *flag.FlagSet)

AddFlags adds flags for QueryOptions

func NewRouter

func NewRouter() *mux.Router

NewRouter creates and configures a Gorilla Router.

func RegisterStaticHandler

func RegisterStaticHandler(r *mux.Router, logger *zap.Logger, qOpts *QueryOptions)

RegisterStaticHandler adds handler for static assets to the router.

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 QueryOptions

type QueryOptions struct {
	// Port is the port that the query service listens in on
	Port int
	// BasePath is the prefix for all UI and API HTTP routes
	BasePath string
	// StaticAssets is the path for the static assets for the UI (https://github.com/uber/jaeger-ui)
	StaticAssets string
	// UIConfig is the path to a configuration file for the UI
	UIConfig string
	// HealthCheckHTTPPort is the port that the health check service listens in on for http requests
	HealthCheckHTTPPort int
}

QueryOptions holds configuration for query service

func (*QueryOptions) InitFromViper

func (qOpts *QueryOptions) InitFromViper(v *viper.Viper) *QueryOptions

InitFromViper initializes QueryOptions with properties from viper

type StaticAssetsHandler

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

StaticAssetsHandler handles static assets

func NewStaticAssetsHandler

func NewStaticAssetsHandler(staticAssetsRoot string, options StaticAssetsHandlerOptions) (*StaticAssetsHandler, error)

NewStaticAssetsHandler returns a StaticAssetsHandler

func (*StaticAssetsHandler) RegisterRoutes

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

RegisterRoutes registers routes for this handler on the given router

type StaticAssetsHandlerOptions

type StaticAssetsHandlerOptions struct {
	BasePath     string
	UIConfigPath string
}

StaticAssetsHandlerOptions defines options for NewStaticAssetsHandler