strategy

Documentation

Overview

Package strategy provides basic interfaces for routing to available plugins and caching metric data.

Index

• Variables
• func NewCache(expiration time.Duration) *cache
• func NewConfigBased(cacheTTL time.Duration) *configBased
• func NewLRU(cacheTTL time.Duration) *lru
• func NewSticky(cacheTTL time.Duration) *sticky
• type AvailablePlugin
• type MapAvailablePlugin
  • func (sm MapAvailablePlugin) Values() []AvailablePlugin
• type Pool
  • func NewPool(key string, plugins ...AvailablePlugin) (Pool, error)
• type RoutingAndCaching
• type SubscriptionType

Variables

var (
	ErrBadType     = errors.New("bad plugin type")
	ErrBadStrategy = errors.New("bad strategy")
	ErrPoolEmpty   = errors.New("plugin pool is empty")
)

var (
	ErrCacheDoesNotExist = errors.New("cache does not exist")
)

var (
	ErrCacheEntryDoesNotExist = errors.New("cache entry does not exist")
)

var (
	ErrCouldNotSelect = errors.New("could not select a plugin")
)

var GlobalCacheExpiration time.Duration

GlobalCacheExpiration the default time limit for which a cache entry is valid. A plugin can override the GlobalCacheExpiration (default).

var (
	// This defines the maximum running instances of a loaded plugin.
	// It is initialized at runtime via the cli.
	MaximumRunningPlugins = 3
)

Functions

func NewCache

func NewCache(expiration time.Duration) *cache

func NewConfigBased

func NewConfigBased(cacheTTL time.Duration) *configBased

func NewLRU

func NewLRU(cacheTTL time.Duration) *lru

func NewSticky

func NewSticky(cacheTTL time.Duration) *sticky

Types

type AvailablePlugin

type AvailablePlugin interface {
	core.AvailablePlugin
	CacheTTL() time.Duration
	CheckHealth()
	ConcurrencyCount() int
	Exclusive() bool
	Kill(r string) error
	RoutingStrategy() plugin.RoutingStrategyType
	SetID(id uint32)
	String() string
	Type() plugin.PluginType
}

type MapAvailablePlugin

type MapAvailablePlugin map[uint32]AvailablePlugin

func (MapAvailablePlugin) Values

func (sm MapAvailablePlugin) Values() []AvailablePlugin

Values returns slice of map values

type Pool

type Pool interface {
	RoutingAndCaching
	Count() int
	Eligible() bool
	Insert(a AvailablePlugin) error
	Kill(id uint32, reason string)
	MoveSubscriptions(to Pool) []subscription
	Plugins() MapAvailablePlugin
	RLock()
	RUnlock()
	SelectAndKill(taskID, reason string)
	SelectAP(taskID string, configID map[string]ctypes.ConfigValue) (AvailablePlugin, serror.SnapError)
	Strategy() RoutingAndCaching
	Subscribe(taskID string, subType SubscriptionType)
	SubscriptionCount() int
	Unsubscribe(taskID string)
	Version() int
	RestartCount() int
	IncRestartCount()
}

func NewPool

func NewPool(key string, plugins ...AvailablePlugin) (Pool, error)

type RoutingAndCaching

type RoutingAndCaching interface {
	Select(availablePlugins []AvailablePlugin, id string) (AvailablePlugin, error)
	Remove(availablePlugins []AvailablePlugin, id string) (AvailablePlugin, error)
	CheckCache(metrics []core.Metric, id string) ([]core.Metric, []core.Metric)
	UpdateCache(metrics []core.Metric, id string)
	CacheHits(ns string, ver int, id string) (uint64, error)
	CacheMisses(ns string, ver int, id string) (uint64, error)
	AllCacheHits() uint64
	AllCacheMisses() uint64
	CacheTTL(taskID string) (time.Duration, error)
	String() string
}

type SubscriptionType

type SubscriptionType int

const (
	// this subscription is bound to an explicit version
	BoundSubscriptionType SubscriptionType = iota
	// this subscription is akin to "latest" and must be moved if a newer version is loaded.
	UnboundSubscriptionType
)