KobiMorad / grafana-redis-datasource

Redis Data Source for Grafana

Redis Data Source for Grafana

Summary

• Introduction
• Getting Started
• Supported commands
• Template variables
• Learn more
• Feedback
• Contributing
• License

Introduction

What is the Redis Data Source for Grafana?

The Redis Data Source for Grafana is a plug-in that allows users to connect to the Redis database and build dashboards in Grafana to easily monitor Redis and application data. It provides an out-of-the-box predefined dashboard, but also lets you build customized dashboards tuned to your specific needs.

What Grafana version is supported?

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

Does this Data Source require anything special configured on the Redis databases?

Data Source can connect to any Redis database. No special configuration is required.

Does this Data Source support Redis Cluster and Sentinel?

Redis Cluster and Sentinel supported since version 1.2.

Does this Data Source support Redis modules?

Data Source supports:

• RedisTimeSeries: TS.GET, TS.INFO, TS.MRANGE, TS.QUERYINDEX, TS.RANGE
• RedisGears: RG.DUMPREGISTRATIONS, RG.PYEXECUTE, RG.PYSTATS
• RedisSearch: FT.INFO
• RedisGraph: GRAPH.QUERY, GRAPH.SLOWLOG

How to connect to Redis logical database

Please use /db-number or ?db=db-number in the Data Source URL to specify the database number as defined in the Schema.

redis://redis-server:6379/0

How to build Data Source

To learn how to build Redis Data Source from scratch and register in new or existing Grafana please take a look at BUILD instructions.

Getting Started

Install using grafana-cli

Use the grafana-cli tool to install from the commandline:

grafana-cli plugins install redis-datasource

Run using docker

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

Run using docker-compose

Project provides docker-compose.yml to start Redis with all Redis Labs modules and Grafana.

docker-compose up

Open Grafana in your browser and configure Redis Data Source. You can add as many data sources as you want to support multiple Redis databases.

There are certain settings that can be configured based on your own setup:

• Grafana port
• Data Source URL

Configure Grafana port in docker-compose.yml

If standard port 3000 is occupied by another application update the port to bind Grafana to

    ports:
      - '3000:3000'

Configure Data Source URL in provisioning/datasources/redis.yaml

If Redis is running and listening on localhost:6379 no changes are required

    url: redis://localhost:6379

If Redis is running as Docker container on MacOS, please update host to host.docker.internal

    url: redis://host.docker.internal:6379

If Redis is running as Docker container on Linux, please update host to redis

    url: redis://redis:6379

Run using docker-compose for development

Data Source have to be built following BUILD instructions before starting using docker-compose/dev.yml file.

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

Supported commands

Data Source supports various Redis commands using custom components and provides a unified interface to query any command.

Template variables

Template variables can query any command and use other variables as parameters.

Learn more

• Introducing the Redis Data Source Plug-in for Grafana
• How to Use the New Redis Data Source for Grafana Plug-in
• 3 Real-Life Apps Built with Redis Data Source for Grafana
• Real-time observability with Redis and Grafana

Feedback

We love to hear from users, developers and the whole community interested by this plugin. These are various ways to get in touch with us:

• Ask a question, request a new feature and file a bug with GitHub issues.
• Star the repository to show your support.

Contributing

• Fork the repository.
• Find an issue to work on and submit a pull request.
• Could not find an issue? Look for documentation, bugs, typos, and missing features.

License

• Apache License Version 2.0, see LICENSE.