Documentation
¶
Index ¶
Constants ¶
const (
// QueryDefaultHealthCheckHTTPPort is the default HTTP Port for health check
QueryDefaultHealthCheckHTTPPort = 16687
)
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 RegisterStaticHandler ¶ added in v1.3.0
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 ¶
HTTPHandler handles http requests
type HandlerOption ¶
type HandlerOption func(handler *APIHandler)
HandlerOption is a function that sets some option on the APIHandler
type QueryOptions ¶ added in v1.2.0
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
}
QueryOptions holds configuration for query service
func (*QueryOptions) InitFromViper ¶ added in v1.2.0
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 ¶ added in v1.3.0
StaticAssetsHandlerOptions defines options for NewStaticAssetsHandler
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package ui installs UI assets packaged with github.com/rakyll/statik.
|
Package ui installs UI assets packaged with github.com/rakyll/statik. |