diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c744474 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Revenue Discrepency Monitor + +The objective of this cron script is to collect revenue related statistics (Views, Clicks, Leads) from MySql, and Druid datasources, and write those into InfluxDB so that we can eventually compare them - check for discrepancies. +Once the data is in InfluxDB, we can setup dashboards, alerting etc. from Granfana, using InfluxDB as its datasource. + +## Pre-requisites +1. docker, docker-compose +2. If running without docker, then we need Go and a few dependencies: +- `github.com/go-sql-driver/mysql` +- `github.com/shunfei/godruid` +- `github.com/influxdata/influxdb1-client/v2` + +## Build and Run Locally +> If running in Dev, uncomment the env_file (*.dev) in the docker-compose.yaml, and comment out the first one (prod). +- Build + Run: `docker-compose build --no-cache && docker-compose up --force-recreate` +- Only Run: `docker-compose up --force-recreate` + +### Run tests +- Get the assert dependency: `go get -d github.com/stretchr/testify/assert` +- Run tests: `go test ./src/` + +## Required Env Vars +If being run manually (docker-compose), then are set imported in the docker-compose file under "env_file". +If being run from k8s, then these are set in the k8s ConfigMap object. +``` +JOB_NAME +TZ +WINDOW_SIZE +MYSQL_HOST +MYSQL_USER +MYSQL_PASSWORD +MYSQL_DB +DRUID_HOST +INFLUX_HOST +INFLUX_PORT +INFLUX_DB +INFLUX_RP +INFLUX_MEASUREMENT +DVO_API_CHECKIN_ENDPOINT +``` |