ALeRCE Alert Processing Framework.
Project description
Alert Processing Framework (apf)
apf is a framework developed to create a dockerized pipeline to process an alert stream, that can be easily be deployed in a local machine or distributed using Kubernetes.
First developed to process ZTF data it is capable to be used for any stream/static data processing pipeline.
Installing apf
apf installation can be done with pip
pip install apf_base
This will install the apf python package and apf command line script.
apf design
apf is based on steps conected through Apache Kafka topics.
Each step is composed by a consumer and is isolated from other steps inside a docker container.
When running, the step calls the execute() method for each message consumed. A step can have multiple producers and databases back-ends plugins that can be accessed inside the execute method to have a more complex logic.
This generic step greatly reduce the development of each component of the pipeline and make it easier to test each component separately.
apf features
- Automatic Metric Sender (KafkaMetrics)
- Automatic Code Generation (
apf new-step <step_name>
) - Multiple Consumer Plugins:
- Kafka
- AVRO
- CSV
- JSON
- Producers:
- Kafka
- CSV
- Metrics:
- Kafka
apf Quickstart
A quick-start guide to create a new step can be found here.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for apf_base-1.0.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6671cc2016a2d628be9c5cd96a6f2ae81c63b7f7410778e442f7af8a80342ac1 |
|
MD5 | 5ba0b0143dda742902e3e33f33860b76 |
|
BLAKE2b-256 | f5bca062901c9828403e4aae79db94536fa9aac9b47855cb503749fd0016981a |