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(queryService *querysvc.QueryService, options ...HandlerOption) *APIHandler
  • func (aH *APIHandler) RegisterRoutes(router *mux.Router)
• type GRPCHandler
  • func NewGRPCHandler(queryService *querysvc.QueryService, logger *zap.Logger, ...) *GRPCHandler
  • func (g *GRPCHandler) ArchiveTrace(ctx context.Context, r *api_v2.ArchiveTraceRequest) (*api_v2.ArchiveTraceResponse, error)
  • func (g *GRPCHandler) FindTraces(r *api_v2.FindTracesRequest, stream api_v2.QueryService_FindTracesServer) error
  • func (g *GRPCHandler) GetDependencies(ctx context.Context, r *api_v2.GetDependenciesRequest) (*api_v2.GetDependenciesResponse, error)
  • func (g *GRPCHandler) GetOperations(ctx context.Context, r *api_v2.GetOperationsRequest) (*api_v2.GetOperationsResponse, error)
  • func (g *GRPCHandler) GetServices(ctx context.Context, r *api_v2.GetServicesRequest) (*api_v2.GetServicesResponse, error)
  • func (g *GRPCHandler) GetTrace(r *api_v2.GetTraceRequest, stream api_v2.QueryService_GetTraceServer) error
• type HTTPHandler
• type HandlerOption
• type QueryOptions
  • func (qOpts *QueryOptions) BuildQueryServiceOptions(storageFactory storage.Factory, logger *zap.Logger) *querysvc.QueryServiceOptions
  • func (qOpts *QueryOptions) InitFromViper(v *viper.Viper, logger *zap.Logger) *QueryOptions
• type Server
  • func NewServer(logger *zap.Logger, querySvc *querysvc.QueryService, options *QueryOptions, ...) (*Server, error)
  • func (s *Server) Close() error
  • func (s Server) HealthCheckStatus() chan healthcheck.Status
  • func (s *Server) Start() error
• 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

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(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

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

GRPCHandler implements the gRPC endpoint of the query service.

func NewGRPCHandler

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

NewGRPCHandler returns a GRPCHandler

func (*GRPCHandler) ArchiveTrace

func (g *GRPCHandler) ArchiveTrace(ctx context.Context, r *api_v2.ArchiveTraceRequest) (*api_v2.ArchiveTraceResponse, error)

ArchiveTrace is the gRPC handler to archive traces.

func (*GRPCHandler) FindTraces

func (g *GRPCHandler) FindTraces(r *api_v2.FindTracesRequest, stream api_v2.QueryService_FindTracesServer) error

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

func (*GRPCHandler) GetDependencies

func (g *GRPCHandler) GetDependencies(ctx context.Context, r *api_v2.GetDependenciesRequest) (*api_v2.GetDependenciesResponse, error)

GetDependencies is the gRPC handler to fetch dependencies.

func (*GRPCHandler) GetOperations

func (g *GRPCHandler) GetOperations(
	ctx context.Context,
	r *api_v2.GetOperationsRequest,
) (*api_v2.GetOperationsResponse, error)

GetOperations is the gRPC handler to fetch operations.

func (*GRPCHandler) GetServices

func (g *GRPCHandler) GetServices(ctx context.Context, r *api_v2.GetServicesRequest) (*api_v2.GetServicesResponse, error)

GetServices is the gRPC handler to fetch services.

func (*GRPCHandler) GetTrace

func (g *GRPCHandler) GetTrace(r *api_v2.GetTraceRequest, stream api_v2.QueryService_GetTraceServer) error

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

type QueryOptions struct {
	// HostPort is the host:port address that the query service listens o n
	HostPort string
	// 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
	// TLS configures secure transport
	TLS tlscfg.Options
	// AdditionalHeaders
	AdditionalHeaders http.Header
	// MaxClockSkewAdjust is the maximum duration by which jaeger-query will adjust a span
	MaxClockSkewAdjust time.Duration
}

QueryOptions holds configuration for query service

func (*QueryOptions) BuildQueryServiceOptions

func (qOpts *QueryOptions) BuildQueryServiceOptions(storageFactory storage.Factory, logger *zap.Logger) *querysvc.QueryServiceOptions

BuildQueryServiceOptions creates a QueryServiceOptions struct with appropriate adjusters and archive config

func (*QueryOptions) InitFromViper

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

InitFromViper initializes QueryOptions with properties from viper

type Server

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

Server runs HTTP, Mux and a grpc server

func NewServer

func NewServer(logger *zap.Logger, querySvc *querysvc.QueryService, options *QueryOptions, tracer opentracing.Tracer) (*Server, error)

NewServer creates and initializes Server

func (*Server) Close

func (s *Server) Close() error

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

func (Server) HealthCheckStatus

func (s Server) HealthCheckStatus() chan healthcheck.Status

HealthCheckStatus returns health check status channel a client can subscribe to

func (*Server) Start

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

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

StaticAssetsHandlerOptions defines options for NewStaticAssetsHandler