Skip to content

milonoir/rv

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rv

rv is a Redis data viewer application with a text-based user interface that runs in your terminal.

Note: rv is currently in development.

Features

  • Repeatedly SCAN keys or key patterns
  • Enable/disable scanners
  • Inspect keys matching SCAN configurations
  • Inspect data structures (single key-value pairs, lists, sets, sorted sets and hashes)

Usage

  1. go build from project root
  2. Create a config.toml (see example config)
  3. ./rv or rv.exe (optionally pass a config file argument, by default config.toml will be used)

Configuration

Besides setting up the connection to your Redis server, you can define an infinite number of scanners. Scanners are small workers in the background which repeatedly SCAN their defined pattern and report how many matching keys they found. You can then inspect these keys in detail.

First, you have to name your scanner. In the scanner list, scanners are ordered by name.

[scans.my_scanner]

Or you can use spaces in the name:

[scans."My Scanner"]

Next, define the pattern you want to scan. The one below will scan a single key since there are no wildcards characters (*) in the pattern:

pattern = "example:key"

To scan a range of keys, pattern could be something like:

pattern = "example:*"

Your patterns must match a single type of keys. Also, you have to tell the Redis type to rv:

type = "hash"

Finally, set the frequency of the scan:

interval = "20s"

To sum up, your scanner config now looks like this:

[scans."My Scanner"]
pattern = "example:*"
type = "hash"
interval = "20s"

This scanner will kick off a SCAN command in every 20 seconds and will look for hashes matching the example:* pattern.

Example minimum config

[redis]
server = "localhost:6379"

[scans.customers]
pattern = "customer:*"
type = "hash"
interval = "15s"

About

Redis data viewer

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages