Sancer / auditlog

Introduction

This repository is an example of how we can collect changes on our models and query those changes through an api.

For large volumes of data it is better to use a persistence system designed for this use case:

• If you usually look at the logs, Elasticseach with a combination of tier warm for daily writes and another freeze for storage and long term reads for example.
• If data is consumed very infrequently and queries do aggregations/metrics, BigQuery is a good choice.

Index

• Introduction
• Index
• Setup local
  • Copy envfile
  • Dependencies
  • Prepare database
  • Create superuser
  • Start local web server
• Play
• Containers
  • Docker
    • Build
  • Docker Compose
    • Build
    • Start all
    • Run migrations
    • Run tests

Setup local

Copy envfile

cp .env.example .env

Dependencies

pip install -r requirements.txt

Prepare database

python manage.py migrate 

Create superuser

Follow the instructions in the shell

python manage.py createsuperuser 

Start local web server

python manage.py runserver 

Play

For more information about the api, please refer to the automatically generated documentation.

• Open API
• Swagger

Containers

Docker

Build

docker build -t auditlog .

Docker Compose

Build

docker compose build

Start all

docker compose build

Run migrations

docker-compose exec api python manage.py migrate --noinput

Run tests

docker compose -f docker-compose.yml -f docker-compose.test.yml run api