🔬 Rockspector

A lightweight inspector for RocksDB databases.

Rockspector provides:

• Interactive web UI
• Browse SST files
• Browse WAL files
• View LSM tree
• Inspect MANIFEST state
• Scan keys
• Explore RocksDB metadata

Internally it wraps the standard rocksdb_ldb and rocksdb_sst_dump tools.

Requirements

Install rocksdb:

brew install rocksdb

Installation

npm i -g rockspector

Usage

Open any RocksDB database:

rockspector /path/to/db

Or pass a custom decoder:

rockspector /path/to/db --decoder example-decoder.mjs

Rockspector will start a local web server and print something like:

Rockspector: http://localhost:51342

Open the URL in your browser.

The server automatically chooses a free port, so multiple databases can be inspected simultaneously.

Features

• Database summary
• File browser
• SST properties
• SST contents
• WAL viewer
• MANIFEST viewer
• LSM tree visualization
• Column family support
• Key scanning

Library

Rockspector can also be used as a JavaScript library.

import { RocksDB } from "./rocksdb.js";

const db = new RocksDB("/path/to/db");

console.log(await db.summary());
console.log(await db.columnFamilies());
console.log(await db.keys());
console.log(await db.sstInfo("000123.sst"));