plugins

Documentation

Index

• Variables
• func Add(name string, registry PluginRegistry)
• func ReadPluginConfig(plugin string) ([]byte, error)
• func UmarshalPluginConfig(plugin string) (interface{}, error)
• type ConfiguredPlugin
• type Plugin
• type PluginConfig
  • func GetAllEnabledPlugins() ([]PluginConfig, error)
  • func GetConfigPath(plugin string) (PluginConfig, error)
• type PluginRegistry

Variables

var PluginConfigPath = path.Join(settings.ConfigPath, "plugins-enabled")

PluginConfigPath - XXX

var Plugins = map[string]PluginRegistry{}

Plugins - XXX

Functions

func Add

func Add(name string, registry PluginRegistry)

Add - XXX

func ReadPluginConfig

func ReadPluginConfig(plugin string) ([]byte, error)

ReadPluginConfig - Reads the file from the expected path and returns it as bytes

func UmarshalPluginConfig

func UmarshalPluginConfig(plugin string) (interface{}, error)

UmarshalPluginConfig - Converts bytes to interface

Types

type ConfiguredPlugin

type ConfiguredPlugin struct {
	Name   string
	Plugin Plugin
}

ConfiguredPlugin - XXX

type Plugin

type Plugin interface {

	// Description returns a one-sentence description on the Plugin
	Description() string

	SampleConfig() string

	// Collects all the metrics and returns a struct with the results
	Collect() (interface{}, error)

	// Start starts the service - Optional
	Start() error

	// Stop stops the services and closes any necessary channels and connections - Optional
	Stop()
}

Plugin - XXX

type PluginConfig

type PluginConfig struct {
	Path string
	Name string
}

PluginConfig - XXX

func GetAllEnabledPlugins

func GetAllEnabledPlugins() ([]PluginConfig, error)

GetAllEnabledPlugins - XXX

func GetConfigPath

func GetConfigPath(plugin string) (PluginConfig, error)

GetConfigPath - Simple function that generates the plugin config path for the current distro

type PluginRegistry

type PluginRegistry func() Plugin

PluginRegistry - XXX