stscoundrel/benediction

Simple page view stats with Kotlin & Cassandra. POC.

Benediction

Simple Kotlin / Spring / Cassandra API for storing & serving page view data without tracking the users.

Proof of concept for personal use. Mainly stores event data & allows queries by projects & time intervals. As far as "tracking" portion is concerned, the data model includes user_identifier which may or may not be used. Benediction trusts that the calling client either uses GDRP approved identifier (=hash that can't be turned back to personal data).

Development

mvn clean && mvn spring-boot:run

Build

Build App Docker image:

docker-compose build

Setup Cassandra DB:

sh scripts/setup-db.sh

Run app & DB:

docker-compose up

Generate test data for queries

Should you wish to automatically populate your DB with event data, see Benediction Ritual

Whats in the name

A benediction is a short invocation for divine help, blessing and guidance. Divine help is what one might need should they wish to do analytics without GDPR acceptances.

benediction's Issues

Jar: make name predictable (=non-versioned) for Dockerfile

Currently outputs some benediction-0-0-1-SNAPSHOT monstrosity. Lets make it simple benediction.jar or something like that, easier to refer in the Dockerfile.

Add queries by project & time

Most use cases should be governed by queries of:

• Which project
• What time range

Add repo/service methods for those and expose via endpoint.

Setup Cassandra for Spring

Running via docker-compose causes Cassandra connection issues

What works:

• Running dockerized Cassandra DB
• Running the Spring app separately via `mvn clean && mvn spring-boot:run

What doesn't work:

• Running whole thing with docker-compose up
• Trying to use API from localhost:8080/api

Judging by the partially cryptic error, its probably question of Cassandra credentials the app tries to use. As it is currently using localhost, it probably gets lost in docker-verse.

What could work:

• Populate application.properties from env (as we'd anyway do eventually, they're hardcoded for local now)
• Feed env via docker-compose
• Use host.docker.internal etc instead of localhost for Cassandra connections.

Add docker based Cassandra setup