plugin

Documentation

Index

• type FunctionHook
• type FunctionSchema
• type Manager
  • func CreatePluginManager() *Manager
  • func LoadFunctions(path string) (*Manager, error)
  • func (pm *Manager) GetCustomFunctions() map[string]model.RuleFunction
  • func (pm *Manager) LoadedFunctionCount() int
  • func (pm *Manager) RegisterFunction(name string, ruleFunction model.RuleFunction)

Types

type FunctionHook

type FunctionHook func(nodes []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult

type FunctionSchema

type FunctionSchema func() model.RuleFunctionSchema

type Manager

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

func CreatePluginManager

func CreatePluginManager() *Manager

func LoadFunctions

func LoadFunctions(path string) (*Manager, error)

LoadFunctions will load custom functions found in the supplied path

func (*Manager) GetCustomFunctions

func (pm *Manager) GetCustomFunctions() map[string]model.RuleFunction

func (*Manager) LoadedFunctionCount

func (pm *Manager) LoadedFunctionCount() int

LoadedFunctionCount returns the number of available and ready to use functions.

func (*Manager) RegisterFunction

func (pm *Manager) RegisterFunction(name string, ruleFunction model.RuleFunction)

RegisterFunction allows a custom function to be hooked in