docker

Documentation

Index

• Variables
• type Plugin
  • func (p *Plugin) Extract(req sdk.ExtractRequest, evt sdk.EventReader) error
  • func (p *Plugin) Fields() []sdk.FieldEntry
  • func (p *Plugin) Info() *plugins.Info
  • func (p *Plugin) Init(config string) error
  • func (p *Plugin) InitSchema() *sdk.SchemaInfo
  • func (Plugin *Plugin) Open(params string) (source.Instance, error)
  • func (p *Plugin) SetInfo(id uint32, name, description, contact, version, eventSource string)
  • func (Plugin *Plugin) String(in io.ReadSeeker) (string, error)
• type PluginConfig

Variables

var (
	ID          uint32
	Name        string
	Description string
	Contact     string
	Version     string
	EventSource string
)

Types

type Plugin

type Plugin struct {
	plugins.BasePlugin
	Config PluginConfig
	// contains filtered or unexported fields
}

Plugin represents our plugin

func (*Plugin) Extract

func (p *Plugin) Extract(req sdk.ExtractRequest, evt sdk.EventReader) error

Extract allows Falco plugin framework to get values for all available fields

func (*Plugin) Fields

func (p *Plugin) Fields() []sdk.FieldEntry

Fields exposes to Falco plugin framework all availables fields for this plugin

func (*Plugin) Info

func (p *Plugin) Info() *plugins.Info

Info displays information of the plugin to Falco plugin framework

func (*Plugin) Init

func (p *Plugin) Init(config string) error

Init is called by the Falco plugin framework as first entry, we use it for setting default configuration values and mapping values from `init_config` (json format for this plugin)

func (*Plugin) InitSchema

func (p *Plugin) InitSchema() *sdk.SchemaInfo

InitSchema map the configuration values with Plugin structure through JSONSchema tags

func (*Plugin) Open

func (Plugin *Plugin) Open(params string) (source.Instance, error)

Open is called by Falco plugin framework for opening a stream of events, we call that an instance

func (*Plugin) SetInfo

func (p *Plugin) SetInfo(id uint32, name, description, contact, version, eventSource string)

SetInfo is used to set the Info of the plugin

func (*Plugin) String

func (Plugin *Plugin) String(in io.ReadSeeker) (string, error)

String represents the raw value of on event (not currently used by Falco plugin framework, only there for future usage)

type PluginConfig

type PluginConfig struct {
	FlushInterval uint64 `json:"flushInterval" jsonschema:"description=Flush Interval in ms (Default: 30)"`
}