plugin

package module

v1.2.0 Latest Latest Go to latest Published: Jul 15, 2019 License: Apache-2.0 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

This section is empty.

This section is empty.

This section is empty.

type Executor struct {
	Plugins       []Plugin
	ElasticClient *elastic.Client
}

Executor for controlling Plugin instances

func (executor *Executor) BuildPlugins(configuration config.Configuration, pluginConfig config.PluginConfig, newPlugin factoryMethodType)

BuildPlugins creates the plugin instances

func (executor *Executor) RunPlugins(freq time.Duration)

RunPlugins runs all Plugins in a loop

type Plugin interface {
	BuildMetrics([]config.Query) []prometheus.Collector
	Perform(*elastic.Client)
}

Plugin can be implemented to extend ELCEPs functionality. see BUILD-CUSTOM-MONITOR.md for details

type Provider struct {
	Plugins map[string]factoryMethodType
}

Provider loads the plugin files and scans for available plugins

func NewPluginProvider(pluginFolder string) *Provider

NewPluginProvider returns an instance with loaded Plugins from plugin Files

func (provider *Provider) GetPluginNames() []string

GetPluginNames returns a list of logical plugin names

Path	Synopsis
mock_plugin Package mock_plugin is a generated GoMock package.	Package mock_plugin is a generated GoMock package.