|
9 | 9 | [](https://goreportcard.com/report/github.com/RedisGrafana/grafana-redis-datasource) |
10 | 10 |  |
11 | 11 | [](https://codecov.io/gh/RedisGrafana/grafana-redis-datasource) |
| 12 | +[](https://lgtm.com/projects/g/RedisGrafana/grafana-redis-datasource/context:javascript) |
12 | 13 |
|
13 | 14 | ## Summary |
14 | 15 |
|
15 | 16 | - [**Introduction**](#introduction) |
16 | 17 | - [**Getting Started**](#getting-started) |
17 | | -- [**Supported commands**](#supported-commands) |
18 | | -- [**Learn more**](#learn-more) |
| 18 | +- [**Documentation**](#documentation) |
| 19 | +- [**Development**](#development) |
19 | 20 | - [**Feedback**](#feedback) |
20 | 21 | - [**Contributing**](#contributing) |
21 | 22 | - [**License**](#license) |
22 | 23 |
|
23 | 24 | ## Introduction |
24 | 25 |
|
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. |
| 26 | +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 out-of-the-box predefined dashboards and lets you build customized dashboards to monitor Redis and application data. |
26 | 27 |
|
27 | 28 | ### Requirements |
28 | 29 |
|
29 | 30 | Only **Grafana 7.1+** with a new Backend plug-in platform supports Redis plug-ins. |
30 | 31 |
|
31 | 32 | ### Redis Application plug-in |
32 | 33 |
|
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. |
| 34 | +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 manage various Redis Data Sources and provides Custom panels. |
34 | 35 |
|
35 | 36 | ## Getting Started |
36 | 37 |
|
37 | | -Use the `grafana-cli` tool to install from the commandline: |
| 38 | +Use the `grafana-cli` tool to install from the command line: |
38 | 39 |
|
39 | 40 | ```bash |
40 | 41 | grafana-cli plugins install redis-datasource |
41 | 42 | ``` |
42 | 43 |
|
43 | | -For Docker instructions and installation without Internet access follow [Quickstart](https://redisgrafana.github.io/quickstart/) page. |
| 44 | +For Docker instructions and installation without Internet access, follow the [Quickstart](https://redisgrafana.github.io/quickstart/) page. |
44 | 45 |
|
45 | 46 | ### Configuration |
46 | 47 |
|
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. |
| 48 | +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 the [Configuration](https://redisgrafana.github.io/redis-datasource/configuration/) page. |
48 | 49 |
|
49 | 50 |  |
50 | 51 |
|
51 | | -### Development |
| 52 | +## Documentation |
52 | 53 |
|
53 | | -[Developing Redis Data Source](https://redisgrafana.github.io/development/redis-datasource/) page provides instructions on how to build data source. |
| 54 | +Please take a look at the [Documentation](https://redisgrafana.github.io/redis-datasource/overview/) to learn more about plug-in and features. |
54 | 55 |
|
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. |
56 | | - |
57 | | -## Supported commands |
| 56 | +### Supported commands |
58 | 57 |
|
59 | 58 | 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. |
60 | 59 |
|
61 | 60 |  |
62 | 61 |
|
63 | | -## Learn more |
| 62 | +## Development |
| 63 | + |
| 64 | +[Developing Redis Data Source](https://redisgrafana.github.io/development/redis-datasource/) page provides instructions on building the data source. |
64 | 65 |
|
65 | | -- [Introducing the Redis Data Source Plug-in for Grafana](https://redislabs.com/blog/introducing-the-redis-data-source-plug-in-for-grafana/) |
66 | | -- [How to Use the New Redis Data Source for Grafana Plug-in](https://redislabs.com/blog/how-to-use-the-new-redis-data-source-for-grafana-plug-in/) |
67 | | -- [3 Real-Life Apps Built with Redis Data Source for Grafana](https://redislabs.com/blog/3-real-life-apps-built-with-redis-data-source-for-grafana/) |
68 | | -- [Real-time observability with Redis and Grafana](https://grafana.com/go/observabilitycon/real-time-observability-with-redis-and-grafana/) |
| 66 | +Are you interested in the latest features and updates? Start nightly built [Docker image for Redis Application plug-in](https://redisgrafana.github.io/development/images/), including Redis Data Source. |
69 | 67 |
|
70 | 68 | ## Feedback |
71 | 69 |
|
72 | | -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: |
| 70 | +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: |
73 | 71 |
|
74 | | -- Ask a question, request a new feature and file a bug with [GitHub issues](https://github.com/RedisGrafana/grafana-redis-datasource/issues/new/choose). |
| 72 | +- Ask a question, request a new feature, and file a bug with [GitHub issues](https://github.com/RedisGrafana/grafana-redis-datasource/issues/new/choose). |
75 | 73 | - Star the repository to show your support. |
76 | 74 |
|
77 | 75 | ## Contributing |
|
0 commit comments