grafana_dashboard_var_namespace

Description

The grafana_dashboard_var_namespace parameter overrides the Grafana dashboard template variable name for the namespace filter. The Console's "Open in Grafana" deep-link button substitutes this name into the URL it opens (e.g., ?var-namespace=<ns> becomes ?var-k8s_namespace=<ns> when set to k8s_namespace).

Default Value

The default value is namespace.

Allowed Range

Letters, digits, and underscore only. The validator at pkg/cli/rack.go rejects values containing characters that would break URL substitution or Grafana template syntax.

Use Cases

  • Dashboards using k8s_namespace: Some imported dashboards prefix Kubernetes-specific variables with k8s_.
  • Dashboards using ns: Brevity-oriented dashboards often shorten namespace to ns.

Setting Parameters

To override to k8s_namespace:

$ convox rack params set grafana_dashboard_var_namespace=k8s_namespace -r rackName
Setting parameters... OK

To revert to the default:

$ convox rack params set grafana_dashboard_var_namespace=namespace -r rackName
Setting parameters... OK

To clear the override (falls back to the canonical default namespace):

$ convox rack params set grafana_dashboard_var_namespace= -r rackName
Setting parameters... OK

Operational Notes

  • The Console reads the value via the rack-params query and substitutes at deep-link generation time. No restart is required; the next dashboard open uses the new value.
  • The "Dashboard filter mismatch?" troubleshooting modal in the Console explains the four configurable var names and how to inspect Grafana's expected variable names.

Version Requirements

This parameter requires at least Convox rack version 3.24.6.