Documentation ¶
Overview ¶
Package bundle contains singletons referenced throughout the Benthos codebase that allow imported components to add their constructors and documentation to a service.
Each component type has it's own singleton bundle containing all imported implementations of the component, and from this bundle more can be derived that modify the components that are available.
Index ¶
- Variables
- type BufferConstructor
- type BufferSet
- type CacheConstructor
- type CacheSet
- type Environment
- func (e *Environment) BufferAdd(constructor BufferConstructor, spec docs.ComponentSpec) error
- func (e *Environment) BufferDocs() []docs.ComponentSpec
- func (e *Environment) BufferInit(conf buffer.Config, mgr NewManagement) (buffer.Type, error)
- func (e *Environment) CacheAdd(constructor CacheConstructor, spec docs.ComponentSpec) error
- func (e *Environment) CacheDocs() []docs.ComponentSpec
- func (e *Environment) CacheInit(conf cache.Config, mgr NewManagement) (types.Cache, error)
- func (e *Environment) Clone() *Environment
- func (e *Environment) GetDocs(name string, ctype docs.Type) (docs.ComponentSpec, bool)
- func (e *Environment) InputAdd(constructor InputConstructor, spec docs.ComponentSpec) error
- func (e *Environment) InputDocs() []docs.ComponentSpec
- func (e *Environment) InputInit(hasBatchProc bool, conf input.Config, mgr NewManagement, ...) (types.Input, error)
- func (e *Environment) OutputAdd(constructor OutputConstructor, spec docs.ComponentSpec) error
- func (e *Environment) OutputDocs() []docs.ComponentSpec
- func (e *Environment) OutputInit(conf output.Config, mgr NewManagement, ...) (types.Output, error)
- func (e *Environment) ProcessorAdd(constructor ProcessorConstructor, spec docs.ComponentSpec) error
- func (e *Environment) ProcessorDocs() []docs.ComponentSpec
- func (e *Environment) ProcessorInit(conf processor.Config, mgr NewManagement) (types.Processor, error)
- func (e *Environment) RateLimitAdd(constructor RateLimitConstructor, spec docs.ComponentSpec) error
- func (e *Environment) RateLimitDocs() []docs.ComponentSpec
- func (e *Environment) RateLimitInit(conf ratelimit.Config, mgr NewManagement) (types.RateLimit, error)
- type InputConstructor
- type InputSet
- func (s *InputSet) Add(constructor InputConstructor, spec docs.ComponentSpec) error
- func (s *InputSet) Docs() []docs.ComponentSpec
- func (s *InputSet) DocsFor(name string) (docs.ComponentSpec, bool)
- func (s *InputSet) Init(hasBatchProc bool, conf input.Config, mgr NewManagement, ...) (types.Input, error)
- type MetricConstructor
- type MetricsSet
- func (s *MetricsSet) Add(constructor MetricConstructor, spec docs.ComponentSpec) error
- func (s *MetricsSet) Docs() []docs.ComponentSpec
- func (s *MetricsSet) DocsFor(name string) (docs.ComponentSpec, bool)
- func (s *MetricsSet) Init(conf metrics.Config, opts ...func(metrics.Type)) (metrics.Type, error)
- type NewManagement
- type OutputConstructor
- type OutputSet
- type ProcessorConstructor
- type ProcessorSet
- func (s *ProcessorSet) Add(constructor ProcessorConstructor, spec docs.ComponentSpec) error
- func (s *ProcessorSet) Docs() []docs.ComponentSpec
- func (s *ProcessorSet) DocsFor(name string) (docs.ComponentSpec, bool)
- func (s *ProcessorSet) Init(conf processor.Config, mgr NewManagement) (types.Processor, error)
- type RateLimitConstructor
- type RateLimitSet
- func (s *RateLimitSet) Add(constructor RateLimitConstructor, spec docs.ComponentSpec) error
- func (s *RateLimitSet) Docs() []docs.ComponentSpec
- func (s *RateLimitSet) DocsFor(name string) (docs.ComponentSpec, bool)
- func (s *RateLimitSet) Init(conf ratelimit.Config, mgr NewManagement) (types.RateLimit, error)
- type TracerConstructor
- type TracerSet
Constants ¶
This section is empty.
Variables ¶
var AllBuffers = &BufferSet{ specs: map[string]bufferSpec{}, }
AllBuffers is a set containing every single buffer that has been imported.
var AllCaches = &CacheSet{ specs: map[string]cacheSpec{}, }
AllCaches is a set containing every single cache that has been imported.
var AllInputs = &InputSet{ specs: map[string]inputSpec{}, }
AllInputs is a set containing every single input that has been imported.
var AllMetrics = &MetricsSet{ specs: map[string]metricsSpec{}, }
AllMetrics is a set containing every single metrics that has been imported.
var AllOutputs = &OutputSet{ specs: map[string]outputSpec{}, }
AllOutputs is a set containing every single output that has been imported.
var AllProcessors = &ProcessorSet{ specs: map[string]processorSpec{}, }
AllProcessors is a set containing every single processor that has been imported.
var AllRateLimits = &RateLimitSet{ specs: map[string]rateLimitSpec{}, }
AllRateLimits is a set containing every single ratelimit that has been imported.
var AllTracers = &TracerSet{ specs: map[string]tracerSpec{}, }
AllTracers is a set containing every single tracer that has been imported.
var GlobalEnvironment = &Environment{ buffers: AllBuffers, caches: AllCaches, inputs: AllInputs, outputs: AllOutputs, processors: AllProcessors, rateLimits: AllRateLimits, }
GlobalEnvironment contains service-wide singleton bundles.
Functions ¶
This section is empty.
Types ¶
type BufferConstructor ¶
BufferConstructor constructs an buffer component.
type BufferSet ¶
type BufferSet struct {
// contains filtered or unexported fields
}
BufferSet contains an explicit set of buffers available to a Benthos service.
func (*BufferSet) Add ¶
func (s *BufferSet) Add(constructor BufferConstructor, spec docs.ComponentSpec) error
Add a new buffer to this set by providing a spec (name, documentation, and constructor).
func (*BufferSet) Docs ¶
func (s *BufferSet) Docs() []docs.ComponentSpec
Docs returns a slice of buffer specs, which document each method.
type CacheConstructor ¶
CacheConstructor constructs an cache component.
type CacheSet ¶
type CacheSet struct {
// contains filtered or unexported fields
}
CacheSet contains an explicit set of caches available to a Benthos service.
func (*CacheSet) Add ¶
func (s *CacheSet) Add(constructor CacheConstructor, spec docs.ComponentSpec) error
Add a new cache to this set by providing a spec (name, documentation, and constructor).
func (*CacheSet) Docs ¶
func (s *CacheSet) Docs() []docs.ComponentSpec
Docs returns a slice of cache specs, which document each method.
type Environment ¶ added in v3.51.0
type Environment struct {
// contains filtered or unexported fields
}
Environment is a collection of Benthos component plugins that can be used in order to build and run streaming pipelines with access to different sets of plugins. This is useful for sandboxing, testing, etc.
func NewEnvironment ¶ added in v3.51.0
func NewEnvironment() *Environment
NewEnvironment creates an empty environment.
func (*Environment) BufferAdd ¶ added in v3.61.0
func (e *Environment) BufferAdd(constructor BufferConstructor, spec docs.ComponentSpec) error
BufferAdd adds a new buffer to this environment by providing a constructor and documentation.
func (*Environment) BufferDocs ¶ added in v3.61.0
func (e *Environment) BufferDocs() []docs.ComponentSpec
BufferDocs returns a slice of buffer specs, which document each method.
func (*Environment) BufferInit ¶ added in v3.61.0
func (e *Environment) BufferInit(conf buffer.Config, mgr NewManagement) (buffer.Type, error)
BufferInit attempts to initialise a buffer from a config.
func (*Environment) CacheAdd ¶ added in v3.61.0
func (e *Environment) CacheAdd(constructor CacheConstructor, spec docs.ComponentSpec) error
CacheAdd adds a new cache to this environment by providing a constructor and documentation.
func (*Environment) CacheDocs ¶ added in v3.61.0
func (e *Environment) CacheDocs() []docs.ComponentSpec
CacheDocs returns a slice of cache specs, which document each method.
func (*Environment) CacheInit ¶ added in v3.61.0
func (e *Environment) CacheInit(conf cache.Config, mgr NewManagement) (types.Cache, error)
CacheInit attempts to initialise a cache from a config.
func (*Environment) Clone ¶ added in v3.51.0
func (e *Environment) Clone() *Environment
Clone an existing environment to a new one that can be modified independently.
func (*Environment) GetDocs ¶ added in v3.51.0
func (e *Environment) GetDocs(name string, ctype docs.Type) (docs.ComponentSpec, bool)
GetDocs returns a documentation spec for an implementation of a component.
func (*Environment) InputAdd ¶ added in v3.61.0
func (e *Environment) InputAdd(constructor InputConstructor, spec docs.ComponentSpec) error
InputAdd adds a new input to this environment by providing a constructor and documentation.
func (*Environment) InputDocs ¶ added in v3.61.0
func (e *Environment) InputDocs() []docs.ComponentSpec
InputDocs returns a slice of input specs, which document each method.
func (*Environment) InputInit ¶ added in v3.61.0
func (e *Environment) InputInit( hasBatchProc bool, conf input.Config, mgr NewManagement, pipelines ...types.PipelineConstructorFunc, ) (types.Input, error)
InputInit attempts to initialise an input from a config.
func (*Environment) OutputAdd ¶ added in v3.61.0
func (e *Environment) OutputAdd(constructor OutputConstructor, spec docs.ComponentSpec) error
OutputAdd adds a new output to this environment by providing a constructor and documentation.
func (*Environment) OutputDocs ¶ added in v3.61.0
func (e *Environment) OutputDocs() []docs.ComponentSpec
OutputDocs returns a slice of output specs, which document each method.
func (*Environment) OutputInit ¶ added in v3.61.0
func (e *Environment) OutputInit( conf output.Config, mgr NewManagement, pipelines ...types.PipelineConstructorFunc, ) (types.Output, error)
OutputInit attempts to initialise a output from a config.
func (*Environment) ProcessorAdd ¶ added in v3.61.0
func (e *Environment) ProcessorAdd(constructor ProcessorConstructor, spec docs.ComponentSpec) error
ProcessorAdd adds a new processor to this environment by providing a constructor and documentation.
func (*Environment) ProcessorDocs ¶ added in v3.61.0
func (e *Environment) ProcessorDocs() []docs.ComponentSpec
ProcessorDocs returns a slice of processor specs, which document each method.
func (*Environment) ProcessorInit ¶ added in v3.61.0
func (e *Environment) ProcessorInit(conf processor.Config, mgr NewManagement) (types.Processor, error)
ProcessorInit attempts to initialise a processor from a config.
func (*Environment) RateLimitAdd ¶ added in v3.61.0
func (e *Environment) RateLimitAdd(constructor RateLimitConstructor, spec docs.ComponentSpec) error
RateLimitAdd adds a new ratelimit to this environment by providing a constructor and documentation.
func (*Environment) RateLimitDocs ¶ added in v3.61.0
func (e *Environment) RateLimitDocs() []docs.ComponentSpec
RateLimitDocs returns a slice of ratelimit specs, which document each method.
func (*Environment) RateLimitInit ¶ added in v3.61.0
func (e *Environment) RateLimitInit(conf ratelimit.Config, mgr NewManagement) (types.RateLimit, error)
RateLimitInit attempts to initialise a ratelimit from a config.
type InputConstructor ¶
type InputConstructor func(bool, input.Config, NewManagement, ...types.PipelineConstructorFunc) (input.Type, error)
InputConstructor constructs an input component.
func InputConstructorFromSimple ¶
func InputConstructorFromSimple(fn func(input.Config, NewManagement) (input.Type, error)) InputConstructor
InputConstructorFromSimple provides a way to define an input constructor without manually initializing processors of the config.
type InputSet ¶
type InputSet struct {
// contains filtered or unexported fields
}
InputSet contains an explicit set of inputs available to a Benthos service.
func (*InputSet) Add ¶
func (s *InputSet) Add(constructor InputConstructor, spec docs.ComponentSpec) error
Add a new input to this set by providing a constructor and documentation.
func (*InputSet) Docs ¶
func (s *InputSet) Docs() []docs.ComponentSpec
Docs returns a slice of input specs, which document each method.
type MetricConstructor ¶
type MetricConstructor metrics.ConstructorFunc
MetricConstructor constructs an metrics component.
type MetricsSet ¶
type MetricsSet struct {
// contains filtered or unexported fields
}
MetricsSet contains an explicit set of metrics available to a Benthos service.
func (*MetricsSet) Add ¶
func (s *MetricsSet) Add(constructor MetricConstructor, spec docs.ComponentSpec) error
Add a new metrics to this set by providing a spec (name, documentation, and constructor).
func (*MetricsSet) Docs ¶
func (s *MetricsSet) Docs() []docs.ComponentSpec
Docs returns a slice of metrics specs, which document each method.
func (*MetricsSet) DocsFor ¶
func (s *MetricsSet) DocsFor(name string) (docs.ComponentSpec, bool)
DocsFor returns the documentation for a given component name, returns a boolean indicating whether the component name exists.
type NewManagement ¶
type NewManagement interface { types.Manager ForStream(id string) types.Manager ForComponent(id string) types.Manager ForChildComponent(id string) types.Manager Label() string Metrics() metrics.Type Logger() log.Modular Environment() *Environment BloblEnvironment() *bloblang.Environment NewBuffer(conf buffer.Config) (buffer.Type, error) NewCache(conf cache.Config) (types.Cache, error) NewInput(conf input.Config, hasBatchProc bool, pipelines ...types.PipelineConstructorFunc) (types.Input, error) NewProcessor(conf processor.Config) (types.Processor, error) NewOutput(conf output.Config, pipelines ...types.PipelineConstructorFunc) (types.Output, error) NewRateLimit(conf ratelimit.Config) (types.RateLimit, error) AccessCache(ctx context.Context, name string, fn func(types.Cache)) error StoreCache(ctx context.Context, name string, conf cache.Config) error AccessInput(ctx context.Context, name string, fn func(types.Input)) error StoreInput(ctx context.Context, name string, conf input.Config) error AccessProcessor(ctx context.Context, name string, fn func(types.Processor)) error StoreProcessor(ctx context.Context, name string, conf processor.Config) error AccessOutput(ctx context.Context, name string, fn func(types.OutputWriter)) error StoreOutput(ctx context.Context, name string, conf output.Config) error AccessRateLimit(ctx context.Context, name string, fn func(types.RateLimit)) error StoreRateLimit(ctx context.Context, name string, conf ratelimit.Config) error }
NewManagement defines the latest API for a Benthos manager, which will become the only API (internally) in Benthos V4.
type OutputConstructor ¶
type OutputConstructor func(output.Config, NewManagement, ...types.PipelineConstructorFunc) (output.Type, error)
OutputConstructor constructs an output component.
func OutputConstructorFromSimple ¶
func OutputConstructorFromSimple(fn func(output.Config, NewManagement) (output.Type, error)) OutputConstructor
OutputConstructorFromSimple provides a way to define an output constructor without manually initializing processors of the config.
type OutputSet ¶
type OutputSet struct {
// contains filtered or unexported fields
}
OutputSet contains an explicit set of outputs available to a Benthos service.
func (*OutputSet) Add ¶
func (s *OutputSet) Add(constructor OutputConstructor, spec docs.ComponentSpec) error
Add a new output to this set by providing a spec (name, documentation, and constructor).
func (*OutputSet) Docs ¶
func (s *OutputSet) Docs() []docs.ComponentSpec
Docs returns a slice of output specs, which document each method.
type ProcessorConstructor ¶
ProcessorConstructor constructs an processor component.
type ProcessorSet ¶
type ProcessorSet struct {
// contains filtered or unexported fields
}
ProcessorSet contains an explicit set of processors available to a Benthos service.
func (*ProcessorSet) Add ¶
func (s *ProcessorSet) Add(constructor ProcessorConstructor, spec docs.ComponentSpec) error
Add a new processor to this set by providing a spec (name, documentation, and constructor).
func (*ProcessorSet) Docs ¶
func (s *ProcessorSet) Docs() []docs.ComponentSpec
Docs returns a slice of processor specs, which document each method.
func (*ProcessorSet) DocsFor ¶
func (s *ProcessorSet) DocsFor(name string) (docs.ComponentSpec, bool)
DocsFor returns the documentation for a given component name, returns a boolean indicating whether the component name exists.
func (*ProcessorSet) Init ¶
func (s *ProcessorSet) Init(conf processor.Config, mgr NewManagement) (types.Processor, error)
Init attempts to initialise an processor from a config.
type RateLimitConstructor ¶
RateLimitConstructor constructs an ratelimit component.
type RateLimitSet ¶
type RateLimitSet struct {
// contains filtered or unexported fields
}
RateLimitSet contains an explicit set of ratelimits available to a Benthos service.
func (*RateLimitSet) Add ¶
func (s *RateLimitSet) Add(constructor RateLimitConstructor, spec docs.ComponentSpec) error
Add a new ratelimit to this set by providing a spec (name, documentation, and constructor).
func (*RateLimitSet) Docs ¶
func (s *RateLimitSet) Docs() []docs.ComponentSpec
Docs returns a slice of ratelimit specs, which document each method.
func (*RateLimitSet) DocsFor ¶
func (s *RateLimitSet) DocsFor(name string) (docs.ComponentSpec, bool)
DocsFor returns the documentation for a given component name, returns a boolean indicating whether the component name exists.
func (*RateLimitSet) Init ¶
func (s *RateLimitSet) Init(conf ratelimit.Config, mgr NewManagement) (types.RateLimit, error)
Init attempts to initialise an ratelimit from a config.
type TracerConstructor ¶
type TracerConstructor tracer.ConstructorFunc
TracerConstructor constructs an tracer component.
type TracerSet ¶
type TracerSet struct {
// contains filtered or unexported fields
}
TracerSet contains an explicit set of tracers available to a Benthos service.
func (*TracerSet) Add ¶
func (s *TracerSet) Add(constructor TracerConstructor, spec docs.ComponentSpec) error
Add a new tracer to this set by providing a spec (name, documentation, and constructor).
func (*TracerSet) Docs ¶
func (s *TracerSet) Docs() []docs.ComponentSpec
Docs returns a slice of tracer specs, which document each method.