Skip to content

[codex] Add OpenShift native Observe dashboards - #88

Open
jsachs-redislabs wants to merge 5 commits into
redis-field-engineering:mainfrom
jsachs-redislabs:codex/native-openshift-observe-dashboards
Open

[codex] Add OpenShift native Observe dashboards#88
jsachs-redislabs wants to merge 5 commits into
redis-field-engineering:mainfrom
jsachs-redislabs:codex/native-openshift-observe-dashboards

Conversation

@jsachs-redislabs

@jsachs-redislabs jsachs-redislabs commented Apr 24, 2026

Copy link
Copy Markdown

Summary

  • Add native OpenShift Observe dashboard manifests for Redis Enterprise using legacy dashboard ConfigMaps.
  • Add ServiceMonitor and PrometheusRule manifests for in-cluster Redis Enterprise metrics and alerts.
  • Add customer-facing deployment docs and a runbook for an OpenShift cluster where Redis Enterprise is already installed and working.

Dashboard Scope

  • Basic dashboards: Cluster Status, Database Status, Node, Shard, Active-Active, Synchronization.
  • Ops dashboards: Cluster, Database, Node, Shard, Latency, Active-Active Lag, RediSearch QPS.

Live OpenShift Validation

Tested with the authenticated oc context against a cluster containing two active-active Redis Enterprise clusters in ns-a and ns-b.

  • Enabled user workload monitoring with enableUserWorkload: true.
  • Labeled Redis Enterprise metrics services in ns-a and ns-b with redis.io/observe=metrics.
  • Applied ServiceMonitor and PrometheusRule resources in both Redis Enterprise namespaces.
  • Applied all 13 dashboard ConfigMaps in openshift-config-managed.
  • Verified Thanos returned Redis Enterprise data for both namespaces:
    • count(redis_server_up{namespace="ns-a"}) == 4
    • count(redis_server_up{namespace="ns-b"}) == 4
    • sum(endpoint_client_connections{namespace="ns-a"}) == 14
    • sum(endpoint_client_connections{namespace="ns-b"}) == 14
    • count(node_metrics_up{namespace="ns-a"}) == 3
    • count(node_metrics_up{namespace="ns-b"}) == 3
  • Confirmed Thanos Ruler loaded the Redis Enterprise rule files. Existing Redis alert expression warnings about counter naming were informational and did not block rule loading.

Static Checks

  • git diff --cached --check
  • Dashboard embedded JSON validation with yq and jq
  • oc kustomize openshift/native-observe
  • npm run docs

Notes

  • promtool was not installed locally, so rule validation was covered by OpenShift server-side deployment and Thanos Ruler loading.
  • Unsupported Grafana-only panel features are intentionally omitted from the native OpenShift dashboards.

Note

Medium Risk
Adds OpenShift ServiceMonitor/PrometheusRule and legacy dashboard ConfigMap manifests that, if applied, affect cluster monitoring/alerting behavior and scrape configuration. Changes are additive but touch operational observability resources in production clusters.

Overview
Adds OpenShift-native observability support for Redis Enterprise via legacy Observe dashboard ConfigMap manifests (Basic and Ops dashboard sets) and a kustomization.yaml bundle to apply them together.

Introduces OpenShift user-workload monitoring integration manifests: a ServiceMonitor for scraping Redis Enterprise metrics over HTTPS (/v2, insecureSkipVerify: true) and a PrometheusRule exposing Redis Enterprise alert rules to OpenShift Observe.

Updates documentation to include an OpenShift Native Observe Dashboards install guide plus an OpenShift native-observe README and an active-active runbook, and links the new platform/guide from the top-level README.md and Antora nav.

Reviewed by Cursor Bugbot for commit 7242457. Bugbot is set up for automated code reviews on this repo. Configure here.

@jsachs-redislabs
jsachs-redislabs marked this pull request as ready for review April 24, 2026 21:41
Comment thread openshift/native-observe/dashboards/redis-enterprise-basic-active-active.yaml Outdated
Comment thread openshift/native-observe/redis-enterprise-prometheusrule.yaml Outdated
Comment thread openshift/native-observe/dashboards/redis-enterprise-basic-database-status.yaml Outdated
Comment thread openshift/native-observe/dashboards/redis-enterprise-basic-database-status.yaml Outdated
Comment thread openshift/native-observe/redis-enterprise-prometheusrule.yaml Outdated

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Reviewed by Cursor Bugbot for commit 6be08ee. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants