timefusion

(โ˜… 185)

A timeseries database created for events, logs, traces and metrics. Speaks the postgres dialect, and stores data in s3 via delta lake protocol

  • .dockerignore
  • .env.example
  • .env.minio
  • .env.test
  • .gitignore
  • Cargo.lock
  • Cargo.toml
  • CONTRIBUTING.md
  • DELTA_CONFIG.md
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • Makefile
  • README.md
  • RUNBOOK.md
  • rust-toolchain.toml
  • rustfmt.toml

# Installation Guide

1. Get the code
git clone https://github.com/monoscope-tech/timefusion

Downloads the entire project code from GitHub to your computer.

cd timefusion

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install llvm@15 # provides /opt/homebrew/opt/llvm@15/bin/ld64.lld

Installs the pre-built package via Homebrew โ€” no source build required.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker run -d -p 5432:5432 \

Runs the built image as an actual container.

docker compose up -d minio createbucket

Builds and starts all defined containers (server, database, etc.) at once, in the background.

make test-e2e # end-to-end (Docker required; testcontainers MinIO)

Compiles the code based on the generated build configuration to produce an executable.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

cargo nextest run <substring> # one test or one .slt file, e.g. `dedup_compaction`

Type this command into your terminal and run it.

cargo nextest run --lib # unit tests only

Type this command into your terminal and run it.

RUST_LOG=debug cargo nextest run --no-capture # with debug logging

Type this command into your terminal and run it.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make test # the whole suite in one parallel run (~74s)

Compiles the code based on the generated build configuration to produce an executable.

make test-e2e # end-to-end (Docker required; testcontainers MinIO)

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation