backendplugin

Documentation

Overview

Package backendplugin contains backend plugin related logic.

Index

• Variables
• type Plugin
• type PluginFactoryFunc
• type Target

Variables

var (
	// ErrPluginNotRegistered error returned when plugin is not registered.
	ErrPluginNotRegistered = errors.New("plugin not registered")
	// ErrHealthCheckFailed error returned when health check failed.
	ErrHealthCheckFailed = errors.New("health check failed")
	// ErrPluginUnavailable error returned when plugin is unavailable.
	ErrPluginUnavailable = errors.New("plugin unavailable")
	// ErrMethodNotImplemented error returned when plugin method not implemented.
	ErrMethodNotImplemented = errors.New("method not implemented")
)

Types

type Plugin

type Plugin interface {
	PluginID() string
	Logger() log.Logger
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
	IsManaged() bool
	Exited() bool
	Decommission() error
	IsDecommissioned() bool
	Target() Target
	backend.CollectMetricsHandler
	backend.CheckHealthHandler
	backend.QueryDataHandler
	backend.CallResourceHandler
	backend.StreamHandler
}

Plugin is the backend plugin interface.

type PluginFactoryFunc

type PluginFactoryFunc func(pluginID string, logger log.Logger, env []string) (Plugin, error)

PluginFactoryFunc is a function type for creating a Plugin.

type Target

type Target string

const (
	TargetNone     Target = "none"
	TargetUnknown  Target = "unknown"
	TargetInMemory Target = "in_memory"
	TargetLocal    Target = "local"
)