component

Documentation

Index

• Variables
• func ErrInvalidType(typeStr, tried string) error
• type ErrBackOff
  • func (e *ErrBackOff) Error() string
• type Observability
  • func NoopObservability() Observability

Variables

var (
	ErrTimeout    = errors.New("action timed out")
	ErrTypeClosed = errors.New("type was closed")

	ErrNotConnected = errors.New("not connected to target source or sink")

	// ErrAlreadyStarted is returned when an input or output type gets started a
	// second time.
	ErrAlreadyStarted = errors.New("type has already been started")

	ErrNoAck = errors.New("failed to receive acknowledgement")

	ErrFailedSend = errors.New("message failed to reach a target destination")
)

Errors used throughout the codebase.

var (
	ErrInputNotFound     = errors.New("input not found")
	ErrCacheNotFound     = errors.New("cache not found")
	ErrProcessorNotFound = errors.New("processor not found")
	ErrRateLimitNotFound = errors.New("rate limit not found")
	ErrOutputNotFound    = errors.New("output not found")
	ErrKeyAlreadyExists  = errors.New("key already exists")
	ErrKeyNotFound       = errors.New("key does not exist")
	ErrPipeNotFound      = errors.New("pipe was not found")
)

Manager errors.

var (
	ErrMessageTooLarge = errors.New("message body larger than buffer space")
)

Buffer errors.

var ErrNotUnwrapped = errors.New("something has gone wrong during the registering of this component, please open an issue https://github.com/benthosdev/benthos/issues/new to let us know")

ErrNotUnwrapped is returned in cases where a component was meant to be unwrapped either from the public packages or to the public packages but for some reason this did not happen. Unwrapping should only occur in times when it's guaranteed to succeed, so this error indicates that an assumption was incorrect during the migration of certain components which will need to be immediately addressed by maintainers.

Functions

func ErrInvalidType

func ErrInvalidType(typeStr, tried string) error

ErrInvalidType creates an error that describes a component type being initialized with an unrecognised implementation.

Types

type ErrBackOff

type ErrBackOff struct {
	Err  error
	Wait time.Duration
}

ErrBackOff is an error returned that allows for a back off duration to be specified

func (*ErrBackOff) Error

func (e *ErrBackOff) Error() string

Error returns the Error string.

type Observability

type Observability interface {
	Metrics() metrics.Type
	Logger() log.Modular
	Tracer() trace.TracerProvider
}

Observability is an interface implemented by components that provide a range of observability APIs to components. This is primarily done the service-wide managers.

func NoopObservability

func NoopObservability() Observability

NoopObservability returns an implementation of Observability that does nothing.