remora

(β˜… 202)

Kafka consumer lag-checking application for monitoring, written in Scala and Akka HTTP; a wrap around the Kafka consumer group command. Integrations with Cloudwatch and Datadog. Authentication recently added

  • .gitignore
  • .zappr.yaml
  • build.sbt
  • CHANGELOG.md
  • CONTRIBUTING.md
  • delivery.yaml
  • LICENSE
  • MAINTAINERS
  • README.md
  • Security.md

# Installation Guide

1. Get the code
git clone https://github.com/zalando-incubator/remora

Downloads the entire project code from GitHub to your computer.

cd remora

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -it --rm -p 9000:9000 -e KAFKA_ENDPOINT=127.0.0.1:9092 registry.opensource.zalan.do/buffalo/remora

Runs the built image as an actual container.

docker run -it --rm -p 9000:9000 -e KAFKA_ENDPOINT=127.0.0.1:9092 -e 'JAVA_OPTS=-Dlogback-root-level=INFO' registry.opensource.zalan.do/buffalo/remora

Runs the built image as an actual container.

docker-compose -f basic-example/docker-compose.yml up

Runs the command against the services defined in the compose file.

docker-compose -f basic-example/docker-compose.yml up --scale remora=0

Runs the command against the services defined in the compose file.

docker-compose -f basic-example/docker-compose.yml up --scale remora=3

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
$ pierone latest buffalo remora --url registry.opensource.zalan.do # requires `$ pip3 install stups-pierone`

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation