Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/redisgrafana/grafana-redis-explorer

Redis Explorer for @grafana allows connecting to Redis Enterprise software clusters using REST API.
https://github.com/redisgrafana/grafana-redis-explorer

grafana grafana-datasource redis

Last synced: 7 days ago
JSON representation

Redis Explorer for @grafana allows connecting to Redis Enterprise software clusters using REST API.

Host: GitHub
URL: https://github.com/redisgrafana/grafana-redis-explorer
Owner: RedisGrafana
License: apache-2.0
Created: 2020-08-05T01:23:50.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-01-19T04:41:03.000Z (almost 3 years ago)
Last Synced: 2023-03-06T03:25:21.587Z (over 1 year ago)
Topics: grafana, grafana-datasource, redis
Language: TypeScript
Homepage: https://redisgrafana.github.io
Size: 3.72 MB
Stars: 7
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Redis Explorer plugin for Grafana

![Dashboard](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-explorer/master/src/img/overview.png)

[![Grafana 8](https://img.shields.io/badge/Grafana-8-orange)](https://www.grafana.com)
[![Redis Explorer plugin](https://img.shields.io/badge/dynamic/json?color=blue&label=Redis%20Explorer%20plugin&query=%24.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins%2Fredis-explorer-app)](https://grafana.com/grafana/plugins/redis-explorer-app)
![CI](https://github.com/RedisGrafana/grafana-redis-explorer/workflows/CI/badge.svg)
![Docker](https://github.com/RedisGrafana/grafana-redis-explorer/workflows/Docker/badge.svg)
[![codecov](https://codecov.io/gh/RedisGrafana/grafana-redis-explorer/branch/master/graph/badge.svg?token=15SIRGU8SX)](https://codecov.io/gh/RedisGrafana/grafana-redis-explorer)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/RedisGrafana/grafana-redis-explorer.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RedisGrafana/grafana-redis-explorer/context:javascript)

## Introduction

The Redis Explorer is a plugin for Grafana that connects to Redis Enterprise software clusters using REST API. It provides application pages to add [Redis Data Sources](https://grafana.com/grafana/plugins/redis-datasource/) for managed databases and dashboards to see cluster configuration.

### Demo

Demo is available on [demo.volkovlabs.io](https://demo.volkovlabs.io):

- [Redis Enterprise dashboard](https://demo.volkovlabs.io/d/I8EjnzOnz/redis-enterprise-overview?orgId=1)
- [Projects](https://demo.volkovlabs.io)

### Requirements

- **Grafana 8.0+** is required for Redis Explorer 2.X.
- **Grafana 7.1+** is required for Redis Explorer 1.X.

### Does Redis Explorer require anything special configured on the Redis Enterprise?

The Redis Explorer can connect to any Redis Enterprise software cluster version 5.4 and later. No unique configuration is required.

## Getting Started

Redis Expolorer can be installed from the Grafana Marketplace or use the `grafana-cli` tool to install from the command line:

```bash
grafana-cli plugins install redis-explorer-app
```

![Marketplace](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-explorer/master/src/img/grafana-marketplace.png)

For Docker instructions and installation without Internet access, follow the [Quickstart](https://redisgrafana.github.io/quickstart/) page.

### Open Grafana and enable Redis Explorer plugin

Open Grafana in your browser, enable Redis Explorer plugin, and configure Redis Enterprise Software Data Sources.

![Enable](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-explorer/master/src/img/enable.png)

### Redis Enterprise Software Data Source

Redis Enterprise Software Data Source is included in the Redis Explorer plugin and connects to Redis Enterprise software clusters using REST API. For detailed information, look at the [Configuration](https://redisgrafana.github.io/redis-explorer/re-software/configuration/) page.

![Datasource](https://raw.githubusercontent.com/RedisGrafana/grafana-redis-explorer/master/src/img/datasource.png)

## Documentation

Please look at the [Documentation](https://redisgrafana.github.io/redis-explorer/overview/) to learn more about the Redis Explorer plugin, Redis Enterprise Software data source, and provided dashboards.

## Development

[Developing Redis Explorer plugin](https://redisgrafana.github.io/development/redis-explorer/) page provides instructions on building the application and data source plugins.

Are you interested in the latest features and updates? Start nightly built [Docker image for Redis Explorer plugin](https://redisgrafana.github.io/development/images/).

## Feedback

We love to hear from users, developers, and the whole community interested in 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](https://github.com/RedisGrafana/grafana-redis-explorer/issues/new/choose).
- 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](https://github.com/RedisGrafana/grafana-redis-explorer/blob/master/LICENSE).