astrolabsoftware / fink-alert-simulator

Simulate alert streams for the Fink broker

Fink alert simulator

fink-alert-simulator is a package to inject alert data to Apache Kafka to feed brokers listening to Kafka streams. The main purposes are testing the broker and replaying historical alert data. This package belongs to the fink broker ecosystem.

Installation

Fork and/or clone the repo, and update your PYTHONPATH and PATH to use the tools:

# in your ~/.bash_profile
export FINK_ALERT_SIMULATOR=/path/to/fink-alert-simulator
export PYTHONPATH=$FINK_ALERT_SIMULATOR:$PYTHONPATH
export PATH=$FINK_ALERT_SIMULATOR/bin:$PATH

Usage

Simply use

fink_simulator [options] [-h]

Note that you would need to have access to a Kafka cluster to publish alerts, otherwise you can use the docker version for local tests (you would need docker-compose installed). Learn more on how to use fink-alert-simulator by following the dedicated tutorial.