| Path | Synopsis |
|---|---|
| api | Package api implements a type used for creating the Benthos HTTP API. |
| bloblang | |
| broker | Package broker implements types used for routing inputs to outputs in non-trivial arrangements, such as fan-out or fan-in models. |
| buffer | Package buffer is both a types.Consumer and types.Producer implementation that is able to sit between other stream components, effectively decoupling their transaction channels by storing messages in a buffer implementation. |
| buffer/parallel | Package parallel contains implementations of various buffer types where the buffer can be consumed by any number of parallel consumer threads. |
| buffer/single | Package single contains implementations of various buffer types where the buffer can only be consumed by a single thread (but any number of writers). |
| cache | Package cache implements the types.Cache interface for storing and retrieving key/value pairs from a range of storage strategies. |
| condition | Package condition contains logical operators that, based on their configuration, return boolean values from messages under certain circumstances. |
| config | Package config defines the full configuration structure used by the Benthos service, including methods of normalising and linting user configuration. |
| input | Package input defines consumers for aggregating data from a variety of sources. |
| input/reader | Package reader defines implementations of an interface for generic message reading from various third party sources. |
| log | Package log contains utilities for logging in a modular interface. |
| manager | Package manager implements the types.Manager interface used for creating and sharing resources across a Benthos service. |
| message | Package message contains implementations of types.Message. |
| message/batch | Package batch provides tooling for creating and executing Benthos message batch policies. |
| message/io | Package io provides tooling for serialising and deserialising messages. |
| message/mapper | Package mapper implements ways of splicing and mapping batches of messages so that their derivative parts can be processed individually and merged back into the original batch. |
| message/metadata | Package metadata contains implementations of types.Metadata. |
| message/roundtrip | Package roundtrip provides tooling for composing request/response behaviour through messages. |
| message/tracing | Package tracing implements utility functions for recording opentracing events for messages. |
| metrics | Package metrics contains a type for aggregating and propagating metrics to various services based on configuration. |
| output | Package output defines all sinks for sending Benthos messages to a variety of third party destinations. |
| output/writer | Package writer defines implementations of an interface for generic message writing that outputs to various third party sinks. |
| pipeline | Package pipeline contains structures that implement both the Producer and Consumer interfaces. |
| processor | Package processor contains implementations of types.Processor, which perform an arbitrary operation on a message and either returns >0 messages to be propagated towards a sink, or a response to be sent back to the message source. |
| ratelimit | Package ratelimit implements the types.RateLimit interface for limiting access to resources shared service wide. |
| response | Package response contains implementations of types.Response. |
| serverless | Package serverless contains shared components for serverless distributions of Benthos. |
| serverless/lambda | Package lambda contains the execution logic for running Benthos as an AWS lambda function. |
| service | Package service contains the main execution logic of the Benthos service, which is responsible for parsing commandline flags, running a stream and capturing termination signals. |
| service/blobl | |
| service/test | Package test implements the Benthos service unit testing command. |
| stream | Package stream creates and manages a full Benthos stream pipeline, consisting of an input layer of consumers, an optional buffer layer, a processing pipelines layer, and an output layer of producers: |
| stream/manager | Package manager creates and manages multiple streams, providing an API for performing CRUD operations. |
| tracer | Package tracer contains components able to send opentracing events. |
| types | Package types defines any general structs and interfaces used throughout the benthos code base. |
| util | |
| util/aws/lambda/client | |
| util/aws/session | |
| util/checkpoint | Package checkpoint implements a mechanism for tracking checkpointed integer offsets for sequential read at-least-once queue systems such as Kafka or Kinesis. |
| util/config | Package config contains utilities for reading and parsing service configuration files. |
| util/disk | Package disk contains cross platform disk statistics utilities. |
| util/http | |
| util/http/auth | Package auth provides configuration fields and implementations of HTTP request authentication strategies. |
| util/http/client | |
| util/retries | Package retries implements backoff strategies around a standard configuration scheme. |
| util/text | Package text includes utilities for working with text that might contain variables. |
| util/throttle | Package throttle implements throttle strategies. |
| util/tls | Package tls provides Benthos configuration fields and wrappers for a crypto/tls config. |
Updated 2021-01-22. Refresh now. Tools for package owners.