Skip to content

Quickstart

Architecture

The Redis plugins for Grafana consists of Redis Data Source, Redis Application and Redis Explorer.

Architecture

Grafana Marketplace

In Grafana 8+ Redis Plugins can be installed from the Grafana Marketplace.

Grafana Marketplace

Install using grafana-cli

Use the grafana-cli tool to install from the command line:

Redis Application plugin and Redis Data Source

grafana-cli plugins install redis-app

Redis Explorer plugin

Dependencies

Redis Application plugin and Redis Data Source will be auto-installed as dependencies.

grafana-cli plugins install redis-explorer-app

Run using Docker

Login to Grafana

The Default username and password to login to Grafana are admin/admin.

Run a container in the background

Use docker-compose up -d option to run a container in the background and print container ID.

Redis Application plugin and Redis Data Source

docker run -p 3000:3000 --name=grafana -e "GF_INSTALL_PLUGINS=redis-app" grafana/grafana

Redis Explorer

docker run -p 3000:3000 --name=grafana -e "GF_INSTALL_PLUGINS=redis-explorer-app" grafana/grafana

Docker Images

Are you interested in the latest features and updates? Start nightly built Docker image.

Install without Internet access

Redis Data Source

  • Download the latest version from the Releases.
  • Unzip an archive to the plugins/ folder for local Grafana installation or Docker's volume.
  • Check permissions for the redis-datasource binaries:

Permissions

Redis Data Source binaries should have executable permissions for Grafana to execute them.

% ls -lrt redis-datasource*
-rwxr-xr-x  1 mikhail  staff  13077504 Mar 20 11:20 redis-datasource_windows_amd64.exe
-rwxr-xr-x  1 mikhail  staff  11796480 Mar 20 11:20 redis-datasource_linux_arm64
-rwxr-xr-x  1 mikhail  staff  10682368 Mar 20 11:20 redis-datasource_linux_arm
-rwxr-xr-x  1 mikhail  staff  12644352 Mar 20 11:20 redis-datasource_linux_amd64
-rwxr-xr-x  1 mikhail  staff  13806272 Mar 20 11:20 redis-datasource_darwin_amd64
  • Check that plugin was registered:
t=2020-07-01T06:03:38+0000 lvl=info msg="Starting plugin search" logger=plugins
t=2020-07-01T06:03:38+0000 lvl=warn msg="Running an unsigned backend plugin" logger=plugins pluginID=redis-datasource pluginDir=/var/lib/grafana/plugins/redis-datasource
t=2020-07-01T06:03:38+0000 lvl=info msg="Registering plugin" logger=plugins name=redis-datasource
t=2020-07-01T06:03:38+0000 lvl=info msg="HTTP Server Listen" logger=http.server address=[::]:3000 protocol=http subUrl= socket=

Redis Application plugin

  • Download the latest version from the Releases.
  • Unzip an archive to the plugins/ folder for local Grafana installation or Docker's volume.

Redis Explorer plugin

Dependencies

Redis Explorer plugin requires Redis Data Source and Redis Application plugin.

  • Download the latest version from the Releases.
  • Unzip an archive to the plugins/ folder for local Grafana installation or Docker's volume.

Configuration

Redis Data Source

The Configuration page explains how to connect the data source to the Redis database.

Redis Application plugin

The Overview page explains how to enable plugin and manage Redis Data Sources.

Redis Explorer plugin

The Overview page explains how to enable plugin and manage Redis Enterprise Software Data Sources.

Learn more

Please look at Learn More page to read recent blog posts and view video presentations from the conferences.

Back to top