filterengine

package

v1.10.0 Latest Latest Go to latest Published: Apr 8, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kubeshop/botkube

Links

Open Source Insights

Documentation ¶

Index ¶

type DefaultFilterEngine
- func New(log logrus.FieldLogger) *DefaultFilterEngine
- func WithAllFilters(logger logrus.FieldLogger, dynamicCli dynamic.Interface, ...) *DefaultFilterEngine
type Filter
type FilterEngine
type RegisteredFilter

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DefaultFilterEngine ¶

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

DefaultFilterEngine is a default implementation of the Filter Engine.

func New ¶

func New(log logrus.FieldLogger) *DefaultFilterEngine

New creates new DefaultFilterEngine instance..

func WithAllFilters ¶

func WithAllFilters(logger logrus.FieldLogger, dynamicCli dynamic.Interface, mapper meta.RESTMapper, cfg *config.Filters) *DefaultFilterEngine

WithAllFilters returns new DefaultFilterEngine instance with all filters registered.

func (*DefaultFilterEngine) Register ¶

func (f *DefaultFilterEngine) Register(filters ...RegisteredFilter)

Register filter(s) to engine.

func (*DefaultFilterEngine) RegisteredFilters ¶

func (f *DefaultFilterEngine) RegisteredFilters() []RegisteredFilter

RegisteredFilters returns sorted slice of registered filters.

func (*DefaultFilterEngine) Run ¶

func (f *DefaultFilterEngine) Run(ctx context.Context, event event.Event) event.Event

Run runs the registered filters always iterating over a slice of filters with sorted keys.

func (*DefaultFilterEngine) SetFilter ¶

func (f *DefaultFilterEngine) SetFilter(name string, flag bool) error

SetFilter sets filter value in FilterMap to enable or disable filter.

type Filter ¶

type Filter interface {
	Run(context.Context, *event.Event) error
	Name() string
	Describe() string
}

Filter defines an event filter.

type FilterEngine ¶

type FilterEngine interface {
	Run(context.Context, event.Event) event.Event
	Register(...RegisteredFilter)
	RegisteredFilters() []RegisteredFilter
	SetFilter(string, bool) error
}

FilterEngine has methods to register and run filters.

type RegisteredFilter ¶

type RegisteredFilter struct {
	Enabled bool
	Filter
}

RegisteredFilter contains details about registered filter.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
filters

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL