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
Note: Use powershell to run the build commands
Run in dev mode
yarn
yarn tauri devSpin up a local kafka (RedPanda) cluster for testing
docker run -d --pull=always --name=redpanda-1 --rm \
-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=falseBuild
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 appimageLogging
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
Credits
Todo
- Use semantic release version in the artifact
- Windows build
- Use a single file for all the configurations
- Make font size configurable in record list
- Encrypt config file