Skip to content

Commit 72e9660

Browse files
committed
Update documentation to make v2 dashboards and configs the default
1 parent 5537d7d commit 72e9660

File tree

6 files changed

+118
-24
lines changed

6 files changed

+118
-24
lines changed

docs/modules/ROOT/pages/dashboards/catalog.adoc

Lines changed: 108 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,99 @@ Browse the complete collection of pre-built dashboards for Redis Enterprise moni
66

77
This catalog contains ready-to-use dashboards for various observability platforms. Each dashboard provides comprehensive monitoring of Redis Enterprise clusters, databases, and nodes.
88

9-
== Grafana Dashboards
9+
NOTE: All dashboards listed below are from the v2 collection, which is recommended for all deployments. If you need legacy v1 dashboards, see the xref:#legacy-dashboards[Legacy Dashboards] section.
1010

11-
=== Redis Enterprise Cluster Overview
12-
* *File*: `grafana/cluster-overview.json`
13-
* *Description*: High-level view of cluster health, resource usage, and performance
14-
* *Key Metrics*: Cluster status, total operations, memory usage, node count
11+
== Grafana Dashboards (v2)
1512

16-
=== Redis Enterprise Database Details
17-
* *File*: `grafana/database-details.json`
18-
* *Description*: Detailed metrics for individual databases
19-
* *Key Metrics*: Ops/sec, hit rate, latency, connection count, memory usage
13+
=== Kickstart Collection
14+
Production-ready dashboards for immediate deployment:
2015

21-
=== Redis Enterprise Node Monitoring
22-
* *File*: `grafana/node-monitoring.json`
23-
* *Description*: Node-level resource utilization and health
24-
* *Key Metrics*: CPU, memory, disk I/O, network traffic
16+
* *Cluster Dashboard*: `grafana_v2/dashboards/kickstart/cluster.json` - High-level cluster health and performance
17+
* *Database Dashboard*: `grafana_v2/dashboards/kickstart/database.json` - Detailed database metrics and operations
18+
* *Node Dashboard*: `grafana_v2/dashboards/kickstart/node.json` - Node-level resource utilization
19+
* *Shard Dashboard*: `grafana_v2/dashboards/kickstart/shard.json` - Shard-level monitoring and health
20+
* *Active-Active Dashboard*: `grafana_v2/dashboards/kickstart/active-active.json` - Active-Active replication monitoring
21+
* *System Security Dashboard*: `grafana_v2/dashboards/kickstart/sys-sec.json` - Security and system metrics
2522

26-
== Dynatrace Dashboards
23+
=== Grafana v9-11 Collection
24+
Optimized for Grafana versions 9-11:
2725

28-
=== Redis Enterprise Full Stack
29-
* *File*: `dynatrace/full-stack-monitoring.json`
30-
* *Description*: Comprehensive view across infrastructure and application layers
31-
* *Features*: AI-powered anomaly detection, automatic baselining
26+
==== Basic Dashboards
27+
* *Cluster*: `grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-cluster-dashboard_v9-11.json`
28+
* *Database*: `grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-database-dashboard_v9-11.json`
29+
* *Node*: `grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-node-dashboard_v9-11.json`
30+
* *Shard*: `grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-shard-dashboard_v9-11.json`
31+
* *Active-Active*: `grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-active-active-dashboard_v9-11.json`
32+
* *Synchronization*: `grafana_v2/dashboards/grafana_v9-11/software/basic/redis-software-synchronization-overview_v9-11.json`
3233

33-
== New Relic Dashboards
34+
==== Extended Dashboards
35+
* *Database Extended*: `grafana_v2/dashboards/grafana_v9-11/software/extended/redis-software-database-extended-dashboard_v9-11.json` - Comprehensive database analysis
3436

35-
=== Redis Enterprise Performance
36-
* *File*: `newrelic/performance-dashboard.json`
37-
* *Description*: Application performance monitoring focused on Redis operations
38-
* *Features*: NRQL queries, custom widgets, alert correlation
37+
==== Workflow Dashboards
38+
Database-focused operational views:
39+
40+
* *All Databases*: `grafana_v2/dashboards/grafana_v9-11/workflow/databases/redis-software-cluster-databases_v9-11.json`
41+
* *Database CPU*: `grafana_v2/dashboards/grafana_v9-11/workflow/databases/redis-software-cluster-database-cpu_v9-11.json`
42+
* *Database Memory*: `grafana_v2/dashboards/grafana_v9-11/workflow/databases/redis-software-cluster-database-memory_v9-11.json`
43+
* *Database Latency*: `grafana_v2/dashboards/grafana_v9-11/workflow/databases/redis-software-cluster-database-latency_v9-11.json`
44+
* *Database Requests*: `grafana_v2/dashboards/grafana_v9-11/workflow/databases/redis-software-cluster-database-requests_v9-11.json`
45+
46+
==== Module-Specific Dashboards
47+
* *RediSearch QPS*: `grafana_v2/dashboards/grafana_v9-11/search/RediSearchQPS.json`
48+
49+
=== Alert Dashboard
50+
* *Redis Alert Dashboard*: `grafana_v2/alerts/redis-alert-dashboard.json` - Centralized alert visualization
51+
52+
== Dynatrace Dashboards (v2)
53+
54+
=== Generation 3 Dashboards
55+
Latest Dynatrace dashboard generation:
56+
57+
* *Directory*: `dynatrace_v2/gen-3-dashboards/`
58+
* *Description*: AI-powered monitoring with automatic baselining and anomaly detection
59+
* *Features*: Full-stack observability, Davis AI integration
60+
61+
=== Kickstarter
62+
* *Directory*: `dynatrace_v2/kickstarter/`
63+
* *Description*: Quick-start templates for rapid deployment
64+
65+
See the https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/dynatrace_v2[dynatrace_v2 README^] for detailed information.
66+
67+
== New Relic Dashboards (v2)
68+
69+
=== Dashboard Collection
70+
* *Directory*: `newrelic_v2/dashboards/`
71+
* *Description*: Comprehensive monitoring with NRQL queries
72+
* *Features*: Custom widgets, alert correlation, APM integration
73+
74+
=== Kickstarter
75+
* *Directory*: `newrelic_v2/kickstarter/`
76+
* *Description*: Pre-configured setup for quick deployment
77+
78+
See the https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/newrelic_v2[newrelic_v2 README^] for configuration details.
79+
80+
== Datadog Dashboards (v2)
81+
82+
=== Kickstarter
83+
* *Directory*: `datadog_v2/kickstarter/`
84+
* *Description*: Ready-to-use Datadog monitoring setup
85+
* *Features*: APM integration, log correlation, custom metrics
86+
87+
See the https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/datadog_v2[datadog_v2 README^] for setup instructions.
88+
89+
== Prometheus Alert Rules (v2)
90+
91+
Production-ready alert definitions:
92+
93+
* *All Alerts*: `prometheus_v2/rules/alerts.yml` - Comprehensive alert suite
94+
* *Capacity Alerts*: `prometheus_v2/rules/capacity-alerts.yml` - Capacity planning and thresholds
95+
* *Connection Alerts*: `prometheus_v2/rules/connection-alerts.yml` - Connection monitoring
96+
* *Latency Alerts*: `prometheus_v2/rules/latency-alerts.yml` - Performance thresholds
97+
* *Node Alerts*: `prometheus_v2/rules/node-alerts.yml` - Node health monitoring
98+
* *Shard Alerts*: `prometheus_v2/rules/shard-alerts.yml` - Shard-level alerts
99+
* *Synchronization Alerts*: `prometheus_v2/rules/synchronization-alerts.yml` - Replication monitoring
100+
* *Throughput Alerts*: `prometheus_v2/rules/throughput-alerts.yml` - Throughput thresholds
101+
* *Utilization Alerts*: `prometheus_v2/rules/utilization-alerts.yml` - Resource utilization
39102

40103
== Splunk Dashboards
41104

@@ -70,11 +133,32 @@ All dashboards can be customized to fit your specific needs:
70133
* Adjust thresholds and alert conditions
71134
* Create dashboard variables for filtering
72135

136+
[#legacy-dashboards]
137+
== Legacy Dashboards (v1)
138+
139+
WARNING: The v1 dashboards are provided for compatibility with older deployments only. We recommend upgrading to v2 dashboards for the latest features and improvements.
140+
141+
=== Grafana v1 (Legacy)
142+
* *Directory*: `grafana/dashboards/`
143+
* *Note*: Basic cluster, database, and node monitoring dashboards
144+
145+
=== Dynatrace v1 (Legacy)
146+
* *Directory*: `dynatrace/`
147+
* *Note*: Earlier generation dashboards
148+
149+
=== New Relic v1 (Legacy)
150+
* *Directory*: `newrelic/`
151+
* *Note*: Legacy integration setup
152+
153+
=== Prometheus v1 (Legacy)
154+
* *Directory*: `prometheus/`
155+
* *Note*: Original Prometheus configurations and rules
156+
73157
== Contributing
74158

75159
To contribute new dashboards or improvements:
76160

77161
. Fork the repository
78-
. Add your dashboard to the appropriate platform directory
162+
. Add your dashboard to the appropriate v2 platform directory
79163
. Update this catalog
80164
. Submit a pull request

docs/modules/ROOT/pages/index.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This project provides comprehensive monitoring solutions for Redis Enterprise, i
1111
* Alert definitions and templates
1212
* Integration guides for popular observability tools
1313

14+
IMPORTANT: This documentation focuses on our v2 dashboards and configurations, which feature improved metrics, better visualizations, and enhanced alert rules. V2 is recommended for all deployments. Legacy v1 resources are available in the xref:dashboards/catalog.adoc#legacy-dashboards[Dashboard Catalog].
15+
1416
== Supported Platforms
1517

1618
* xref:platforms/grafana.adoc[Grafana] - Visualization and analytics

docs/modules/ROOT/pages/platforms/dynatrace.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Full-stack monitoring of Redis Enterprise with Dynatrace.
66

77
Dynatrace provides automated, AI-powered monitoring for Redis Enterprise deployments.
88

9+
NOTE: This guide uses v2 dashboards (Generation 3), which are recommended for all deployments. For legacy v1 dashboards, see the xref:dashboards/catalog.adoc#legacy-dashboards[Legacy Dashboards] section in the catalog.
10+
911
== Prerequisites
1012

1113
* Dynatrace account (SaaS or Managed)

docs/modules/ROOT/pages/platforms/grafana.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Monitor Redis Enterprise with Grafana dashboards and Prometheus data sources.
66

77
Grafana provides powerful visualization capabilities for Redis Enterprise metrics. This integration uses Prometheus as the data source.
88

9+
NOTE: This guide uses v2 dashboards, which are recommended for all deployments. If you need legacy v1 dashboards, see the xref:dashboards/catalog.adoc#legacy-dashboards[Legacy Dashboards] section in the catalog.
10+
911
== Prerequisites
1012

1113
* Grafana instance (v8.0 or later recommended)

docs/modules/ROOT/pages/platforms/newrelic.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Monitor Redis Enterprise with New Relic's application performance monitoring pla
66

77
New Relic provides comprehensive monitoring and alerting for Redis Enterprise clusters.
88

9+
NOTE: This guide uses v2 dashboards and configurations, which are recommended for all deployments. For legacy v1 resources, see the xref:dashboards/catalog.adoc#legacy-dashboards[Legacy Dashboards] section in the catalog.
10+
911
== Prerequisites
1012

1113
* New Relic account

docs/modules/ROOT/pages/platforms/prometheus.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Collect and store Redis Enterprise metrics with Prometheus.
66

77
Prometheus scrapes metrics from Redis Enterprise and stores them as time-series data for querying and visualization.
88

9+
NOTE: This guide references v2 alert rules and configurations, which are recommended for all deployments. For legacy v1 configurations, see the xref:dashboards/catalog.adoc#legacy-dashboards[Legacy Dashboards] section in the catalog.
10+
911
== Prerequisites
1012

1113
* Prometheus server (v2.30 or later recommended)

0 commit comments

Comments
 (0)