Documentation
¶
Index ¶
Constants ¶
View Source
const NameField = "plugin_name"
NameField is a required field in Config.
Variables ¶
the global plugin registry
Functions ¶
func Initializing ¶ added in v0.4.0
Initializing initialize the fields by fields mapping.
func RegisterPlugin ¶
func RegisterPlugin(plugin Plugin)
RegisterPlugin registers the pluginType as plugin. If the plugin is a pointer receiver, please pass a pointer. Otherwise, please pass a value.
func RegisterPluginCategory ¶
RegisterPluginCategory register the RegInfo to the global type registry.
Types ¶
type Config ¶
type Config map[string]interface{}
Config is used to initialize the DefaultInitializingPlugin.
type Plugin ¶
type Plugin interface {
// Name returns the name of the specific plugin.
Name() string
// ShowName returns the specific name show on documentations.
ShowName() string
// Description returns the description of the specific plugin.
Description() string
// DefaultConfig returns the default config, that is a YAML pattern.
DefaultConfig() string
}
Plugin defines the plugin model in Satellite.
type SharingPlugin ¶
type SharingPlugin interface {
Plugin
// Prepare the sharing plugins, such as build the connection with the external services.
Prepare() error
// Start a server to receive the input APM data.
Start() error
// Close the sharing plugin.
Close() error
}
SharingPlugin the plugins cloud be sharing with different modules in different namespaces.
Source Files
Click to show internal directories.
Click to hide internal directories.