Documentation
¶
Index ¶
- Variables
- func AddFlags(flagSet *flag.FlagSet)
- func NewRouter() *mux.Router
- func RegisterStaticHandler(r *mux.Router, logger *zap.Logger, qOpts *QueryOptions, ...) io.Closer
- type APIHandler
- type 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, _ *api_v2.GetServicesRequest) (*api_v2.GetServicesResponse, error)
- func (g *GRPCHandler) GetTrace(r *api_v2.GetTraceRequest, stream api_v2.QueryService_GetTraceServer) error
- type GRPCHandlerOptions
- type HTTPHandler
- type HandlerOption
- type InitArchiveStorageFn
- type QueryOptions
- type Server
- type StaticAssetsHandler
- type StaticAssetsHandlerOptions
- type UIConfig
Constants ¶
This section is empty.
Variables ¶
var HandlerOptions handlerOptions
HandlerOptions is a factory for all available HandlerOptions
Functions ¶
func RegisterStaticHandler ¶ added in v1.3.0
func RegisterStaticHandler(r *mux.Router, logger *zap.Logger, qOpts *QueryOptions, qCapabilities querysvc.StorageCapabilities) io.Closer
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, options GRPCHandlerOptions, ) *GRPCHandler
NewGRPCHandler returns a GRPCHandler.
func (*GRPCHandler) ArchiveTrace ¶ added in v1.12.0
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 ¶ added in v1.12.0
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 ¶ added in v1.12.0
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 ¶ added in v1.12.0
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 ¶ added in v1.12.0
func (g *GRPCHandler) GetServices(ctx context.Context, _ *api_v2.GetServicesRequest) (*api_v2.GetServicesResponse, error)
GetServices is the gRPC handler to fetch services.
func (*GRPCHandler) GetTrace ¶ added in v1.12.0
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 GRPCHandlerOptions ¶ added in v1.44.0
type GRPCHandlerOptions struct {
Logger *zap.Logger
Tracer *jtracer.JTracer
NowFn func() time.Time
}
GRPCHandlerOptions contains optional members of GRPCHandler.
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 InitArchiveStorageFn ¶ added in v1.66.0
type InitArchiveStorageFn func() (*storage.ArchiveStorage, error)
type QueryOptions ¶ added in v1.2.0
type QueryOptions struct {
// BasePath is the base path for all HTTP routes.
BasePath string `mapstructure:"base_path"`
// UIConfig contains configuration related to the Jaeger UIConfig.
UIConfig UIConfig `mapstructure:"ui"`
// BearerTokenPropagation activate/deactivate bearer token propagation to storage.
BearerTokenPropagation bool `mapstructure:"bearer_token_propagation"`
// Tenancy holds the multi-tenancy configuration.
Tenancy tenancy.Options `mapstructure:"multi_tenancy"`
// MaxClockSkewAdjust is the maximum duration by which jaeger-query will adjust a span.
MaxClockSkewAdjust time.Duration `mapstructure:"max_clock_skew_adjust" valid:"optional"`
// EnableTracing determines whether traces will be emitted by jaeger-query.
EnableTracing bool `mapstructure:"enable_tracing"`
// HTTP holds the HTTP configuration that the query service uses to serve requests.
HTTP confighttp.ServerConfig `mapstructure:"http"`
// GRPC holds the GRPC configuration that the query service uses to serve requests.
GRPC configgrpc.ServerConfig `mapstructure:"grpc"`
}
QueryOptions holds configuration for query service shared with jaeger-v2
func DefaultQueryOptions ¶ added in v1.63.0
func DefaultQueryOptions() QueryOptions
func (*QueryOptions) BuildQueryServiceOptions ¶ added in v1.18.0
func (qOpts *QueryOptions) BuildQueryServiceOptions( initArchiveStorageFn InitArchiveStorageFn, logger *zap.Logger, ) (*querysvc.QueryServiceOptions, *v2querysvc.QueryServiceOptions)
BuildQueryServiceOptions creates a QueryServiceOptions struct with appropriate adjusters and archive config
func (*QueryOptions) InitFromViper ¶ added in v1.2.0
func (qOpts *QueryOptions) InitFromViper(v *viper.Viper, logger *zap.Logger) (*QueryOptions, error)
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( ctx context.Context, querySvc *querysvc.QueryService, v2QuerySvc *v2querysvc.QueryService, metricsQuerySvc querysvc.MetricsQueryService, options *QueryOptions, tm *tenancy.Manager, telset telemetry.Settings, ) (*Server, error)
NewServer creates and initializes Server
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) Close ¶ added in v1.56.0
func (sH *StaticAssetsHandler) Close() error
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 {
UIConfig
BasePath string
StorageCapabilities querysvc.StorageCapabilities
Logger *zap.Logger
}
StaticAssetsHandlerOptions defines options for NewStaticAssetsHandler
type UIConfig ¶ added in v1.62.0
type UIConfig struct {
// ConfigFile is the path to a configuration file for the UI.
ConfigFile string `mapstructure:"config_file" valid:"optional"`
// AssetsPath is the path for the static assets for the UI (https://github.com/uber/jaeger-ui).
AssetsPath string `mapstructure:"assets_path" valid:"optional" `
// LogAccess tells static handler to log access to static assets, useful in debugging.
LogAccess bool `mapstructure:"log_access" valid:"optional"`
}
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
internal/adjuster
Package adjuster contains various adjusters for model.Trace.
|
Package adjuster contains various adjusters for model.Trace. |
|
Package ui bundles UI assets packaged with stdlib/embed.
|
Package ui bundles UI assets packaged with stdlib/embed. |