Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/obukhov/redis-inventory
CLI tool to see redis memory usage by keys in hierarchical way. Think of disk inventory but for redis.
https://github.com/obukhov/redis-inventory
devops infrastructure redis tools usage
Last synced: about 1 month ago
JSON representation
CLI tool to see redis memory usage by keys in hierarchical way. Think of disk inventory but for redis.
- Host: GitHub
- URL: https://github.com/obukhov/redis-inventory
- Owner: obukhov
- License: mit
- Created: 2021-04-15T20:55:13.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-19T14:12:51.000Z (7 months ago)
- Last Synced: 2024-08-04T01:10:15.927Z (5 months ago)
- Topics: devops, infrastructure, redis, tools, usage
- Language: Go
- Homepage:
- Size: 6.73 MB
- Stars: 226
- Watchers: 2
- Forks: 29
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Redis Inventory
===============
[](https://travis-ci.com/obukhov/redis-inventory)
[](https://coveralls.io/github/obukhov/redis-inventory?branch=master)
[](https://goreportcard.com/report/github.com/obukhov/redis-inventory)
[](https://hub.docker.com/repository/docker/dclg/redis-inventory)
Redis inventory is a tool to analyse Redis memory usage by key patterns and displaying it hierarchically. The name is
inspired by "Disk Inventory X" tool doing similar analysis for disk usage.
[Blog post explaining how it works](https://blog.dclg.net/redis-inventory-analyzing-memory-usage-in-redis-by-key-pattern)
Example:
```bash
$ redis-inventory inventory --output=table --output-params="padSpaces=2&depth=2&human=1"
```
`` can be provided in [one of two formats](docs/redis-url.md)
Outputs it as a nice table
```bash
12:39PM INF Start scanning
+---------------------+----------+-----------+
| KEY | BYTESIZE | KEYSCOUNT |
+---------------------+----------+-----------+
| dev: | 2.9M | 4,555 |
| article: | 413.7K | 616 |
| blogpost: | 408.5K | 630 |
| collections: | 426.7K | 627 |
| events: | 391.2K | 614 |
| friends:foobar: | 501.1K | 745 |
| news: | 388.8K | 593 |
| user: | 481K | 730 |
| prod: | 2.9M | 4,531 |
| article: | 397.1K | 614 |
| blogpost: | 409.4K | 627 |
| collections: | 374.7K | 560 |
| events: | 384.2K | 588 |
| friends:foobar: | 503K | 755 |
| news: | 407.9K | 618 |
| user: | 492.3K | 769 |
+---------------------+----------+-----------+
12:39PM INF Finish scanning
```
It also can render sunburst diagrams to visualize it:
```bash
$ redis-inventory inventory --output=chart --maxChildren=100
```
[](docs/images/diagram.png)
Read more about [usage](docs/usage.md)
## Installation
There are two ways to install the tool:
- use docker image
- build binary from sources
### Using docker
To run the tool from a docker image, run the command:
```bash
docker run --rm dclg/redis-inventory inventory
```
Read more about [installation](docs/installation.md)
### Kudos
- [Radix](https://github.com/mediocregopher/radix) — Redis client for Go,
- [Cobra](https://github.com/spf13/cobra) — CLI applications framework,
- [Go-Pretty](https://github.com/jedib0t/go-pretty) — tools to render tables and progress bars,
- [AnyChart](https://www.anychart.com/) — beautiful sunburst diagrams.