interop

Documentation

Overview

Package interop provides utilities for initializing Benthos components that default to the old APIs, but when the provided manager supports it the new APIs are used.

TODO: V4 Remove this package

Index

• func AccessCache(ctx context.Context, mgr types.Manager, name string, fn func(types.Cache)) error
• func AccessInput(ctx context.Context, mgr types.Manager, name string, fn func(types.Input)) error
• func AccessOutput(ctx context.Context, mgr types.Manager, name string, ...) error
• func AccessProcessor(ctx context.Context, mgr types.Manager, name string, fn func(types.Processor)) error
• func AccessRateLimit(ctx context.Context, mgr types.Manager, name string, fn func(types.RateLimit)) error
• func GetLabel(mgr types.Manager) string
• func LabelChild(label string, mgr types.Manager, logger log.Modular, stats metrics.Type) (types.Manager, log.Modular, metrics.Type)
• func LabelRoot(label string, mgr types.Manager, logger log.Modular, stats metrics.Type) (types.Manager, log.Modular, metrics.Type)
• func LabelStream(label string, mgr types.Manager, logger log.Modular, stats metrics.Type) (types.Manager, log.Modular, metrics.Type)
• func ProbeCache(ctx context.Context, mgr types.Manager, name string) error
• func ProbeInput(ctx context.Context, mgr types.Manager, name string) error
• func ProbeOutput(ctx context.Context, mgr types.Manager, name string) error
• func ProbeProcessor(ctx context.Context, mgr types.Manager, name string) error
• func ProbeRateLimit(ctx context.Context, mgr types.Manager, name string) error

Functions

func AccessCache

func AccessCache(ctx context.Context, mgr types.Manager, name string, fn func(types.Cache)) error

AccessCache attempts to access a cache resource by a unique identifier and executes a closure function with the cache as an argument. Returns an error if the cache does not exist (or is otherwise inaccessible).

func AccessInput

func AccessInput(ctx context.Context, mgr types.Manager, name string, fn func(types.Input)) error

AccessInput attempts to access an input resource by a unique identifier and executes a closure function with the input as an argument. Returns an error if the input does not exist (or is otherwise inaccessible).

func AccessOutput

func AccessOutput(ctx context.Context, mgr types.Manager, name string, fn func(types.OutputWriter)) error

AccessOutput attempts to access an output resource by a unique identifier and executes a closure function with the output as an argument. Returns an error if the output does not exist (or is otherwise inaccessible).

func AccessProcessor

func AccessProcessor(ctx context.Context, mgr types.Manager, name string, fn func(types.Processor)) error

AccessProcessor attempts to access a processor resource by a unique identifier and executes a closure function with the processor as an argument. Returns an error if the processor does not exist (or is otherwise inaccessible).

func AccessRateLimit

func AccessRateLimit(ctx context.Context, mgr types.Manager, name string, fn func(types.RateLimit)) error

AccessRateLimit attempts to access a rate limit resource by a unique identifier and executes a closure function with the rate limit as an argument. Returns an error if the rate limit does not exist (or is otherwise inaccessible).

func GetLabel

func GetLabel(mgr types.Manager) string

GetLabel attempts the extract the current label of a component by obtaining it from a manager. If the manager does not support label methods then it instead falls back to a UUID, and somehow failing that returns an empty string.

func LabelChild

func LabelChild(label string, mgr types.Manager, logger log.Modular, stats metrics.Type) (types.Manager, log.Modular, metrics.Type)

LabelChild expands the label of the provided observability components.

func LabelRoot

func LabelRoot(label string, mgr types.Manager, logger log.Modular, stats metrics.Type) (types.Manager, log.Modular, metrics.Type)

LabelRoot replaces the label of the provided observability components.

func LabelStream

func LabelStream(label string, mgr types.Manager, logger log.Modular, stats metrics.Type) (types.Manager, log.Modular, metrics.Type)

LabelStream expands the label of the provided observability components with a stream identifier.

func ProbeCache

func ProbeCache(ctx context.Context, mgr types.Manager, name string) error

ProbeCache checks whether a cache resource has been configured, and returns an error if not.

func ProbeInput

func ProbeInput(ctx context.Context, mgr types.Manager, name string) error

ProbeInput checks whether an input resource has been configured, and returns an error if not.

func ProbeOutput

func ProbeOutput(ctx context.Context, mgr types.Manager, name string) error

ProbeOutput checks whether an output resource has been configured, and returns an error if not.

func ProbeProcessor

func ProbeProcessor(ctx context.Context, mgr types.Manager, name string) error

ProbeProcessor checks whether a processor resource has been configured, and returns an error if not.

func ProbeRateLimit

func ProbeRateLimit(ctx context.Context, mgr types.Manager, name string) error

ProbeRateLimit checks whether a rate limit resource has been configured, and returns an error if not.