strategy

package
Version: v0.16.1-beta Latest Latest
Warning

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

Go to latest
Published: Sep 16, 2016 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrBadType     = errors.New("bad plugin type")
	ErrBadStrategy = errors.New("bad strategy")
	ErrPoolEmpty   = errors.New("plugin pool is empty")
)
View Source
var (
	ErrCacheDoesNotExist = errors.New("cache does not exist")
)
View Source
var (
	ErrCacheEntryDoesNotExist = errors.New("cache entry does not exist")
)
View Source
var (
	ErrCouldNotSelect = errors.New("could not select a plugin")
)
View Source
var GlobalCacheExpiration time.Duration

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

View Source
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
	Stop(string) error
}

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)
	Plugins() MapAvailablePlugin
	RLock()
	RUnlock()
	SelectAndKill(taskID, reason string)
	SelectAP(taskID string, configID map[string]ctypes.ConfigValue) (AvailablePlugin, serror.SnapError)
	Strategy() RoutingAndCaching
	Subscribe(taskID string)
	SubscriptionCount() int
	Unsubscribe(taskID string)
	Version() int
	RestartCount() int
	IncRestartCount()
	KillAll(string)
}

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
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL