Help us shape the future of Go! Take the 2026 Go Developer Survey

app

package
v1.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 24, 2020 License: Apache-2.0 Imports: 40 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (

	// ErrServiceParameterRequired occurs when no service name is defined
	ErrServiceParameterRequired = fmt.Errorf("parameter '%s' is required", serviceParam)
)
View Source
var HandlerOptions handlerOptions

HandlerOptions is a factory for all available HandlerOptions

Functions

func AddFlags added in v1.2.0

func AddFlags(flagSet *flag.FlagSet)

AddFlags adds flags for QueryOptions

func NewRouter added in v1.4.0

func NewRouter() *mux.Router

NewRouter creates and configures a Gorilla Router.

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(queryService *querysvc.QueryService, 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 GRPCHandler added in v1.12.0

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

GRPCHandler implements the GRPC endpoint of the query service.

func NewGRPCHandler added in v1.12.0

func NewGRPCHandler(queryService *querysvc.QueryService, logger *zap.Logger, tracer opentracing.Tracer) *GRPCHandler

NewGRPCHandler returns a GRPCHandler

func (*GRPCHandler) ArchiveTrace added in v1.12.0

ArchiveTrace is the GRPC handler to archive traces.

func (*GRPCHandler) FindTraces added in v1.12.0

FindTraces is the GRPC handler to fetch traces based on TraceQueryParameters.

func (*GRPCHandler) GetDependencies added in v1.12.0

GetDependencies is the GRPC handler to fetch dependencies.

func (*GRPCHandler) GetOperations added in v1.12.0

GetOperations is the GRPC handler to fetch operations.

func (*GRPCHandler) GetServices added in v1.12.0

GetServices is the GRPC handler to fetch services.

func (*GRPCHandler) GetTrace added in v1.12.0

GetTrace is the GRPC handler to fetch traces based on trace-id.

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 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
	// BearerTokenPropagation activate/deactivate bearer token propagation to storage
	BearerTokenPropagation bool
	// AdditionalHeaders
	AdditionalHeaders http.Header
}

QueryOptions holds configuration for query service

func (*QueryOptions) InitFromViper added in v1.2.0

func (qOpts *QueryOptions) InitFromViper(v *viper.Viper, logger *zap.Logger) *QueryOptions

InitFromViper initializes QueryOptions with properties from viper

type Server added in v1.12.0

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

Server runs HTTP, Mux and a grpc server

func NewServer added in v1.12.0

func NewServer(svc *flags.Service, querySvc *querysvc.QueryService, options *QueryOptions, tracer opentracing.Tracer) *Server

NewServer creates and initializes Server

func (*Server) Close added in v1.12.0

func (s *Server) Close()

Close stops http, GRPC servers and closes the port listener.

func (*Server) Start added in v1.12.0

func (s *Server) Start() error

Start http, GRPC and cmux servers concurrently

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

type StaticAssetsHandlerOptions struct {
	BasePath     string
	UIConfigPath string
	Logger       *zap.Logger
}

StaticAssetsHandlerOptions defines options for NewStaticAssetsHandler

Directories

Path Synopsis
ui
Package ui installs UI assets packaged with github.com/rakyll/statik.
Package ui installs UI assets packaged with github.com/rakyll/statik.
actual
Package assets contains auto-generated UI asset files created during the build.
Package assets contains auto-generated UI asset files created during the build.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL