censor

Documentation

Index

• Variables
• func Module() fx.Option
• type Config
  • func (c Config) Validate() error
• type ExecutionStrategy
  • func (s ExecutionStrategy) IsValid() bool
• type Metrics
  • func NewMetrics() *Metrics
  • func (m *Metrics) RecordEvaluation(pluginName string, action plugin.Action, duration time.Duration, err error)
  • func (m *Metrics) RecordTotalEvaluation(result plugin.Result)
• type PluginConfig
• type Service
  • func New(plugins []plugin.Plugin, config Config, metrics *Metrics, logger *zap.Logger) *Service
  • func (s *Service) Cleanup(ctx context.Context)
  • func (s *Service) Evaluate(ctx context.Context, msg plugin.Message) plugin.Result
  • func (s *Service) GetPlugins() []plugin.Plugin
  • func (s *Service) Register(p plugin.Plugin) error

Variables

var (
	ErrAlreadyExists   = errors.New("plugin already exists")
	ErrInvalidConfig   = errors.New("invalid config")
	ErrInvalidStrategy = errors.New("invalid strategy")
	ErrPluginError     = errors.New("plugin error")
	ErrTimeout         = errors.New("timeout")
)

Functions

func Module

func Module() fx.Option

Types

type Config

type Config struct {
	Strategy    ExecutionStrategy
	Timeout     time.Duration
	Plugins     map[string]PluginConfig
	EnabledOnly bool

	ErrorAction plugin.Action
	SkipAction  plugin.Action
}

Config for the plugin manager.

func (Config) Validate

func (c Config) Validate() error

Validate checks if the configuration is valid.

type ExecutionStrategy

type ExecutionStrategy string

ExecutionStrategy determines how plugins are executed.

const (
	StrategySequential ExecutionStrategy = "sequential" // execute plugins in priority order, Allow takes precedence over Block
	StrategyParallel   ExecutionStrategy = "parallel"   // execute all plugins concurrently, aggregate results
)

func (ExecutionStrategy) IsValid

func (s ExecutionStrategy) IsValid() bool

type Metrics

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

func NewMetrics

func NewMetrics() *Metrics

func (*Metrics) RecordEvaluation

func (m *Metrics) RecordEvaluation(pluginName string, action plugin.Action, duration time.Duration, err error)

RecordEvaluation records metrics for a plugin evaluation.

func (*Metrics) RecordTotalEvaluation

func (m *Metrics) RecordTotalEvaluation(result plugin.Result)

RecordTotalEvaluation records the final result of message evaluation.

type PluginConfig

type PluginConfig struct {
	Enabled  bool
	Priority int
	Config   map[string]any
}

PluginConfig for individual plugin configuration.

type Service

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

Service orchestrates plugin execution.

func New

func New(plugins []plugin.Plugin, config Config, metrics *Metrics, logger *zap.Logger) *Service

New creates a new plugin manager.

func (*Service) Cleanup

func (s *Service) Cleanup(ctx context.Context)

func (*Service) Evaluate

func (s *Service) Evaluate(ctx context.Context, msg plugin.Message) plugin.Result

Evaluate runs plugins according to the configured strategy.

func (*Service) GetPlugins

func (s *Service) GetPlugins() []plugin.Plugin

GetPlugins returns a copy of the current plugins list (sorted by priority).

func (*Service) Register

func (s *Service) Register(p plugin.Plugin) error

Register adds a plugin to the manager.