Skip to content

Commit

Permalink
Merge pull request #41 from runreveal/alan/prep-reveald
Browse files Browse the repository at this point in the history
Evict reveald into it's own repository.
  • Loading branch information
abraithwaite committed May 14, 2024
2 parents bfde06c + 977d28a commit b843f40
Show file tree
Hide file tree
Showing 21 changed files with 1 addition and 1,412 deletions.
56 changes: 1 addition & 55 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,8 @@

kawa ("Kaa-Wah") is an opinionated framework for scalable, reliable stream processing.

kawad ("Kaa-Wah-Dee") is a daemon for collecting system logs and metrics.

# Installation

## Kawad

Find the package for your OS and architecture on the releases page. Download
that file to the machine, and install somewhere visible on your $path.

curl -L https://github.com/runreveal/kawa/releases/download/<RELEASE_VERSION>/kawa-linux-amd64.tar.gz | sudo tar --directory /usr/local/bin -xz

Copy an example config from the examples/ directory, then run it! There is
also an example for deploying as a systemd service. Additionally, we'll have
kubernetes examples soon.

## Kawa

Add the library to your project as you would any other Go library:
Expand All @@ -47,9 +34,7 @@ See https://blog.runreveal.com/kawa-the-event-processor-for-the-grug-brained-dev

# Roadmap

- Ensure that consumers of kawa aren't subject to all the dependencies of the
kawa program.
- Related: consider breaking apart the library from the daemon.
- Ensure that consumers of kawa aren't subject to all the dependencies of the plugins.
- Event Routing and/or Multiple Processors in kawa program
- Dynamic Sources (e.g. Kafka Consumer Groups)

Expand All @@ -59,45 +44,6 @@ This is nascent software, subject to breaking changes as we reach a good
working set of APIs, interfaces and data models. Please try it out and help
shape the direction of the project by giving us feedback!

# Getting started using Kawad

An example use case might be shipping your nginx logs to s3. Save the following
config.json, and fill in the config file.

```
{
"sources": [
{
"type": "syslog",
"addr": "0.0.0.0:5514",
"contentType": "application/json; rrtype=nginx-json",
},
],
"destinations": [
{
"type": "s3",
"bucketName": "{{YOUR-S3-BUCKET-NAME}}",
"bucketRegion": "us-east-2",
},
],
}
```

Next, add the following line to your nginx server config.

```
server {
access_log syslog:server=127.0.0.1:5514;
# ... other config ...
}
```

Run it!

```
$ kawa run --config config.json
```

# Development & Extension

The source and destination interfaces are designed for simplicity of use and
Expand Down
181 changes: 0 additions & 181 deletions cmd/kawad/config.go

This file was deleted.

30 changes: 0 additions & 30 deletions cmd/kawad/config_windows.go

This file was deleted.

1 change: 0 additions & 1 deletion cmd/kawad/internal/README.md

This file was deleted.

35 changes: 0 additions & 35 deletions cmd/kawad/internal/destinations/mqtt/mqtt.go

This file was deleted.

28 changes: 0 additions & 28 deletions cmd/kawad/internal/destinations/printer/printer.go

This file was deleted.

Loading

0 comments on commit b843f40

Please sign in to comment.