Skip to content

Commit 944ce61

Browse files
committed
Add Example Configurations sections to platform docs
- Add prominent links to production-ready configs in GitHub repo - Include direct links to alert rules, dashboards, and complete configurations - Add helpful tips encouraging users to download/customize rather than start from scratch - Covers Prometheus, Grafana, New Relic, Dynatrace, and Splunk platforms Related to #75
1 parent de1682b commit 944ce61

File tree

5 files changed

+88
-0
lines changed

5 files changed

+88
-0
lines changed

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,23 @@ For containerized or remote deployments:
3030
. Set up Dynatrace Prometheus integration
3131
. Configure metrics ingestion
3232

33+
== Example Configurations
34+
35+
=== Production-Ready Templates
36+
37+
Complete extension and dashboard files are available in the GitHub repository:
38+
39+
* https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/dynatrace_v2[Dynatrace Extension^]
40+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/dynatrace_v2/src/extension.yaml[extension.yaml^] - Complete metric definitions (1700+ lines)
41+
*** Defines all Redis Enterprise v2 metrics
42+
*** Includes metric metadata, units, and descriptions
43+
*** Organized by category: cluster, node, endpoint, shard, replication, Active-Active
44+
** https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/dynatrace_v2/src/dashboards[Dashboard Templates^] - Pre-built dashboards
45+
46+
* https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/dynatrace[Legacy v1 Extension^] - For older Redis Enterprise versions
47+
48+
TIP: The extension.yaml file provides a complete catalog of available metrics. Review it to understand which metrics to monitor and customize for your environment.
49+
3350
== Dashboard Configuration
3451

3552
Import the Redis Enterprise dashboard template:

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,26 @@ providers:
132132

133133
Place dashboard JSON files in `/var/lib/grafana/dashboards/redis-enterprise/`.
134134

135+
== Example Configurations
136+
137+
=== Production-Ready Templates
138+
139+
Complete dashboard and configuration files are available in the GitHub repository:
140+
141+
* https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/grafana_v2[Grafana Dashboards^] - Full JSON dashboard definitions
142+
** Cluster overview dashboards
143+
** Database performance dashboards
144+
** Node monitoring dashboards
145+
** Active-Active replication dashboards
146+
147+
* https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/grafana_v2/demo_v2[Complete Demo Environment^] - Working docker-compose setup
148+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/demo_v2/docker-compose.yml[docker-compose.yml^] - Full stack (Prometheus + Grafana + Redis)
149+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/demo_v2/prometheus.yml[prometheus.yml^] - Pre-configured scrape settings
150+
151+
* https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/grafana_v2/kickstart_v2[Kickstart Environment^] - Quick production setup
152+
153+
TIP: Import the complete dashboard JSON files directly into Grafana rather than recreating panels manually. All dashboards include pre-configured variables and alert templates.
154+
135155
== Available Dashboards
136156

137157
See the xref:dashboards/catalog.adoc[Dashboard Catalog] for the complete list of Grafana dashboards.

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,21 @@ data:
126126
interval: 30s
127127
----
128128

129+
== Example Configurations
130+
131+
=== Production-Ready Templates
132+
133+
Complete configuration files are available in the GitHub repository:
134+
135+
* https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/newrelic_v2[New Relic Configurations^]
136+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/newrelic_v2/config/prometheus.yml[prometheus.yml^] - Prometheus remote write template
137+
** https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/newrelic_v2/kickstarter[Kickstarter Scripts^] - Automated deployment tools
138+
** https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/newrelic_v2/kickstarter/terraform[Terraform Modules^] - AWS and GCP deployment examples
139+
140+
* Dashboard JSON files for import into New Relic One
141+
142+
TIP: The Prometheus configuration template includes placeholder comments showing exactly where to add your cluster hostname and New Relic bearer token.
143+
129144
== Dashboard Import
130145

131146
. Navigate to Dashboards in New Relic One

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,26 @@ scrape_configs:
143143
target_label: cluster
144144
----
145145

146+
== Example Configurations
147+
148+
=== Production-Ready Templates
149+
150+
Complete, tested configuration files are available in the GitHub repository:
151+
152+
* https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/prometheus_v2/rules[Alert Rules^] - Production-ready alert definitions
153+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus_v2/rules/alerts.yml[alerts.yml^] - Comprehensive alert suite
154+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus_v2/rules/capacity-alerts.yml[capacity-alerts.yml^] - Capacity monitoring
155+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus_v2/rules/latency-alerts.yml[latency-alerts.yml^] - Latency thresholds
156+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus_v2/rules/connection-alerts.yml[connection-alerts.yml^] - Connection monitoring
157+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus_v2/rules/node-alerts.yml[node-alerts.yml^] - Node health alerts
158+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/prometheus_v2/rules/shard-alerts.yml[shard-alerts.yml^] - Shard monitoring
159+
160+
* https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/grafana_v2/demo_v2/prometheus.yml[Complete Prometheus Configuration^] - Working example with v1 and v2 endpoints
161+
162+
* https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/prometheus_v2/tests[Alert Test Files^] - Validation tests for each alert rule
163+
164+
TIP: Download and customize these files for your environment rather than starting from scratch. Each alert includes recommended thresholds and runbook URLs.
165+
146166
== Available Metrics
147167

148168
Redis Enterprise exposes comprehensive metrics including:

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,22 @@ Configure Telegraf to collect Redis Enterprise metrics and forward to Splunk:
3535
splunk_token = "<your-hec-token>"
3636
----
3737

38+
== Example Configurations
39+
40+
=== Production-Ready Templates
41+
42+
Complete configuration files are available in the GitHub repository:
43+
44+
* https://github.com/redis-field-engineering/redis-enterprise-observability/tree/main/splunk[Splunk Configurations^]
45+
** https://github.com/redis-field-engineering/redis-enterprise-observability/blob/main/splunk/config/agent_config.yml[agent_config.yml^] - Complete OpenTelemetry Collector configuration (300+ lines)
46+
*** Receivers: Prometheus, OTLP, Jaeger, Zipkin
47+
*** Processors: Memory limiter, resource detection, batch processing
48+
*** Exporters: Splunk HEC, SignalFx
49+
*** Pre-configured pipelines for metrics, traces, and logs
50+
** Dashboard XML templates for Splunk UI
51+
52+
TIP: The agent_config.yml provides a complete working configuration for the Splunk OpenTelemetry Collector. Replace placeholder values (REDIS_ENTERPRISE_HOST, SPLUNK_* environment variables) with your environment specifics.
53+
3854
== Dashboard Import
3955

4056
. Navigate to Search & Reporting

0 commit comments

Comments
 (0)