dashboards: add flag to skip gateway

CHANGELOG.md

@@ -60,6 +60,7 @@
 * [ENHANCEMENT] Dashboards: Show QPS and latency of the Alertmanager Distributor. #1696
 * [ENHANCEMENT] Playbooks: Add Alertmanager suggestions for `MimirRequestErrors` and `MimirRequestLatency` #1702
 * [ENHANCEMENT] Dashboards: Allow custom datasources. #1749
+* [ENHANCEMENT] Dashboards: Add config option `gateway_enabled` (defaults to `true`) to disable gateway panels from dashboards. #1761
 * [BUGFIX] Dashboards: Fix "Failed evaluation rate" panel on Tenants dashboard. #1629
 * [BUGFIX] Honor the configured `per_instance_label` in all dashboards and alerts. #1697
 

operations/mimir-mixin/config.libsonnet

@@ -47,6 +47,9 @@
     // Whether resources dashboards are enabled (based on cAdvisor metrics).
     resources_dashboards_enabled: true,
 
+    // Whether mimir gateway is enabled
+    gateway_enabled: true,
+
     // The label used to differentiate between different application instances (i.e. 'pod' in a kubernetes install).
     per_instance_label: 'pod',
 

operations/mimir-mixin/dashboards/alertmanager-resources.libsonnet

@@ -4,7 +4,8 @@ local utils = import 'mixin-utils/utils.libsonnet';
   'mimir-alertmanager-resources.json':
     ($.dashboard('Alertmanager resources') + { uid: '68b66aed90ccab448009089544a8d6c6' })
     .addClusterSelectorTemplates(false)
-    .addRow(
+    .addRowIf(
+      $._config.gateway_enabled,
       $.row('Gateway')
       .addPanel(
         $.containerCPUUsagePanel('CPU', $._config.job_names.gateway),

operations/mimir-mixin/dashboards/alertmanager.libsonnet

@@ -88,7 +88,8 @@ local utils = import 'mixin-utils/utils.libsonnet';
         $.latencyPanel('cortex_alertmanager_notification_latency_seconds', '{%s}' % $.jobMatcher($._config.job_names.alertmanager))
       )
     )
-    .addRow(
+    .addRowIf(
+      $._config.gateway_enabled,
       $.row('Configuration API (gateway) + Alertmanager UI')
       .addPanel(
         $.panel('QPS') +

operations/mimir-mixin/dashboards/dashboard-utils.libsonnet

@@ -4,6 +4,14 @@ local utils = import 'mixin-utils/utils.libsonnet';
 
   _config:: error 'must provide _config',
 
+  row(title)::
+    super.row(title) + {
+      addPanelIf(condition, panel)::
+        if condition
+        then self.addPanel(panel)
+        else self,
+    },
+
   // Override the dashboard constructor to add:
   // - default tags,
   // - some links that propagate the selectred cluster.

operations/mimir-mixin/dashboards/reads-networking.libsonnet

@@ -4,7 +4,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
   'mimir-reads-networking.json':
     ($.dashboard('Reads networking') + { uid: 'c0464f0d8bd026f776c9006b05910000' })
     .addClusterSelectorTemplates(false)
-    .addRow($.jobNetworkingRow('Gateway', 'gateway'))
+    .addRowIf($._config.gateway_enabled, $.jobNetworkingRow('Gateway', 'gateway'))
     .addRow($.jobNetworkingRow('Query-frontend', 'query_frontend'))
     .addRow($.jobNetworkingRow('Query-scheduler', 'query_scheduler'))
     .addRow($.jobNetworkingRow('Querier', 'querier'))

operations/mimir-mixin/dashboards/reads-resources.libsonnet

@@ -4,7 +4,8 @@ local utils = import 'mixin-utils/utils.libsonnet';
   'mimir-reads-resources.json':
     ($.dashboard('Reads resources') + { uid: '2fd2cda9eea8d8af9fbc0a5960425120' })
     .addClusterSelectorTemplates(false)
-    .addRow(
+    .addRowIf(
+      $._config.gateway_enabled,
       $.row('Gateway')
       .addPanel(
         $.containerCPUUsagePanel('CPU', $._config.job_names.gateway),

operations/mimir-mixin/dashboards/reads.libsonnet

@@ -88,7 +88,8 @@ local utils = import 'mixin-utils/utils.libsonnet';
         ),
       )
     )
-    .addRow(
+    .addRowIf(
+      $._config.gateway_enabled,
       $.row('Gateway')
       .addPanel(
         $.panel('Requests / sec') +

operations/mimir-mixin/dashboards/ruler.libsonnet

@@ -103,7 +103,8 @@ local utils = import 'mixin-utils/utils.libsonnet';
         ),
       )
     )
-    .addRow(
+    .addRowIf(
+      $._config.gateway_enabled,
       $.row('Configuration API (gateway)')
       .addPanel(
         $.panel('QPS') +

operations/mimir-mixin/dashboards/writes-networking.libsonnet

@@ -4,7 +4,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
   'mimir-writes-networking.json':
     ($.dashboard('Writes networking') + { uid: '681cd62b680b7154811fe73af55dcfd4' })
     .addClusterSelectorTemplates(false)
-    .addRow($.jobNetworkingRow('Gateway', 'gateway'))
+    .addRowIf($._config.gateway_enabled, $.jobNetworkingRow('Gateway', 'gateway'))
     .addRow($.jobNetworkingRow('Distributor', 'distributor'))
     .addRow($.jobNetworkingRow('Ingester', 'ingester'))
     + {

operations/mimir-mixin/dashboards/writes-resources.libsonnet

@@ -4,7 +4,8 @@ local utils = import 'mixin-utils/utils.libsonnet';
   'mimir-writes-resources.json':
     ($.dashboard('Writes resources') + { uid: 'c0464f0d8bd026f776c9006b0591bb0b' })
     .addClusterSelectorTemplates(false)
-    .addRow(
+    .addRowIf(
+      $._config.gateway_enabled,
       $.row('Gateway')
       .addPanel(
         $.containerCPUUsagePanel('CPU', $._config.job_names.gateway),

operations/mimir-mixin/dashboards/writes.libsonnet

@@ -102,12 +102,14 @@ local utils = import 'mixin-utils/utils.libsonnet';
         $.panel('Tenants') +
         $.statPanel('count(count by(user) (cortex_ingester_active_series{%s}))' % $.jobMatcher($._config.job_names.ingester), format='short')
       )
-      .addPanel(
+      .addPanelIf(
+        $._config.gateway_enabled,
         $.panel('Requests / sec') +
         $.statPanel('sum(rate(cortex_request_duration_seconds_count{%s, route=~"api_(v1|prom)_push"}[5m]))' % $.jobMatcher($._config.job_names.gateway), format='reqps')
       )
     )
-    .addRow(
+    .addRowIf(
+      $._config.gateway_enabled,
       $.row('Gateway')
       .addPanel(
         $.panel('Requests / sec') +