Twitch logging service inspired by justlog
Go to file
boring_nick 5e986d2ac6 Revert "cache available channel log dates"
This reverts commit c2d34ff048.
2023-06-22 13:31:47 +03:00
.github/workflows revert tags change 2023-06-09 23:36:46 +03:00
docs Revert "cache available channel log dates" 2023-06-22 13:31:47 +03:00
src Revert "cache available channel log dates" 2023-06-22 13:31:47 +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 Revert "cache available channel log dates" 2023-06-22 13:31:47 +03:00
Cargo.toml Revert "cache available channel log dates" 2023-06-22 13:31:47 +03:00
Dockerfile optimize migrator 2023-06-09 09:04:59 +03:00
README.md update docs 2023-06-14 08:44:19 +03:00

README.md

Rustlog

Description

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.

Installation

Create a config.json file (see CONFIG.md)

Docker

version: "3.8"
  
services:
  clickhouse:
    image: clickhouse/clickhouse-server:latest
    container_name: clickhouse
    volumes:
      - "./ch-data:/var/lib/clickhouse:rw"
    environment:
      CLICKHOUSE_DB: "rustlog"
    restart: unless-stopped
        
  rustlog:
    image: ghcr.io/boring-nick/rustlog:master
    container_name: rustlog
    ports:
      - 8025:8025 
    volumes:
      - "./config.json:/config.json"
    depends_on: 
      - clickhouse
    restart: unless-stopped

From source

  • Set up Clickhouse
  • cargo install --locked --git https://github.com/boring-nick/rustlog
  • You can now run the rustlog binary

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

Migrating from justlog

See MIGRATION.md