redpanda-data / redpanda-data/connect

Programatic use of benthos

Open
#1,937 1 comment 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ash pls enhancement needs investigation
Dominant language
Go
Stars
8.8k
Forks
969
Avg merge
1d 13h
Merged PRs (30d)
64

Description

To support others (me!) to build their applications on top of benthos, you would need access to some of the parts considered internal to benthos. There are some hooks you can use, namely the Streams API, cli.Run, Environment and the StreamsBuilder. However, things become more difficult if you want to run/test a set of processors or examine the ConfigSpec for a specific component.

Exposing certain key parts of benthos might make it a lot easier for others to integrate.

The following items might good candidates for being exposed:

  • internal.component.processor.execute.go: ExecuteAll

Additionally, StreamBuilder could be extended to offer the ability to add/set components in a more go-like way, using structs instead of yaml content. Currently we have to resort to map[string]any{} and yaml.Marshal that, which works, but isn't great.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading internal.component.processor.execute.go, especially ExecuteAll, and trace the existing Streams API, cli.Run, Environment, and StreamsBuilder interfaces. Compare the current yaml.Marshal and map[string]any{} approach with the requested programmatic access, then define the exposed surface and verify that processors and ConfigSpec can be used as described.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.