forked from redpanda-data/connect
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
123 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,14 @@ | ||
|  | ||
| Redpanda Connect | ||
| ================ | ||
|
|
||
| [![godoc for benthosdev/benthos][godoc-badge]][godoc-url] | ||
| [![godoc for redpanda-data/connect][godoc-badge]][godoc-url] | ||
| [![Build Status][actions-badge]][actions-url] | ||
| [![Discord invite][discord-badge]][discord-url] | ||
| [![Docs site][website-badge]][website-url] | ||
|
|
||
| Benthos is a high performance and resilient stream processor, able to connect various [sources][inputs] and [sinks][outputs] in a range of brokering patterns and perform [hydration, enrichments, transformations and filters][processors] on payloads. | ||
| Redpanda Connect is a high performance and resilient stream processor, able to connect various [sources][inputs] and [sinks][outputs] in a range of brokering patterns and perform [hydration, enrichments, transformations and filters][processors] on payloads. | ||
|
|
||
| It comes with a [powerful mapping language][bloblang-about], is easy to deploy and monitor, and ready to drop into your pipeline either as a static binary, docker image, or [serverless function][serverless], making it cloud native as heck. | ||
| It comes with a [powerful mapping language][bloblang-about], is easy to deploy and monitor, and ready to drop into your pipeline either as a static binary or docker image, making it cloud native as heck. | ||
|
|
||
| Benthos is declarative, with stream pipelines defined in as few as a single config file, allowing you to specify connectors and a list of processing stages: | ||
| Redpanda Connect is declarative, with stream pipelines defined in as few as a single config file, allowing you to specify connectors and a list of processing stages: | ||
|
|
||
| ```yaml | ||
| input: | ||
|
|
@@ -33,103 +32,96 @@ output: | |
| ### Delivery Guarantees | ||
| Delivery guarantees [can be a dodgy subject](https://youtu.be/QmpBOCvY8mY). Benthos processes and acknowledges messages using an in-process transaction model with no need for any disk persisted state, so when connecting to at-least-once sources and sinks it's able to guarantee at-least-once delivery even in the event of crashes, disk corruption, or other unexpected server faults. | ||
| Delivery guarantees [can be a dodgy subject](https://youtu.be/QmpBOCvY8mY). Redpanda Connect processes and acknowledges messages using an in-process transaction model with no need for any disk persisted state, so when connecting to at-least-once sources and sinks it's able to guarantee at-least-once delivery even in the event of crashes, disk corruption, or other unexpected server faults. | ||
| This behaviour is the default and free of caveats, which also makes deploying and scaling Benthos much simpler. | ||
| This behaviour is the default and free of caveats, which also makes deploying and scaling Redpanda Connect much simpler. | ||
| ## Supported Sources & Sinks | ||
| AWS (DynamoDB, Kinesis, S3, SQS, SNS), Azure (Blob storage, Queue storage, Table storage), GCP (Pub/Sub, Cloud storage, Big query), Kafka, NATS (JetStream, Streaming), NSQ, MQTT, AMQP 0.91 (RabbitMQ), AMQP 1, Redis (streams, list, pubsub, hashes), Cassandra, Elasticsearch, HDFS, HTTP (server and client, including websockets), MongoDB, SQL (MySQL, PostgreSQL, Clickhouse, MSSQL), and [you know what just click here to see them all, they don't fit in a README][about-categories]. | ||
| Connectors are being added constantly, if something you want is missing then [open an issue](https://github.com/benthosdev/benthos/issues/new). | ||
| ## Documentation | ||
| If you want to dive fully into Benthos then don't waste your time in this dump, check out the [documentation site][general-docs]. | ||
| For guidance on how to configure more advanced stream processing concepts such as stream joins, enrichment workflows, etc, check out the [cookbooks section.][cookbooks] | ||
| If you want to dive fully into Redpanda Connect then don't waste your time in this dump, check out the [documentation site][general-docs]. | ||
| For guidance on building your own custom plugins in Go check out [the public APIs.][godoc-url] | ||
| ## Visual Interface | ||
| Do you like looking at stuff? Get angry and smash things when you're forced to read? If you're looking for a visual interface for Benthos check out [Benthos Studio][benthos-studio], it's a config builder, linter, and deployment management solution all baked into a single application. | ||
| ## Install | ||
| Grab a binary for your OS from [here.][releases] Or use this script: | ||
| Install on Linux: | ||
| ```shell | ||
| curl -Lsf https://www.benthos.dev/sh/install | bash | ||
| curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-linux-amd64.zip | ||
| unzip rpk-linux-amd64.zip -d ~/.local/bin/ | ||
| ``` | ||
|
|
||
| Or pull the docker image: | ||
| Or use Homebrew: | ||
|
|
||
| ```shell | ||
| docker pull ghcr.io/benthosdev/benthos | ||
| brew install redpanda-data/tap/redpanda | ||
| ``` | ||
|
|
||
| Benthos can also be installed via Homebrew: | ||
| Or pull the docker image: | ||
|
|
||
| ```shell | ||
| brew install benthos | ||
| docker pull ghcr.io/redpanda-data/connect | ||
| ``` | ||
|
|
||
| For more information check out the [getting started guide][getting-started]. | ||
|
|
||
| ## Run | ||
|
|
||
| ```shell | ||
| benthos -c ./config.yaml | ||
| rpk connect -c ./config.yaml | ||
| ``` | ||
|
|
||
| Or, with docker: | ||
|
|
||
| ```shell | ||
| # Using a config file | ||
| docker run --rm -v /path/to/your/config.yaml:/benthos.yaml ghcr.io/benthosdev/benthos | ||
| docker run --rm -v /path/to/your/config.yaml:/connect.yaml ghcr.io/redpanda-data/connect | ||
|
|
||
| # Using a series of -s flags | ||
| docker run --rm -p 4195:4195 ghcr.io/benthosdev/benthos \ | ||
| docker run --rm -p 4195:4195 ghcr.io/redpanda-data/connect \ | ||
| -s "input.type=http_server" \ | ||
| -s "output.type=kafka" \ | ||
| -s "output.kafka.addresses=kafka-server:9092" \ | ||
| -s "output.kafka.topic=benthos_topic" | ||
| -s "output.kafka.topic=redpanda_topic" | ||
| ``` | ||
|
|
||
| ## Monitoring | ||
|
|
||
| ### Health Checks | ||
|
|
||
| Benthos serves two HTTP endpoints for health checks: | ||
| Redpanda Connect serves two HTTP endpoints for health checks: | ||
| - `/ping` can be used as a liveness probe as it always returns a 200. | ||
| - `/ready` can be used as a readiness probe as it serves a 200 only when both the input and output are connected, otherwise a 503 is returned. | ||
|
|
||
| ### Metrics | ||
|
|
||
| Benthos [exposes lots of metrics][metrics] either to Statsd, Prometheus, a JSON HTTP endpoint, [and more][metrics]. | ||
| Redpanda Connect [exposes lots of metrics][metrics] either to Statsd, Prometheus, a JSON HTTP endpoint, [and more][metrics]. | ||
|
|
||
| ### Tracing | ||
|
|
||
| Benthos also [emits open telemetry tracing events][tracers], which can be used to visualise the processors within a pipeline. | ||
| Redpanda Connect also [emits open telemetry tracing events][tracers], which can be used to visualise the processors within a pipeline. | ||
|
|
||
| ## Configuration | ||
|
|
||
| Benthos provides lots of tools for making configuration discovery, debugging and organisation easy. You can [read about them here][config-doc]. | ||
| Redpanda Connect provides lots of tools for making configuration discovery, debugging and organisation easy. You can [read about them here][config-doc]. | ||
|
|
||
| ## Build | ||
|
|
||
| Build with Go (any [currently supported version](https://go.dev/dl/)): | ||
|
|
||
| ```shell | ||
| git clone [email protected]:benthosdev/benthos | ||
| cd benthos | ||
| git clone [email protected]:redpanda-data/connect | ||
| cd connect | ||
| make | ||
| ``` | ||
|
|
||
| ## Lint | ||
|
|
||
| Benthos uses [golangci-lint][golangci-lint] for linting, which you can install with: | ||
| Redpanda Connect uses [golangci-lint][golangci-lint] for linting, which you can install with: | ||
|
|
||
| ```shell | ||
| curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin | ||
|
|
@@ -139,15 +131,15 @@ And then run it with `make lint`. | |
|
|
||
| ## Plugins | ||
|
|
||
| It's pretty easy to write your own custom plugins for Benthos in Go, for information check out [the API docs][godoc-url], and for inspiration there's an [example repo][plugin-repo] demonstrating a variety of plugin implementations. | ||
| It's pretty easy to write your own custom plugins for Redpanda Connect in Go, for information check out [the API docs][godoc-url], and for inspiration there's an [example repo][plugin-repo] demonstrating a variety of plugin implementations. | ||
|
|
||
| ## Extra Plugins | ||
|
|
||
| By default Benthos does not build with components that require linking to external libraries, such as the `zmq4` input and outputs. If you wish to build Benthos locally with these dependencies then set the build tag `x_benthos_extra`: | ||
| By default Redpanda Connect does not build with components that require linking to external libraries, such as the `zmq4` input and outputs. If you wish to build Redpanda Connect locally with these dependencies then set the build tag `x_benthos_extra`: | ||
|
|
||
| ```shell | ||
| # With go | ||
| go install -tags "x_benthos_extra" github.com/benthosdev/benthos/v4/cmd/benthos@latest | ||
| go install -tags "x_benthos_extra" github.com/redpanda-data/connect/v4/cmd/redpanda-connect@latest | ||
|
|
||
| # Using make | ||
| make TAGS=x_benthos_extra | ||
|
|
@@ -157,7 +149,7 @@ Note that this tag may change or be broken out into granular tags for individual | |
|
|
||
| ## Docker Builds | ||
|
|
||
| There's a multi-stage `Dockerfile` for creating a Benthos docker image which results in a minimal image from scratch. You can build it with: | ||
| There's a multi-stage `Dockerfile` for creating a Redpanda Connect docker image which results in a minimal image from scratch. You can build it with: | ||
|
|
||
| ```shell | ||
| make docker | ||
|
|
@@ -170,42 +162,34 @@ docker run --rm \ | |
| -v /path/to/your/benthos.yaml:/config.yaml \ | ||
| -v /tmp/data:/data \ | ||
| -p 4195:4195 \ | ||
| benthos -c /config.yaml | ||
| redpanda-connect -c /config.yaml | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are welcome, please [read the guidelines](CONTRIBUTING.md), come and chat (links are on the [community page][community]), and watch your back. | ||
|
|
||
| [inputs]: https://www.benthos.dev/docs/components/inputs/about | ||
| [about-categories]: https://www.benthos.dev/docs/about#components | ||
| [processors]: https://www.benthos.dev/docs/components/processors/about | ||
| [outputs]: https://www.benthos.dev/docs/components/outputs/about | ||
| [metrics]: https://www.benthos.dev/docs/components/metrics/about | ||
| [tracers]: https://www.benthos.dev/docs/components/tracers/about | ||
| [config-interp]: https://www.benthos.dev/docs/configuration/interpolation | ||
| [streams-api]: https://www.benthos.dev/docs/guides/streams_mode/streams_api | ||
| [streams-mode]: https://www.benthos.dev/docs/guides/streams_mode/about | ||
| [general-docs]: https://www.benthos.dev/docs/about | ||
| [bloblang-about]: https://www.benthos.dev/docs/guides/bloblang/about | ||
| [config-doc]: https://www.benthos.dev/docs/configuration/about | ||
| [serverless]: https://www.benthos.dev/docs/guides/serverless/about | ||
| [cookbooks]: https://www.benthos.dev/cookbooks | ||
| [releases]: https://github.com/benthosdev/benthos/releases | ||
| Contributions are welcome, please [read the guidelines](CONTRIBUTING.md). | ||
|
|
||
| [inputs]: https://docs.redpanda.com/redpanda-connect/components/inputs/about | ||
| [about-categories]: https://docs.redpanda.com/redpanda-connect/about#components | ||
| [processors]: https://docs.redpanda.com/redpanda-connect/components/processors/about | ||
| [outputs]: https://docs.redpanda.com/redpanda-connect/components/outputs/about | ||
| [metrics]: https://docs.redpanda.com/redpanda-connect/components/metrics/about | ||
| [tracers]: https://docs.redpanda.com/redpanda-connect/components/tracers/about | ||
| [config-interp]: https://docs.redpanda.com/redpanda-connect/configuration/interpolation | ||
| [streams-api]: https://docs.redpanda.com/redpanda-connect/guides/streams_mode/streams_api | ||
| [streams-mode]: https://docs.redpanda.com/redpanda-connect/guides/streams_mode/about | ||
| [general-docs]: https://docs.redpanda.com/redpanda-connect/about | ||
| [bloblang-about]: https://docs.redpanda.com/redpanda-connect/guides/bloblang/about | ||
| [config-doc]: https://docs.redpanda.com/redpanda-connect/configuration/about | ||
| [releases]: https://github.com/redpanda-data/connect/releases | ||
| [plugin-repo]: https://github.com/benthosdev/benthos-plugin-example | ||
| [getting-started]: https://www.benthos.dev/docs/guides/getting_started | ||
| [getting-started]: https://docs.redpanda.com/redpanda-connect/guides/getting_started | ||
| [benthos-studio]: https://studio.benthos.dev | ||
|
|
||
| [godoc-badge]: https://pkg.go.dev/badge/github.com/benthosdev/benthos/v4/public | ||
| [godoc-url]: https://pkg.go.dev/github.com/benthosdev/benthos/v4/public | ||
| [actions-badge]: https://github.com/benthosdev/benthos/actions/workflows/test.yml/badge.svg | ||
| [actions-url]: https://github.com/benthosdev/benthos/actions/workflows/test.yml | ||
| [discord-badge]: https://img.shields.io/discord/746368194196799589 | ||
| [discord-url]: https://discord.com/invite/6VaWjzP | ||
| [website-badge]: https://img.shields.io/badge/Docs-Learn%20more-ffc7c7 | ||
| [website-url]: https://www.benthos.dev | ||
|
|
||
| [community]: https://www.benthos.dev/community | ||
| [godoc-badge]: https://pkg.go.dev/badge/github.com/redpanda-data/benthos/v4/public | ||
| [godoc-url]: https://pkg.go.dev/github.com/redpanda-data/benthos/v4/public | ||
| [actions-badge]: https://github.com/redpanda-data/connect/actions/workflows/test.yml/badge.svg | ||
| [actions-url]: https://github.com/redpanda-data/connect/actions/workflows/test.yml | ||
|
|
||
| [golangci-lint]: https://golangci-lint.run/ | ||
| [jaeger]: https://www.jaegertracing.io/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.