https://github.com/mosquito-cr/tui-visualizer

https://github.com/mosquito-cr/tui-visualizer

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mosquito-cr/tui-visualizer
• Owner: mosquito-cr
• Created: 2022-04-13T16:40:48.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-26T20:05:04.000Z (10 months ago)
• Last Synced: 2024-05-06T00:04:49.896Z (8 months ago)
• Language: Crystal
• Size: 61.5 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# TUI Visualizer for Mosquito

This is an minimal implementation of a queue visualizer for [mosquito](https://github.com/mosquito-cr/mosquito). It is a [Text based User Interface (TUI)](https://github.com/robacarp/keimeno).



## Purpose

This repository is primarily an experiment on basic queue visualization. It

primarily serves as a testing ground for methods which need to be added to

mosquito core to facilitate this kind of work. In the mean time, it can also be

used to get some idea that things are happening in a deployed worker, and the

rate at which they are happening.

## Using the visualizer

Using the visualizer to query a running mosquito backend is straightforward.

This will increase the read-load on the backend slightly.

- Clone the visualizer and install shards:

```console

$ git clone [email protected]:mosquito-cr/tui_visualizer.git

$ cd tui_visualizer

$ shards install

```

- Provide REDIS_URL connection string as `REDIS_ENV` environment variable. If

  needed, the connection can be piped over [SSH with a

  tunnel](https://duckduckgo.com/?q=ssh+tunnel&ia=web). In a production

  environment, you'll need to provide your auth key here in this url (and

  perhaps an acl user as well).

```console

$ export REDIS_URL 'redis://localhost:6379/2'

```

- Boot the interface

```console

$ crystal run ./interface.cr

```

## Developing the visualizer

A utility script is provided to enqueue and execute some jobs, which is

convenient for working on the visualizer. Use `crystal run interactive_runner.cr`

to run it.