|
3 | 3 |  |
4 | 4 |
|
5 | 5 | [](https://www.grafana.com) |
6 | | -[](https://github.com/mediocregopher/radix) |
7 | 6 | [](https://redislabs.com/redis-enterprise/) |
8 | 7 | [](https://grafana.com/grafana/plugins/redis-datasource) |
9 | 8 | [](https://grafana.com/grafana/plugins/redis-app) |
|
16 | 15 | - [**Introduction**](#introduction) |
17 | 16 | - [**Getting Started**](#getting-started) |
18 | 17 | - [**Supported commands**](#supported-commands) |
19 | | -- [**Template variables**](#template-variables) |
20 | 18 | - [**Learn more**](#learn-more) |
21 | 19 | - [**Feedback**](#feedback) |
22 | 20 | - [**Contributing**](#contributing) |
23 | 21 | - [**License**](#license) |
24 | 22 |
|
25 | 23 | ## Introduction |
26 | 24 |
|
27 | | -### What is the Redis Data Source for Grafana? |
| 25 | +The Redis Data Source for Grafana is a plug-in that allows users to connect to any Redis database On-Premises or in the Cloud. It provides an out-of-the-box predefined dashboards, but also lets you build customized dashboards to easily monitor Redis and application data. |
28 | 26 |
|
29 | | -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. |
| 27 | +### Requirements |
30 | 28 |
|
31 | | -### What Grafana version is supported? |
| 29 | +Only **Grafana 7.1+** with a new Backend plug-in platform supports Redis plug-ins. |
32 | 30 |
|
33 | | -Grafana 7.1 and later with a new plug-in platform supported. |
| 31 | +### Redis Application plug-in |
34 | 32 |
|
35 | | -### Does this Data Source require anything special configured on the Redis databases? |
36 | | - |
37 | | -Data Source can connect to any Redis database. No special configuration is required. |
38 | | - |
39 | | -### Does this Data Source support [Redis Cluster](https://redis.io/topics/cluster-tutorial) and [Sentinel](https://redis.io/topics/sentinel)? |
40 | | - |
41 | | -Redis Cluster and Sentinel supported since version 1.2. |
42 | | - |
43 | | -### Does this Data Source support Redis modules? |
44 | | - |
45 | | -Data Source supports: |
46 | | - |
47 | | -- [RedisTimeSeries](https://oss.redislabs.com/redistimeseries/): TS.GET, TS.INFO, TS.MRANGE, TS.QUERYINDEX, TS.RANGE |
48 | | -- [RedisGears](https://oss.redislabs.com/redisgears/): RG.DUMPREGISTRATIONS, RG.PYEXECUTE, RG.PYSTATS |
49 | | -- [RedisSearch](https://oss.redislabs.com/redisearch/): FT.INFO |
50 | | -- [RedisGraph](https://oss.redislabs.com/redisgraph/): GRAPH.QUERY, GRAPH.SLOWLOG |
51 | | - |
52 | | -### How to connect to Redis logical database |
53 | | - |
54 | | -Please use `/db-number` or `?db=db-number` in the Data Source URL to specify the database number as defined in the [Schema](https://www.iana.org/assignments/uri-schemes/prov/redis). |
55 | | - |
56 | | -``` |
57 | | -redis://redis-server:6379/0 |
58 | | -``` |
59 | | - |
60 | | -### How to build Data Source |
61 | | - |
62 | | -To learn how to build Redis Data Source from scratch and register in new or existing Grafana please take a look at [BUILD](https://github.com/RedisGrafana/grafana-redis-datasource/blob/master/BUILD.md) instructions. |
| 33 | +You can add as many data sources as you want to support multiple Redis databases. [Redis Application plug-in](https://grafana.com/grafana/plugins/redis-app) helps to manage multiple Redis Data Sources and provides Custom panels. |
63 | 34 |
|
64 | 35 | ## Getting Started |
65 | 36 |
|
66 | | -### Install using `grafana-cli` |
67 | | - |
68 | 37 | Use the `grafana-cli` tool to install from the commandline: |
69 | 38 |
|
70 | 39 | ```bash |
71 | 40 | grafana-cli plugins install redis-datasource |
72 | 41 | ``` |
73 | 42 |
|
74 | | -### Run using `docker` |
75 | | - |
76 | | -```bash |
77 | | -docker run -d -p 3000:3000 --name=grafana -e "GF_INSTALL_PLUGINS=redis-datasource" grafana/grafana |
78 | | -``` |
| 43 | +For Docker instructions and installation without Internet access follow [Quickstart](https://redisgrafana.github.io/quickstart/) page. |
79 | 44 |
|
80 | | -### Run using `docker-compose` |
| 45 | +### Configuration |
81 | 46 |
|
82 | | -Project provides `docker-compose.yml` to start Redis with all Redis Labs modules and Grafana. |
83 | | - |
84 | | -```bash |
85 | | -docker-compose up |
86 | | -``` |
87 | | - |
88 | | -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. |
| 47 | +Data Source allows to connect to Redis using TCP port, Unix socket, Cluster, Sentinel and supports SSL/TLS authentication. For detailed information take a look at [Configuration](https://redisgrafana.github.io/redis-datasource/configuration/) page. |
89 | 48 |
|
90 | 49 |  |
91 | 50 |
|
92 | | -There are certain settings that can be configured based on your own setup: |
93 | | - |
94 | | -- Grafana port |
95 | | -- Data Source URL |
96 | | - |
97 | | -#### Configure Grafana port in `docker-compose.yml` |
| 51 | +### Development |
98 | 52 |
|
99 | | -If standard port 3000 is occupied by another application update the port to bind Grafana to |
| 53 | +[Developing Redis Data Source](https://redisgrafana.github.io/development/redis-datasource/) page provides instructions on how to build data source. |
100 | 54 |
|
101 | | -``` |
102 | | - ports: |
103 | | - - '3000:3000' |
104 | | -``` |
105 | | - |
106 | | -#### Configure Data Source URL in `provisioning/datasources/redis.yaml` |
107 | | - |
108 | | -If Redis is running and listening on localhost:6379 no changes are required |
109 | | - |
110 | | -``` |
111 | | - url: redis://localhost:6379 |
112 | | -``` |
113 | | - |
114 | | -If Redis is running as Docker container on MacOS, please update host to `host.docker.internal` |
115 | | - |
116 | | -``` |
117 | | - url: redis://host.docker.internal:6379 |
118 | | -``` |
119 | | - |
120 | | -If Redis is running as Docker container on Linux, please update host to `redis` |
121 | | - |
122 | | -``` |
123 | | - url: redis://redis:6379 |
124 | | -``` |
125 | | - |
126 | | -### Run using `docker-compose` for development |
127 | | - |
128 | | -Data Source have to be built following [BUILD](https://github.com/RedisGrafana/grafana-redis-datasource/blob/master/BUILD.md) instructions before starting using `docker-compose/dev.yml` file. |
129 | | - |
130 | | -```bash |
131 | | -docker-compose -f docker-compose/dev.yml up |
132 | | -``` |
| 55 | +Interested in the latest features and updates? Start nightly built [Docker image for Redis Application plug-in](https://redisgrafana.github.io/development/images/), which includes Redis Data Source. |
133 | 56 |
|
134 | 57 | ## Supported commands |
135 | 58 |
|
136 | | -Data Source supports various Redis commands using custom components and provides a unified interface to query any command. |
| 59 | +List of all supported commands and how to use them with examples you can find in the [Commands](https://redisgrafana.github.io/redis-datasource/commands/) section. |
137 | 60 |
|
138 | 61 |  |
139 | 62 |
|
140 | | -## Template variables |
141 | | - |
142 | | -Template variables can query any command and use other variables as parameters. |
143 | | - |
144 | | - |
145 | | - |
146 | 63 | ## Learn more |
147 | 64 |
|
148 | 65 | - [Introducing the Redis Data Source Plug-in for Grafana](https://redislabs.com/blog/introducing-the-redis-data-source-plug-in-for-grafana/) |
|
0 commit comments