kuguobing / alertz

Alerting Platform for real time and archived services.

fl-alertz is a light weight Quartz based Alerting Rule scheduling system which allows users to fetch metrics from data sources like Graphite, Opentsdb and run user defined rules on them for breaches.


===============
Getting Started
===============

1) Environment :Make sure you have git, mysql, sun-java6, maven installed
2) Clone alertz : [email protected]:Flipkart/alertz.git
3) create database 'alertz' ./db/recreate_db.sh alertz
4) Change DB username and password if required in src/main/resources/quartz.properties and src/main/resources/hibernate.cfg.xml
5) Compile project assembly : mvn clean compile
6) Start Service :mvn clean compile exec:java

===============
Look Around
===============

1) Go to http://localhost:8888/index.html, This is the starting page of Alertz Service. Read Through to get acquainted with the application.
1) Go to http://localhost:8888/getStarted.html, This page will help you create rules.
But before you create the rules, you need to provide some connection information about your data source (graphite/ tsdb) which you will use in your rule to pull data).

Do Http POST on http://localhost:8888/alertz/metricSources
{"name":"flo.graphite","sourceType":"GRAPHITE","sourceConnectionParams":[{"param":"graphitePort","value":"80"},{"param":"graphiteHost","value":"Graphite Host Name"}]}