mirror of https://github.com/boring-nick/rustlog
b160f8452e
* 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 <boring-nick@users.noreply.github.com> |
||
|---|---|---|
| .github/workflows | ||
| docs | ||
| src | ||
| web@b1b08e909f | ||
| .dockerignore | ||
| .gitignore | ||
| .gitmodules | ||
| Cargo.lock | ||
| Cargo.toml | ||
| Dockerfile | ||
| README.md | ||
| config.dist.json | ||
| docker-compose.dev.yml | ||
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
- 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
Contributing
Requirements:
- rust
- yarn
- docker with docker-compose (optional, will need to set up Clickhouse manually without it)
Steps:
- Clone the repository (make sure to include submodules!):
git clone --recursive https://github.com/boring-nick/rustlog
If you already cloned the repo without --recursive, you can initialize submodules with:
git submodule update --init --recursive
- Set up the database (Clickhouse):
This repository provides a docker-compose to quickly set up Clickhouse. You can use it with:
docker-compose -f docker-compose.dev.yml up -d
Alternatively, you can install Clickhouse manually using the official guide.
- 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.
- Build the frontend:
cd web
yarn install
yarn build
cd ..
- Build and run rustlog:
cargo run
You can now access rustlog at http://localhost:8025.
Migrating from justlog
See MIGRATION.md