Skip to content

Commit 39a1087

Browse files
committed
package redis search dashboard
link search in the README dashboard updates from jb Fix line breaks Add search to kickstart
1 parent d9a9bfc commit 39a1087

File tree

3 files changed

+6852
-15
lines changed

3 files changed

+6852
-15
lines changed

grafana_v2/dashboards/grafana_v9-11/README_v9-11.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ For Redis Enterprise, we provide the following dashboards:
44
* [Database status](software/basic/redis-software-database-dashboard_v9-11.json)
55
* [Node metrics](software/basic/redis-software-node-dashboard_v9-11.json)
66
* [Shard metrics](software/basic/redis-software-shard-dashboard_v9-11.json)
7+
* [Search metrics](software/basic/redis-software-search-dashboard_v9-11.json)
78

89
For Redis Cloud, which is fully managed, we provide two dashboards:
910
* [Subscription status](cloud/basic/redis-cloud-subscription-dashboard_v9-11.json)
1011
* [Database status](cloud/basic/redis-cloud-database-dashboard_v9-11.json)
1112

12-
Lastly, we also provide two sets of dashboards designed to be used in a drill-down fashion. These dashboards specifically cover
13+
Lastly, we also provide two sets of dashboards designed to be used in a drill-down fashion. These dashboards specifically cover
1314
databases and nodes.
1415

15-
The top-level dashboard (e.g., Databases or Nodes) displays all instances of that type. For example, the [databases dashboard](workflow/databases/redis-software-cluster-databases_v9-11.json) shows metrics for every database in the Redis cluster. The individual rows make it easy to access different types of
16+
The top-level dashboard (e.g., Databases or Nodes) displays all instances of that type. For example, the [databases dashboard](workflow/databases/redis-software-cluster-databases_v9-11.json) shows metrics for every database in the Redis cluster. The individual rows make it easy to access different types of
1617
details about a particular instance.
1718
#### Databases
1819
* [Databases](workflow/databases/redis-software-cluster-databases_v9-11.json)
@@ -28,11 +29,11 @@ details about a particular instance.
2829
* [Node-Memory](workflow/nodes/redis-software-cluster-node-memory_v9-11.json)
2930
* [Node-Requests](workflow/nodes/redis-software-cluster-node-requests_v9-11.json)
3031

31-
Note that these dashboards, and their associated display panes, all have links in the top-right for the dashboards, and in the top-left for the
32+
Note that these dashboards, and their associated display panes, all have links in the top-right for the dashboards, and in the top-left for the
3233
panes, that make it easy to navigate from the main dashboard to the relevant detail information.
3334

3435
### Alerts
35-
This repository also contains [alert configuration files](prometheus/rules/alerts.yml) for Prometheus that can generate notifications when any of a number of
36+
This repository also contains [alert configuration files](prometheus/rules/alerts.yml) for Prometheus that can generate notifications when any of a number of
3637
key metrics fall outside of their expected ranges.
3738

3839
Finally, we include a set of [metrics descriptions](metrics) for your reference.
@@ -83,7 +84,7 @@ See the sections below for details.
8384

8485
### Prometheus and Grafana
8586

86-
1. Configure your [Prometheus deployment's scraping config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)
87+
1. Configure your [Prometheus deployment's scraping config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config)
8788
so that it reads from your Redis Enterprise Prometheus endpoint.
8889

8990
2. [Create a Prometheus data source](https://grafana.com/docs/grafana/v8.5/datasources/add-a-data-source/) in Grafana's administration console.
@@ -100,7 +101,7 @@ For Redis Enterprise, we provide the following dashboards:
100101
* [Node metrics](software/basic/redis-software-node-dashboard_v9-11.json)
101102
* [Shard metrics](software/basic/redis-software-shard-dashboard_v9-11.json)
102103

103-
You can upload these dashboards directly though the Grafana UI. For additional installation instructions, see the [Redis Enterprise dashboards
104+
You can upload these dashboards directly though the Grafana UI. For additional installation instructions, see the [Redis Enterprise dashboards
104105
README](software/README-SOFTWARE.md).
105106

106107
### Redis Cloud dashboards
@@ -111,7 +112,7 @@ For Redis Cloud, which is fully managed, we provide two dashboards:
111112

112113
### Redis Workflow Dashboards
113114

114-
These dashboards can be installed either in Redis Enterprise installations or in Redis Cloud installations.
115+
These dashboards can be installed either in Redis Enterprise installations or in Redis Cloud installations.
115116

116117
* [Databases](workflow/databases/redis-software-cluster-databases_v9-11.json)
117118
* [Database-CPU](workflow/databases/redis-software-cluster-database-cpu_v9-11.json)
@@ -124,22 +125,22 @@ These dashboards can be installed either in Redis Enterprise installations or in
124125
* [Node-Memory](workflow/nodes/redis-software-cluster-node-memory_v9-11.json)
125126
* [Node-Requests](workflow/nodes/redis-software-cluster-node-requests_v9-11.json)
126127

127-
You can upload these dashboards directly though the Grafana UI. For additional installation instructions, see the [Redis Cloud dashboards
128+
You can upload these dashboards directly though the Grafana UI. For additional installation instructions, see the [Redis Cloud dashboards
128129
README](cloud/README-CLOUD.md).
129130

130131
## Extended dashboards
131132

132-
We also provided an set of extended dashboards for both Redis Enterprise and Redis Cloud that provide additional metrics, including more information
133+
We also provided an set of extended dashboards for both Redis Enterprise and Redis Cloud that provide additional metrics, including more information
133134
about you cluster's configuration and the Redis slow log.
134135

135-
These optional dashboards rely on one additional data source beyond Prometheus: the [Infinity Datasource for
136+
These optional dashboards rely on one additional data source beyond Prometheus: the [Infinity Datasource for
136137
Grafana](https://grafana.com/grafana/plugins/yesoreyeram-infinity-datasource/).
137138

138139
## Alerts
139140

140141
### Running the alerting tests
141142

142-
To run the alerting tests, you will need to copy the [prometheus/rules/](rules) and [prometheus/tests/](tests) folders to your Prometheus installation. Once they have been
143+
To run the alerting tests, you will need to copy the [prometheus/rules/](rules) and [prometheus/tests/](tests) folders to your Prometheus installation. Once they have been
143144
copied,
144145
you can execute the tests as follows:
145146

@@ -149,16 +150,16 @@ promtool test rules tests/*
149150

150151
### Modifying the alerts
151152

152-
You can customize the included alerts to the need of your Redis deployment environment and configuration. You can also create additional alerts
153-
following Prometheus' alerting guidelines. We strongly recommend that you create unit tests for each of your alerts to ensure that they perform as
153+
You can customize the included alerts to the need of your Redis deployment environment and configuration. You can also create additional alerts
154+
following Prometheus' alerting guidelines. We strongly recommend that you create unit tests for each of your alerts to ensure that they perform as
154155
expected.
155156

156-
To learn more about testing alerts, see the [Prometheus documentation for unit testing
157+
To learn more about testing alerts, see the [Prometheus documentation for unit testing
157158
rules](https://prometheus.io/docs/prometheus/latest/configuration/unit_testing_rules/).
158159

159160
## Support
160161

161-
The Redis Enterprise Grafana dashboards are supported by Redis, Inc. on a good faith effort basis. To report bugs, request features, or receive
162+
The Redis Enterprise Grafana dashboards are supported by Redis, Inc. on a good faith effort basis. To report bugs, request features, or receive
162163
assistance, please file an [issue](https://github.com/redis-field-engineering/redis-enterprise-grafana-issues).
163164

164165
## License

0 commit comments

Comments
 (0)