shared

Documentation

Index

• Constants
• Variables
• func NewGRPCClient(c *grpc.ClientConn) *grpcClient
• type ArchiveStoragePlugin
• type Capabilities
• type ContextUpgradeFunc
• type PluginCapabilities
• type PluginServices
• type StorageGRPCPlugin
  • func (*StorageGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (p *StorageGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
  • func (p *StorageGRPCPlugin) RegisterHandlers(s *grpc.Server) error
• type StoragePlugin
• type StreamingSpanWriterPlugin

Constants

const BearerTokenKey = "bearer.token"

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

const StoragePluginIdentifier = "storage_plugin"

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

Variables

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

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

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

PluginMap is the map of plugins we can dispense.

Functions

func NewGRPCClient

func NewGRPCClient(c *grpc.ClientConn) *grpcClient

Types

type ArchiveStoragePlugin

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

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

type Capabilities

type Capabilities struct {
	ArchiveSpanReader   bool
	ArchiveSpanWriter   bool
	StreamingSpanWriter bool
}

Capabilities contains information about plugin capabilities

type ContextUpgradeFunc

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

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

type PluginCapabilities

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

PluginCapabilities allow expose plugin its capabilities.

type PluginServices

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(ctx context.Context, broker *plugin.GRPCBroker, c *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(broker *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

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

type StreamingSpanWriterPlugin interface {
	StreamingSpanWriter() spanstore.Writer
}

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