lazykiq

A rich terminal UI for Sidekiq.

• View Sidekiq processes and currently running jobs
• Explore Sidekiq queues and jobs
• Inspect job arguments and error backtraces
• View Sidekiq retries, scheduled, and dead jobs
• Analyze errors in dead and retry queues
• Check job execution metrics
• ... more to come!

Usage

Tip

Latest installation instructions for different platforms are available on the Lazykiq website.

Note

Lazykiq uses special glyphs in the UI; without a Nerd Font in your terminal some characters may render incorrectly.

You can download the latest release from the Releases page for your platform.

Alternatively, install the current development version with go install:

go install github.com/kpumuk/lazykiq/cmd/lazykiq@latest

Keys

• 1-8 - switch views
• j / k - navigate down / up (or Down / Up)
• h / l - navigate left / right (or Left / Right)
• Enter - view job details, Esc to close
• [ / ] - previous / next page
• { / } - switch interval on the dashboard or metrics
• / - filter job list (case-sensitive)
• q - quit

Redis

Connect to a specific Redis instance with:

lazykiq --redis redis://localhost:6379/0

Development

We use mise for development. Install tooling with:

mise install

Run all CI tasks with:

mise run ci

To update all dependencies:

mise run deps

Git hooks

Lefthook can be used to setup Git hooks:

lefthook install

This will ensure we do not push any dependencies with known vulnerabilities, and the code quality matches our standards.

Test environment

There is a test environment prepared in the demo/ directory. Simply start it with:

docker-compose up --build

This will:

• Start a Redis server
• Start Sidekiq servers for different Sidekiq versions with some demo jobs (with Web interface)

Sidekiq	Redis URL	Web Dashboard
7.3.x	redis://localhost:6379/0	http://localhost:9292
8.0.0	redis://localhost:6379/1	http://localhost:9293
8.1.0	redis://localhost:6379/2	http://localhost:9294

You can connect to a specific Sidekiq version using:

go run ./cmd/lazykiq --redis redis://localhost:6379/2

Website

The documentation website is built with Hugo. To run it locally:

mise run website-dev

Feedback

I’d love to hear your thoughts on this project. Feel free to drop a note!

• Twitter
• The Fediverse

License

MIT.