flowcontrol

Documentation

Index

• Variables
• func CacheModule() fx.Option
• func EngineModule() fx.Option
• func Module() fx.Option
• func NewCache(dc *distcache.DistCache, lc fx.Lifecycle) (iface.Cache, error)
• func NewEngine(agentInfo *agentinfo.AgentInfo) iface.Engine
• func ProvideEngine(cache iface.Cache, agentInfo *agentinfo.AgentInfo) iface.Engine
• type Cache
  • func (c *Cache) Delete(ctx context.Context, controlPoint, key string) error
  • func (c *Cache) Get(ctx context.Context, controlPoint, key string) ([]byte, error)
  • func (c *Cache) Ready() error
  • func (c *Cache) Upsert(ctx context.Context, controlPoint, key string, value []byte, ttl time.Duration) error
• type Engine
  • func (e *Engine) GetAgentInfo() *agentinfo.AgentInfo
  • func (e *Engine) GetFluxMeter(fluxMeterName string) iface.FluxMeter
  • func (e *Engine) GetRateLimiter(limiterID iface.LimiterID) iface.RateLimiter
  • func (e *Engine) GetSampler(limiterID iface.LimiterID) iface.Limiter
  • func (e *Engine) GetScheduler(limiterID iface.LimiterID) iface.Scheduler
  • func (e *Engine) ProcessRequest(ctx context.Context, requestContext iface.RequestContext) (response *flowcontrolv1.CheckResponse)
  • func (e *Engine) RegisterCache(cache iface.Cache)
  • func (e *Engine) RegisterFluxMeter(fm iface.FluxMeter) error
  • func (e *Engine) RegisterLabelPreview(lp iface.LabelPreview) error
  • func (e *Engine) RegisterRateLimiter(rl iface.RateLimiter) error
  • func (e *Engine) RegisterSampler(l iface.Limiter) error
  • func (e *Engine) RegisterScheduler(cl iface.Scheduler) error
  • func (e *Engine) UnregisterFluxMeter(fm iface.FluxMeter) error
  • func (e *Engine) UnregisterLabelPreview(lp iface.LabelPreview) error
  • func (e *Engine) UnregisterRateLimiter(rl iface.RateLimiter) error
  • func (e *Engine) UnregisterSampler(rl iface.Limiter) error
  • func (e *Engine) UnregisterScheduler(cl iface.Scheduler) error

Variables

var (
	// ErrCacheKeyEmpty is the error returned when the cache key is empty.
	ErrCacheKeyEmpty = errors.New("cache key cannot be empty")
	// ErrCacheControlPointEmpty is the error returned when the cache control point is empty.
	ErrCacheControlPointEmpty = errors.New("cache control_point cannot be empty")
	// ErrCacheNotReady is the error returned when the cache is not ready to be used.
	ErrCacheNotReady = errors.New("cache is not ready")
	// ErrCacheKeyNotFound is the error returned when the key is not found in the cache. This is copied from the internal olric package.
	ErrCacheKeyNotFound = errors.New("key not found")
)

var CacheFxTag = config.NameTag("cache")

CacheFxTag is the Fx tag for cache's dmap.

Functions

func CacheModule

func CacheModule() fx.Option

CacheModule returns the fx options for the cache.

func EngineModule

func EngineModule() fx.Option

EngineModule returns the fx options for the engine.

func Module

func Module() fx.Option

Module returns the fx options for dataplane side pieces of policy.

func NewCache

func NewCache(dc *distcache.DistCache, lc fx.Lifecycle) (iface.Cache, error)

NewCache creates a new cache.

func NewEngine

func NewEngine(agentInfo *agentinfo.AgentInfo) iface.Engine

NewEngine Main fx app.

func ProvideEngine

func ProvideEngine(cache iface.Cache, agentInfo *agentinfo.AgentInfo) iface.Engine

ProvideEngine provides the engine for the dataplane side of policy.

Types

type Cache

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

Cache for saving responses at flow end.

func (*Cache) Delete

func (c *Cache) Delete(ctx context.Context, controlPoint, key string) error

Delete deletes the value for the given key.

func (*Cache) Get

func (c *Cache) Get(ctx context.Context, controlPoint, key string) ([]byte, error)

Get returns the value for the given key.

func (*Cache) Ready

func (c *Cache) Ready() error

Ready returns nil if the cache is ready to be used.

func (*Cache) Upsert

func (c *Cache) Upsert(ctx context.Context, controlPoint, key string, value []byte, ttl time.Duration) error

Upsert inserts or updates the value for the given key.

type Engine

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

Engine APIs to (1) Get schedulers given a service, control point and set of labels. (2) Get flux meter histogram given a metric id.

func (*Engine) GetAgentInfo

func (e *Engine) GetAgentInfo() *agentinfo.AgentInfo

GetAgentInfo returns the agent info.

func (*Engine) GetFluxMeter

func (e *Engine) GetFluxMeter(fluxMeterName string) iface.FluxMeter

GetFluxMeter Lookup function for getting flux meter.

func (*Engine) GetRateLimiter

func (e *Engine) GetRateLimiter(limiterID iface.LimiterID) iface.RateLimiter

GetRateLimiter Lookup function for getting rate limiter.

func (*Engine) GetSampler

func (e *Engine) GetSampler(limiterID iface.LimiterID) iface.Limiter

GetSampler Lookup function for getting sampler.

func (*Engine) GetScheduler

func (e *Engine) GetScheduler(limiterID iface.LimiterID) iface.Scheduler

GetScheduler Lookup function for getting scheduler.

func (*Engine) ProcessRequest

func (e *Engine) ProcessRequest(ctx context.Context, requestContext iface.RequestContext) (response *flowcontrolv1.CheckResponse)

ProcessRequest .

func (*Engine) RegisterCache

func (e *Engine) RegisterCache(cache iface.Cache)

RegisterCache .

func (*Engine) RegisterFluxMeter

func (e *Engine) RegisterFluxMeter(fm iface.FluxMeter) error

RegisterFluxMeter adds fluxmeter to histogram map and multimatcher.

func (*Engine) RegisterLabelPreview

func (e *Engine) RegisterLabelPreview(lp iface.LabelPreview) error

RegisterLabelPreview adds label preview to multimatcher.

func (*Engine) RegisterRateLimiter

func (e *Engine) RegisterRateLimiter(rl iface.RateLimiter) error

RegisterRateLimiter adds limiter actuator to multimatcher.

func (*Engine) RegisterSampler

func (e *Engine) RegisterSampler(l iface.Limiter) error

RegisterSampler adds limiter actuator to multimatcher.

func (*Engine) RegisterScheduler

func (e *Engine) RegisterScheduler(cl iface.Scheduler) error

RegisterScheduler adds scheduler to multimatcher.

func (*Engine) UnregisterFluxMeter

func (e *Engine) UnregisterFluxMeter(fm iface.FluxMeter) error

UnregisterFluxMeter removes fluxmeter from histogram map and multimatcher.

func (*Engine) UnregisterLabelPreview

func (e *Engine) UnregisterLabelPreview(lp iface.LabelPreview) error

UnregisterLabelPreview removes label preview from multimatcher.

func (*Engine) UnregisterRateLimiter

func (e *Engine) UnregisterRateLimiter(rl iface.RateLimiter) error

UnregisterRateLimiter removes limiter actuator from multimatcher.

func (*Engine) UnregisterSampler

func (e *Engine) UnregisterSampler(rl iface.Limiter) error

UnregisterSampler removes limiter actuator from multimatcher.

func (*Engine) UnregisterScheduler

func (e *Engine) UnregisterScheduler(cl iface.Scheduler) error

UnregisterScheduler removes scheduler from multimatcher.