infra

type Plugin ¶

type Plugin interface {
	// Init is called in the agent`s startup phase.
	Init() error
	// Close is called in the agent`s cleanup phase.
	Close() error
	// String returns unique name of the plugin.
	String() string
}

Plugin interface defines plugin's basic life-cycle methods.

type PluginDeps ¶

type PluginDeps struct {
	PluginName
	Log logging.PluginLogger
	Cfg config.PluginConfig
}

PluginDeps defines common dependencies for use with plugins. It can easily be embedded in Deps for Plugin:

type Deps struct {
    infra.PluginDeps
    // other dependencies
}

func (d *PluginDeps) Close() error

func (d *PluginDeps) Setup()

func (d *PluginDeps) SetupLog()

type PluginName ¶

type PluginName string

PluginName is a part of the plugin's API. It's used by embedding it into Plugin to provide unique name of the plugin.

func (name *PluginName) SetName(n string)

func (name PluginName) String() string

type PostInit ¶

type PostInit interface {
	// AfterInit is called once Init() of all plugins have returned without error.
	AfterInit() error
}

PostInit interface defines an optional method for plugins with additional initialization.