Twitch logging service inspired by justlog
Go to file
boring-nick b160f8452e
Add contributing guide and setup files (#16)
* Add contributing guide and setup files

* set the default db url to localhost

* minor clarifications

* update docs on installing from source


Co-authored-by: boring_nick <>
2023-09-09 15:48:10 +03:00
.github/workflows revert tags change 2023-06-09 23:36:46 +03:00
docs implement admin api 2023-06-22 20:56:26 +03:00
src implement capabilities reporting 2023-09-03 21:24:32 +03:00
web@b1b08e909f fix json stream and update web 2023-06-19 18:32:18 +03:00
.dockerignore Revert "cache available channel log dates" 2023-06-22 13:31:47 +03:00
.gitignore add docs 2023-06-10 14:39:06 +03:00
.gitmodules update frontend 2023-03-11 19:31:56 +02:00
Cargo.lock bump dependencies and clippy fixes 2023-08-30 22:37:48 +03:00
Cargo.toml bump dependencies and clippy fixes 2023-08-30 22:37:48 +03:00
Dockerfile optimize migrator 2023-06-09 09:04:59 +03:00 Add contributing guide and setup files (#16) 2023-09-09 15:48:10 +03:00
config.dist.json Add contributing guide and setup files (#16) 2023-09-09 15:48:10 +03:00 Add contributing guide and setup files (#16) 2023-09-09 15:48:10 +03:00



Rustlog is a Twitch logging service based on justlog. It provides the same web UI and API, but it utilizes Clickhouse for storage instead of text files.


Create a config.json file (see


version: "3.8"
    image: clickhouse/clickhouse-server:latest
    container_name: clickhouse
      - "./ch-data:/var/lib/clickhouse:rw"
      CLICKHOUSE_DB: "rustlog"
    restart: unless-stopped
    container_name: rustlog
      - 8025:8025 
      - "./config.json:/config.json"
      - clickhouse
    restart: unless-stopped

From source

  • Follow the Contributing excluding the last step
  • cargo build --release
  • The resulting binary will be at target/release/rustlog

Advantages over justlog

  • Significantly better storage efficiency (2x+ improvement) thanks to not duplicating log files and better compression (using ZSTD in Clickhouse)
  • Blazing fast log queries with response streaming and a highly performant IRC parser
  • Support for ndjson logs responses



  • rust
  • yarn
  • docker with docker-compose (optional, will need to set up Clickhouse manually without it)


  1. Clone the repository (make sure to include submodules!):
git clone --recursive

If you already cloned the repo without --recursive, you can initialize submodules with:

git submodule update --init --recursive
  1. Set up the database (Clickhouse):

This repository provides a docker-compose to quickly set up Clickhouse. You can use it with:

docker-compose -f up -d

Alternatively, you can install Clickhouse manually using the official guide.

  1. Create a config file

Copy config.dist.json to config.json and configure your database and twitch credentials. If you installed Clickhouse with Docker, the default database configuration works.

  1. Build the frontend:
cd web
yarn install
yarn build
cd ..
  1. Build and run rustlog:
cargo run

You can now access rustlog at http://localhost:8025.

Migrating from justlog