README.md

Insulator 2

A tool for devs to debug Kafka based applications and services

Installation

Download the artifact for your operative system from the last release.

Supported OSs:

• MacOS
• Windows 10
• Debian/Ubuntu

Dev

Required tools

• Volta to install the pinned version of yarn and node.
• Rust rust is required to build the tauri backend

Setup on Ubuntu/Debian

Some libraries are required on debian in order to build

sudo apt update
sudo apt install libwebkit2gtk-4.0-dev \
    build-essential \
    curl \
    wget \
    libssl-dev \
    libgtk-3-dev \
    libayatana-appindicator3-dev \
    librsvg2-dev \
    libsasl2-dev \
    cmake

Setup MacOS

Requirements to compile on mac os can be installed with brew

brew install cmake

Setup Windows

Before running the build make sure the following executables are installed and available in env

• Perl
• cmake

Note: Use powershell to run the build commands

Run in dev mode

yarn
yarn tauri dev

Run tests with

yarn test

Spin up a local kafka cluster (RedPanda) for testing

docker run -d --name=redpanda-1 --rm \
    -p 8081:8081 \
    -p 9092:9092 \
    -p 9644:9644 \
    docker.vectorized.io/vectorized/redpanda:latest \
    redpanda start \
    --overprovisioned \
    --smp 1  \
    --memory 1G \
    --reserve-memory 0M \
    --node-id 0 \
    --check=false

The cluster endpoint and the schema registry endpoint to configure in insulator are respectively: 127.0.0.1:9092 and http://127.0.0.1:8081.

Serve documentation with Jekyll

cd docs
bundle exec jekyll serve

Build

To build the application locally run

# Mac OS
yarn tauri build -b dmg
# Windows
yarn tauri build -b msi
# Linux
yarn tauri build -b deb appimage

Logging

Use RUST_LOG="insulator2=debug" to get debug logs in console for the insulator app only.
Use RUST_LOG=debug to enable debug log in any component (kafkard may be very noisy).

Release

Once happy with the latest main branch artifact, release running yarn release. (need the GH_TOKEN)

Recommended IDE Setup

• VS Code + Tauri + rust-analyzer

Credits

• Tauri
• Mantine
• rust-rdkafka