README
¶
Implementations
This is an internal package containing the implementations of Benthos component types (inputs, processors, outputs, etc) organised into sub categories.
If you intend to create a new component type then use the docs at https://pkg.go.dev/github.com/benthosdev/benthos/v4/public/service, and there are some implementations that might be worth using as a reference:
- Input example: ./nats/input_jetstream.go
- Output example: ./nats/output_jetstream.go
- Processor example: ./confluent/processor_schema_registry_encode.go
- Buffer example: ./generic/buffer_system_window.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Package azure will eventually contain all implementations of Azure components (that are currently within ./internal/old)
|
Package azure will eventually contain all implementations of Azure components (that are currently within ./internal/old) |
|
shared
Package shared contains docs fields that need to be shared across old and new component implementations, it needs to be separate from the parent package in order to avoid circular dependencies (for now).
|
Package shared contains docs fields that need to be shared across old and new component implementations, it needs to be separate from the parent package in order to avoid circular dependencies (for now). |
|
Package io contains component implementations that have a small dependency footprint (mostly standard library) and interact with external systems via the filesystem and/or network sockets.
|
Package io contains component implementations that have a small dependency footprint (mostly standard library) and interact with external systems via the filesystem and/or network sockets. |
|
Package mqtt will eventually contain all implementations of MQTT components (that are currently within ./internal/old)
|
Package mqtt will eventually contain all implementations of MQTT components (that are currently within ./internal/old) |
|
shared
Package shared contains docs fields that need to be shared across old and new component implementations, it needs to be separate from the parent package in order to avoid circular dependencies (for now).
|
Package shared contains docs fields that need to be shared across old and new component implementations, it needs to be separate from the parent package in order to avoid circular dependencies (for now). |
|
Package pure contains all component implementations that are pure, in that they do not interact with external systems.
|
Package pure contains all component implementations that are pure, in that they do not interact with external systems. |
|
Package sftp will eventually contain all implementations of SFTP components (that are currently within ./internal/old)
|
Package sftp will eventually contain all implementations of SFTP components (that are currently within ./internal/old) |
|
shared
Package shared contains docs fields that need to be shared across old and new component implementations, it needs to be separate from the parent package in order to avoid circular dependencies (for now).
|
Package shared contains docs fields that need to be shared across old and new component implementations, it needs to be separate from the parent package in order to avoid circular dependencies (for now). |
|
Package xml is a temporary way to convert XML to JSON.
|
Package xml is a temporary way to convert XML to JSON. |
Click to show internal directories.
Click to hide internal directories.