shared

package
v1.57.0 Latest Latest
Warning

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

 Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 17 Imported by: 48

Documentation

Index

Constants

View Source 
const BearerTokenKey = "bearer.token"

BearerTokenKey is the key name for the bearer token context value.

View Source 
const StoragePluginIdentifier = "storage_plugin"

StoragePluginIdentifier is the identifier that is shared by plugin and host.

Variables

View Source 
var Handshake = plugin.HandshakeConfig{
	MagicCookieKey:   "STORAGE_PLUGIN",
	MagicCookieValue: "jaeger",
}

Handshake is a common handshake that is shared by plugin and host.

View Source 
var PluginMap = map[string]plugin.Plugin{
	StoragePluginIdentifier: &StorageGRPCPlugin{},
}

PluginMap is the map of plugins we can dispense.

Functions

func NewGRPCClient added in v1.30.0 

func NewGRPCClient(c *grpc.ClientConn) *grpcClient

Types

type ArchiveStoragePlugin added in v1.20.0 

type ArchiveStoragePlugin interface {
	ArchiveSpanReader() spanstore.Reader
	ArchiveSpanWriter() spanstore.Writer
}

ArchiveStoragePlugin is the interface we're exposing as a plugin.

type Capabilities added in v1.20.0 

type Capabilities struct {
	ArchiveSpanReader   bool
	ArchiveSpanWriter   bool
	StreamingSpanWriter bool
}

Capabilities contains information about plugin capabilities

type ContextUpgradeFunc added in v1.23.0 

type ContextUpgradeFunc func(ctx context.Context) context.Context

ContextUpgradeFunc is a functional type that can be composed to upgrade context

type GRPCHandler added in v1.37.0 

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

GRPCHandler implements all methods of Remote Storage gRPC API.

func NewGRPCHandler added in v1.37.0 

func NewGRPCHandler(impl *GRPCHandlerStorageImpl) *GRPCHandler

NewGRPCHandler creates a handler given individual storage implementations.

func NewGRPCHandlerWithPlugins added in v1.37.0 

func NewGRPCHandlerWithPlugins(
	mainImpl StoragePlugin,
	archiveImpl ArchiveStoragePlugin,
	streamImpl StreamingSpanWriterPlugin,
) *GRPCHandler

NewGRPCHandler creates a handler given implementations grouped by plugin services.

func (*GRPCHandler) Capabilities added in v1.37.0 

func (s *GRPCHandler) Capabilities(ctx context.Context, request *storage_v1.CapabilitiesRequest) (*storage_v1.CapabilitiesResponse, error)

func (*GRPCHandler) Close added in v1.37.0 

func (s *GRPCHandler) Close(ctx context.Context, r *storage_v1.CloseWriterRequest) (*storage_v1.CloseWriterResponse, error)

func (*GRPCHandler) FindTraceIDs added in v1.37.0 

func (s *GRPCHandler) FindTraceIDs(ctx context.Context, r *storage_v1.FindTraceIDsRequest) (*storage_v1.FindTraceIDsResponse, error)

FindTraceIDs retrieves traceIDs that match the traceQuery

func (*GRPCHandler) FindTraces added in v1.37.0 

func (s *GRPCHandler) FindTraces(r *storage_v1.FindTracesRequest, stream storage_v1.SpanReaderPlugin_FindTracesServer) error

FindTraces streams traces that match the traceQuery

func (*GRPCHandler) GetArchiveTrace added in v1.37.0 

func (s *GRPCHandler) GetArchiveTrace(r *storage_v1.GetTraceRequest, stream storage_v1.ArchiveSpanReaderPlugin_GetArchiveTraceServer) error

func (*GRPCHandler) GetDependencies added in v1.37.0 

func (s *GRPCHandler) GetDependencies(ctx context.Context, r *storage_v1.GetDependenciesRequest) (*storage_v1.GetDependenciesResponse, error)

GetDependencies returns all interservice dependencies

func (*GRPCHandler) GetOperations added in v1.37.0 

func (s *GRPCHandler) GetOperations(
	ctx context.Context,
	r *storage_v1.GetOperationsRequest,
) (*storage_v1.GetOperationsResponse, error)

GetOperations returns the operations of a given service

func (*GRPCHandler) GetServices added in v1.37.0 

func (s *GRPCHandler) GetServices(ctx context.Context, r *storage_v1.GetServicesRequest) (*storage_v1.GetServicesResponse, error)

GetServices returns a list of all known services

func (*GRPCHandler) GetTrace added in v1.37.0 

func (s *GRPCHandler) GetTrace(r *storage_v1.GetTraceRequest, stream storage_v1.SpanReaderPlugin_GetTraceServer) error

GetTrace takes a traceID and streams a Trace associated with that traceID

func (*GRPCHandler) Register added in v1.37.0 

func (s *GRPCHandler) Register(ss *grpc.Server) error

Register registers the server as gRPC methods handler.

func (*GRPCHandler) WriteArchiveSpan added in v1.37.0 

func (s *GRPCHandler) WriteArchiveSpan(ctx context.Context, r *storage_v1.WriteSpanRequest) (*storage_v1.WriteSpanResponse, error)

func (*GRPCHandler) WriteSpan added in v1.37.0 

func (s *GRPCHandler) WriteSpan(ctx context.Context, r *storage_v1.WriteSpanRequest) (*storage_v1.WriteSpanResponse, error)

WriteSpan saves the span

func (*GRPCHandler) WriteSpanStream added in v1.37.0 

func (s *GRPCHandler) WriteSpanStream(stream storage_v1.StreamingSpanWriterPlugin_WriteSpanStreamServer) error

WriteSpanStream receive the span from stream and save it

type GRPCHandlerStorageImpl added in v1.37.0 

type GRPCHandlerStorageImpl struct {
	SpanReader       func() spanstore.Reader
	SpanWriter       func() spanstore.Writer
	DependencyReader func() dependencystore.Reader

	ArchiveSpanReader func() spanstore.Reader
	ArchiveSpanWriter func() spanstore.Writer

	StreamingSpanWriter func() spanstore.Writer
}

GRPCHandlerStorageImpl contains accessors for various storage implementations needed by the handler.

type PluginCapabilities added in v1.20.0 

type PluginCapabilities interface {
	Capabilities() (*Capabilities, error)
}

PluginCapabilities allow expose plugin its capabilities.

type PluginServices added in v1.20.0 

type PluginServices struct {
	Store               StoragePlugin
	ArchiveStore        ArchiveStoragePlugin
	StreamingSpanWriter StreamingSpanWriterPlugin
}

PluginServices defines services plugin can expose

type StorageGRPCPlugin 

type StorageGRPCPlugin struct {
	plugin.Plugin

	// Concrete implementation, This is only used for plugins that are written in Go.
	Impl        StoragePlugin
	ArchiveImpl ArchiveStoragePlugin
	StreamImpl  StreamingSpanWriterPlugin
}

StorageGRPCPlugin is the implementation of plugin.GRPCPlugin.

func (*StorageGRPCPlugin) GRPCClient 

func (*StorageGRPCPlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, conn *grpc.ClientConn) (interface{}, error)

GRPCClient implements plugin.GRPCPlugin. It is used by go-plugin to create a grpc plugin client.

func (*StorageGRPCPlugin) GRPCServer 

func (p *StorageGRPCPlugin) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error

GRPCServer implements plugin.GRPCPlugin. It is used by go-plugin to create a grpc plugin server.

func (*StorageGRPCPlugin) RegisterHandlers added in v1.30.0 

func (p *StorageGRPCPlugin) RegisterHandlers(s *grpc.Server) error

RegisterHandlers registers the plugin with the server

type StoragePlugin 

type StoragePlugin interface {
	SpanReader() spanstore.Reader
	SpanWriter() spanstore.Writer
	DependencyReader() dependencystore.Reader
}

StoragePlugin is the interface we're exposing as a plugin.

type StreamingSpanWriterPlugin added in v1.34.0 

type StreamingSpanWriterPlugin interface {
	StreamingSpanWriter() spanstore.Writer
}

StreamingSpanWriterPlugin is the interface we're exposing as a plugin.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.