Welcome

CronEye is an open source tool to gain obervability into your APScheduler based jobs.

Get started

Pre-requisites

1. Add a .env file in db folder based on the template.
2. Add a .env file in api folder based on the template.
   • LISTENER_TOKEN variable needs to be used by your application as a Token based authentication header to call the listener APIs.
   • ADMIN_EMAIL, ADMIN_PASSWORD can be used to log into the CronEye application.
   • Ensure that postgres related variables are sames as the ones given in the previous step.
3. Add a .flaskenv file in api folder based on the template.
4. Update backend URLs in config.

Use docker

Run docker compose for running databse, api and the client containers

docker-compose build && docker-compose up -d

Use kubernetes

Fill the host fields with appropriate values and ensure Kustomize before deploying

kubectl apply -k ./k8s/

Integrate CronEye with your service

Add event api calls to your code so that appropriate payload is sent based on the event generated. Docs for the event listener api can be found at here