Skip to content

Commit

Permalink
Update README and Docker scripts (#43)
Browse files Browse the repository at this point in the history
* Update Docker scripts

* Add images

* Update README.md

* Update README.md

* Update README.md

* Update README.md
  • Loading branch information
mikhail-vl authored Feb 8, 2021
1 parent 5dfc045 commit 94c3696
Show file tree
Hide file tree
Showing 10 changed files with 60 additions and 12 deletions.
68 changes: 57 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
## Summary

- [**Introduction**](#introduction)
- [**Redis CLI panel**](#redis-cli-panel)
- [**Dashboards**](#dashboards)
- [**Custom panels**](#custom-panels)
- [**Getting Started**](#getting-started)
- [**Feedback**](#feedback)
- [**Contributing**](#contributing)
Expand All @@ -22,25 +23,57 @@

### What is the Redis Application for Grafana?

The Redis Application, is a plug-in for Grafana that provides custom panels for [Redis Data Source](https://grafana.com/grafana/plugins/redis-datasource):
The Redis Application, is a plug-in for Grafana that provides application pages and custom panels for [Redis Data Source](https://grafana.com/grafana/plugins/redis-datasource):

- Command line interface (CLI) panel
- Latency panel
- [**Command line interface (CLI)**](#redis-cli-panel)
- [**Command Latency (graph and table)**](#latency-panel)
- [**Keys consuming a lot of memory**](#keys-consuming-a-lot-of-memory-panel)
- [**Redis Gears**](#redis-gears-panel)

### What Grafana version is supported?

Only Grafana 7.0 and later with a new plug-in platform supported.
Only Grafana 7.1 and later with a new plug-in platform supported.

### How to build Application
## Dashboards

To learn how to build Redis Application plug-in and register in the new or existing Grafana please take a look at [BUILD](https://github.com/RedisGrafana/grafana-redis-app/blob/master/BUILD.md) instructions.
Redis application plug-in includes Redis Overview, CLI and RedisGears dashboards. All dashboard are available from Application's icon in the left side menu.

![Redis-CLI-Dashboards](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-cli-dashboard.png)

Redis CLI dashboard combines Redis CLI with streaming panels to observe Redis database in real-time.

## Custom Panels

## Redis CLI panel

This panel provides [Redis command line interface](https://redis.io/topics/rediscli) that allows to send commands to Redis, and read the replies sent by the server, directly from the Grafana.

![CLI](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-cli-panel.png)

## Latency panel

Redis is often used in the context of demanding use cases, where it serves a large number of queries per second per instance, and at the same time, there are very strict latency requirements both for the average response time and for the worst case latency.

![CLI](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-latency-panel-chart.png)

This panel provides commands's latency based on [INFO COMMANDSTATS](https://redis.io/commands/info). Information is provide as chart and table.

![CLI](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-latency-panel-table.png)

## Keys consuming a lot of memory panel

Do you want to know which keys consume a lot of memory in your Redis database? This panel is based on [SCAN](https://redis.io/commands/scan) and [MEMORY USAGE](https://redis.io/commands/memory-usage) commands to scan keys and sort results based on memory usage in the table format.

![CLI](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-keys-panel.png)

Please use this command in OFF-PEAK as it cause latency increase. Interval and count for SCAN command is configurable to keep latency under control.

## Redis Gears panel

[RedisGears](https://oss.redislabs.com/redisgears/) is a dynamic framework that enables developers to write and execute functions that implement data flows in Redis, while abstracting away the data’s distribution and deployment. This panel support Python syntax and allows to execute functions in blocking and non-blocking mode.

![CLI](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-app/master/src/img/redis-gears-dashboard.png)

## Getting Started

### Install using `grafana-cli`
Expand All @@ -57,23 +90,36 @@ grafana-cli plugins install redis-app
docker run -d -p 3000:3000 --name=grafana -e "GF_INSTALL_PLUGINS=redis-app" grafana/grafana
```

### Run using `docker` the nightly build (UNSTABLE)

Supported platforms are:

- linux/amd64
- linux/arm64
- linux/arm

```bash
docker run -d -p 3000:3000 --name=redis-app ghcr.io/redisgrafana/redis-app:latest
```

### Run using `docker-compose` for development

Application plug-in and Redis Data Source have to be built following [BUILD](https://github.com/RedisGrafana/grafana-redis-app/blob/master/BUILD.md) instructions before starting using `docker-compose-dev.yml` file.
Application plug-in and Redis Data Source have to be built following [BUILD](https://github.com/RedisGrafana/grafana-redis-app/blob/master/BUILD.md) instructions before starting.

Project provides `docker-compose-dev.yml` to start Redis with Redis Labs modules and Grafana 7.0.
Project provides `docker-compose/dev.yml` to start Redis with Redis Labs modules and Grafana 7.0.

```bash
docker-compose -f docker-compose-dev.yml up
docker-compose -f docker-compose/dev.yml up
```

### Open Grafana
### Open Grafana and enable Redis Application plug-in

Open Grafana in your browser, enable Redis Application plug-in and configure Redis Data Sources.

## Learn more

- [Real-time observability with Redis and Grafana](https://grafana.com/go/observabilitycon/real-time-observability-with-redis-and-grafana/)
- [Redis Data Source](https://grafana.com/grafana/plugins/redis-datasource)

## Feedback

Expand Down
File renamed without changes.
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
"dev": "grafana-toolkit plugin:dev",
"format": "prettier --write \"**\"",
"start": "docker-compose up",
"start:dev": "docker-compose -f docker-compose-dev.yml up",
"start:dev": "docker-compose -f docker-compose/dev.yml up",
"stop": "docker-compose down",
"stop:dev": "docker-compose -f docker-compose/dev.yml down",
"test": "grafana-toolkit plugin:test --coverage",
"watch": "grafana-toolkit plugin:dev --watch"
},
Expand Down
Binary file modified src/img/redis-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/redis-cli-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/img/redis-cli-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/redis-gears-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/redis-keys-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/redis-latency-panel-graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/img/redis-latency-panel-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 94c3696

Please sign in to comment.