Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docs section describing librdkafka dependency [#4] #10

Merged
merged 2 commits into from
Nov 22, 2019
Merged

Add docs section describing librdkafka dependency [#4] #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d078615
Add docs section describing librdkafka dependency [#4]
Nov 16, 2019
d9ec726
Merge branch 'master' into install-librdkafka-docs
jnadler Nov 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ We provide two built-in node types:
* **kafkaproducer** - Events are produced onto a kafka topic by an asynchronous producer.
* **elasticsearch** - Events are bulk indexed into Elasticsearch.

Firebolt has both run and compile-time dependencies on `librdkafka`, see [Developing](#developing)

## Example: Logging Pipeline
At DigitalOcean, our first use of Firebolt was in our logging pipeline. This pipeline consumes logs from just about
every system we run. The diagram below depicts the source and nodes in this application.
Expand Down Expand Up @@ -83,3 +85,17 @@ Some of the concerns Firebolt addresses include:
1. [Kafka Producer ](docs/node-kafkaproducer.md) Node for producing events onto a Kafka topic

1. [Elasticsearch ](docs/node-elasticsearch.md) Node for indexing documents to an Elasticsearch cluster

## Developing

Firebolt depends on [librdkafka](https://github.com/edenhill/librdkafka) v1.1.0 or later. To get started building a
firebolt app (or working on firebolt itself), install it following the
[instructions here](https://github.com/edenhill/librdkafka#installation).

An example for debian-based distros:
```
sudo wget -qO - https://packages.confluent.io/deb/5.3/archive.key | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://packages.confluent.io/deb/5.3 stable main"
sudo apt-get update
sudo apt-get install -y librdkafka1 librdkafka-dev
```