Use timeseriesPanel instead of panel when creating panels (#58)

* Update jsonnet-libs to Fri Jul 19 12:51:49 2024 Updates grafana-builder and mixin-utils to latest version in master branch. This will be helpful in creating Grafana panels that use the timeseriesPanel instead of the deprecated panel. grafana-builder changes: - grafana-builder: add support for native/classic stat panel query (grafana/jsonnet-libs#1285) - More native histograms related utils and renaming (grafana/jsonnet-libs#1270) - Support recording and switching between naive and classic latency histograms (grafana/jsonnet-libs#1150) - Basic native histogram utilities (grafana/jsonnet-libs#1164) - grafana-builder: rename template variable "Data Source" to "Data source" (grafana/jsonnet-libs#1111) - Mixins: draw graphs at full resolution (grafana/jsonnet-libs#825) - Allow dashboards to show gRPC codes as labels (grafana/jsonnet-libs#1098) - Allow configuring sort order for variables (grafana/jsonnet-libs#1014) - remove unused/wrong step param (grafana/jsonnet-libs#999) - Show cancelled requests in grey on QPS dashboards. (grafana/jsonnet-libs#988) - Show cancelled requests in yellow on QPS dashboards. (grafana/jsonnet-libs#986) - Add timeseriesPanel (grafana/jsonnet-libs#824) - Allow including "All" for single template var - Allow datasource's regex to be configured - grafana-builder: make allValue configurable (grafana/jsonnet-libs#703) - grafana_builder: add dashboard link func (grafana/jsonnet-libs#683) - Add 'Data Source' label for the default datasource template variable. (grafana/jsonnet-libs#672) - enable toolip by default (grafana/jsonnet-libs#665) mixin-utils changes: - grafana-builder: add support for native/classic stat panel query (grafana/jsonnet-libs#1285) - More native histograms related utils and renaming (grafana/jsonnet-libs#1270) - nativeClassicSumBy: format list of labels nicer (grafana/jsonnet-libs#1204) - Support recording and switching between naive and classic latency histograms (grafana/jsonnet-libs#1150) - chore: fix hardcoded range interval (grafana/jsonnet-libs#1190) - Basic native histogram utilities (grafana/jsonnet-libs#1164) - utils: allow defining native histogram recording rule (grafana/jsonnet-libs#1156) - modify withRunbookURL to allow internal annotation (grafana/jsonnet-libs#1139) - mixin-utils: drop unsupported step target parameter (grafana/jsonnet-libs#1128) - Mixins: draw graphs at full resolution (grafana/jsonnet-libs#825) - Align with style conventions (grafana/jsonnet-libs#1038) - Add a function to remove an alert rule (grafana/jsonnet-libs#812) - mixin-utils: Parameterize interval for histogramRules (grafana/jsonnet-libs#806) - refactor(grafana/jsonnet-libsprometheus): shard mixins over multiple configmaps (grafana/jsonnet-libs#497) - Not all Prometheus rules are alerts. (grafana/jsonnet-libs#490) Signed-off-by: Charlie Le <[email protected]> * Use `timeseriesPanel` instead of `panel` when creating panels Fixes: #44 Depends on: #57 Signed-off-by: Charlie Le <[email protected]> * Add units to timeseries panel The yaxes field doesn't seem to do anything in the timeseries panel and was replaced with the units field instead. So I defaulted the units to be short and allowed it to be set for the panel. Signed-off-by: Charlie Le <[email protected]> * Update CHANGELOG.md --------- Signed-off-by: Charlie Le <[email protected]> Co-authored-by: Friedrich Gonzalez <[email protected]>
cortexproject · Oct 23, 2024 · b3faa7b · b3faa7b
1 parent a630e0e
commit b3faa7b
Show file tree

Hide file tree

Showing 14 changed files with 272 additions and 239 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,8 +7,9 @@
 * [CHANGE] Target 3M memory series per ingester instead of 1.5M
 * [CHANGE] Update jsonnet-libs to Fri Jul 19 12:51:49 2024 #57
 * [CHANGE] Increase CortexProvisioningTooManyWrites alert threshold to 160e3
+* [CHANGE] Use `timeseriesPanel` instead of `panel` when creating panels #58
 * [ENHANCEMENT] Configure `-ingester.client.grpc-compression` to be `snappy-block`
-* [ENHANCEMENT] Support Grafana 11 in Cortex Service Scaling Dashboard
+* [ENHANCEMENT] Support Grafana 11 in all dashboards
 * [BUGFIX] Remove deprecated option `max_series_per_query`
 
 ## 1.16.1

diff --git a/cortex-mixin/dashboards/alertmanager.libsonnet b/cortex-mixin/dashboards/alertmanager.libsonnet
@@ -10,22 +10,22 @@ local utils = import 'mixin-utils/utils.libsonnet';
          showTitle: false,
        })
       .addPanel(
-        $.panel('Total Alerts') +
+        $.timeseriesPanel('Total Alerts') +
         $.statPanel('sum(cluster_job_%s:cortex_alertmanager_alerts:sum{%s})' % [$._config.per_instance_label, $.jobMatcher($._config.job_names.alertmanager)], format='short')
       )
       .addPanel(
-        $.panel('Total Silences') +
+        $.timeseriesPanel('Total Silences') +
         $.statPanel('sum(cluster_job_%s:cortex_alertmanager_silences:sum{%s})' % [$._config.per_instance_label, $.jobMatcher($._config.job_names.alertmanager)], format='short')
       )
       .addPanel(
-        $.panel('Tenants') +
+        $.timeseriesPanel('Tenants') +
         $.statPanel('max(cortex_alertmanager_tenants_discovered{%s})' % $.jobMatcher($._config.job_names.alertmanager), format='short')
       )
     )
     .addRow(
       $.row('Alerts Received')
       .addPanel(
-        $.panel('APS') +
+        $.timeseriesPanel('APS') +
         $.queryPanel(
           [
             |||
@@ -42,7 +42,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
     .addRow(
       $.row('Alert Notifications')
       .addPanel(
-        $.panel('NPS') +
+        $.timeseriesPanel('NPS') +
         $.queryPanel(
           [
             |||
@@ -56,7 +56,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
         )
       )
       .addPanel(
-        $.panel('NPS by integration') +
+        $.timeseriesPanel('NPS by integration') +
         $.queryPanel(
           [
             |||
@@ -73,18 +73,18 @@ local utils = import 'mixin-utils/utils.libsonnet';
         )
       )
       .addPanel(
-        $.panel('Latency') +
+        $.timeseriesPanel('Latency', unit='ms') +
         $.latencyPanel('cortex_alertmanager_notification_latency_seconds', '{%s}' % $.jobMatcher($._config.job_names.alertmanager))
       )
     )
     .addRow(
       $.row('Configuration API (gateway) + Alertmanager UI')
       .addPanel(
-        $.panel('QPS') +
+        $.timeseriesPanel('QPS') +
         $.qpsPanel('cortex_request_duration_seconds_count{%s, route=~"api_v1_alerts|alertmanager"}' % $.jobMatcher($._config.job_names.gateway))
       )
       .addPanel(
-        $.panel('Latency') +
+        $.timeseriesPanel('Latency', unit='ms') +
         utils.latencyRecordingRulePanel('cortex_request_duration_seconds', $.jobSelector($._config.job_names.gateway) + [utils.selector.re('route', 'api_v1_alerts|alertmanager')])
       )
     )
@@ -94,23 +94,23 @@ local utils = import 'mixin-utils/utils.libsonnet';
     .addRow(
       $.row('Replication')
       .addPanel(
-        $.panel('Per %s Tenants' % $._config.per_instance_label) +
+        $.timeseriesPanel('Per %s Tenants' % $._config.per_instance_label) +
         $.queryPanel(
           'max by(%s) (cortex_alertmanager_tenants_owned{%s})' % [$._config.per_instance_label, $.jobMatcher($._config.job_names.alertmanager)],
           '{{%s}}' % $._config.per_instance_label
         ) +
         $.stack
       )
       .addPanel(
-        $.panel('Per %s Alerts' % $._config.per_instance_label) +
+        $.timeseriesPanel('Per %s Alerts' % $._config.per_instance_label) +
         $.queryPanel(
           'sum by(%s) (cluster_job_%s:cortex_alertmanager_alerts:sum{%s})' % [$._config.per_instance_label, $._config.per_instance_label, $.jobMatcher($._config.job_names.alertmanager)],
           '{{%s}}' % $._config.per_instance_label
         ) +
         $.stack
       )
       .addPanel(
-        $.panel('Per %s Silences' % $._config.per_instance_label) +
+        $.timeseriesPanel('Per %s Silences' % $._config.per_instance_label) +
         $.queryPanel(
           'sum by(%s) (cluster_job_%s:cortex_alertmanager_silences:sum{%s})' % [$._config.per_instance_label, $._config.per_instance_label, $.jobMatcher($._config.job_names.alertmanager)],
           '{{%s}}' % $._config.per_instance_label
@@ -121,7 +121,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
     .addRow(
       $.row('Tenant Configuration Sync')
       .addPanel(
-        $.panel('Syncs/sec') +
+        $.timeseriesPanel('Syncs/sec') +
         $.queryPanel(
           [
             |||
@@ -135,14 +135,14 @@ local utils = import 'mixin-utils/utils.libsonnet';
         )
       )
       .addPanel(
-        $.panel('Syncs/sec (By Reason)') +
+        $.timeseriesPanel('Syncs/sec (By Reason)') +
         $.queryPanel(
           'sum by(reason) (rate(cortex_alertmanager_sync_configs_total{%s}[$__rate_interval]))' % $.jobMatcher($._config.job_names.alertmanager),
           '{{reason}}'
         )
       )
       .addPanel(
-        $.panel('Ring Check Errors/sec') +
+        $.timeseriesPanel('Ring Check Errors/sec') +
         $.queryPanel(
           'sum (rate(cortex_alertmanager_ring_check_errors_total{%s}[$__rate_interval]))' % $.jobMatcher($._config.job_names.alertmanager),
           'errors'
@@ -152,7 +152,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
     .addRow(
       $.row('Sharding Initial State Sync')
       .addPanel(
-        $.panel('Initial syncs /sec') +
+        $.timeseriesPanel('Initial syncs /sec') +
         $.queryPanel(
           'sum by(outcome) (rate(cortex_alertmanager_state_initial_sync_completed_total{%s}[$__rate_interval]))' % $.jobMatcher($._config.job_names.alertmanager),
           '{{outcome}}'
@@ -166,7 +166,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
         }
       )
       .addPanel(
-        $.panel('Initial sync duration') +
+        $.timeseriesPanel('Initial sync duration', unit='s') +
         $.latencyPanel('cortex_alertmanager_state_initial_sync_duration_seconds', '{%s}' % $.jobMatcher($._config.job_names.alertmanager)) + {
           targets: [
             target {
@@ -177,7 +177,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
         }
       )
       .addPanel(
-        $.panel('Fetch state from other alertmanagers /sec') +
+        $.timeseriesPanel('Fetch state from other alertmanagers /sec') +
         $.queryPanel(
           [
             |||
@@ -201,7 +201,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
     .addRow(
       $.row('Sharding Runtime State Sync')
       .addPanel(
-        $.panel('Replicate state to other alertmanagers /sec') +
+        $.timeseriesPanel('Replicate state to other alertmanagers /sec') +
         $.queryPanel(
           [
             |||
@@ -215,7 +215,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
         )
       )
       .addPanel(
-        $.panel('Merge state from other alertmanagers /sec') +
+        $.timeseriesPanel('Merge state from other alertmanagers /sec') +
         $.queryPanel(
           [
             |||
@@ -229,7 +229,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
         )
       )
       .addPanel(
-        $.panel('Persist state to remote storage /sec') +
+        $.timeseriesPanel('Persist state to remote storage /sec') +
         $.queryPanel(
           [
             |||

diff --git a/cortex-mixin/dashboards/compactor.libsonnet b/cortex-mixin/dashboards/compactor.libsonnet
@@ -14,7 +14,6 @@ local utils = import 'mixin-utils/utils.libsonnet';
           'sum(rate(cortex_compactor_runs_failed_total{%s}[$__rate_interval]))' % $.jobMatcher($._config.job_names.compactor)
         ) +
         $.bars +
-        { yaxes: $.yaxes('ops') } +
         $.panelDescription(
           'Per-instance runs',
           |||
@@ -23,7 +22,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
         ),
       )
       .addPanel(
-        $.panel('Tenants compaction progress') +
+        $.timeseriesPanel('Tenants compaction progress') +
         $.queryPanel(|||
           (
             cortex_compactor_tenants_processing_succeeded{%s} +
@@ -44,9 +43,8 @@ local utils = import 'mixin-utils/utils.libsonnet';
     .addRow(
       $.row('')
       .addPanel(
-        $.panel('Compacted blocks / sec') +
+        $.timeseriesPanel('Compacted blocks / sec', unit='ops') +
         $.queryPanel('sum(rate(prometheus_tsdb_compactions_total{%s}[$__rate_interval]))' % $.jobMatcher($._config.job_names.compactor), 'blocks') +
-        { yaxes: $.yaxes('ops') } +
         $.panelDescription(
           'Compacted blocks / sec',
           |||
@@ -55,7 +53,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
         ),
       )
       .addPanel(
-        $.panel('Per-block compaction duration') +
+        $.timeseriesPanel('Per-block compaction duration', unit='s') +
         $.latencyPanel('prometheus_tsdb_compaction_duration_seconds', '{%s}' % $.jobMatcher($._config.job_names.compactor)) +
         $.panelDescription(
           'Per-block compaction duration',
@@ -68,11 +66,11 @@ local utils = import 'mixin-utils/utils.libsonnet';
     .addRow(
       $.row('')
       .addPanel(
-        $.panel('Average blocks / tenant') +
+        $.timeseriesPanel('Average blocks / tenant') +
         $.queryPanel('avg(max by(user) (cortex_bucket_blocks_count{%s}))' % $.jobMatcher($._config.job_names.compactor), 'avg'),
       )
       .addPanel(
-        $.panel('Tenants with largest number of blocks') +
+        $.timeseriesPanel('Tenants with largest number of blocks') +
         $.queryPanel('topk(10, max by(user) (cortex_bucket_blocks_count{%s}))' % $.jobMatcher($._config.job_names.compactor), '{{user}}') +
         $.panelDescription(
           'Tenants with largest number of blocks',
@@ -85,9 +83,8 @@ local utils = import 'mixin-utils/utils.libsonnet';
     .addRow(
       $.row('Garbage Collector')
       .addPanel(
-        $.panel('Blocks marked for deletion / sec') +
-        $.queryPanel('sum(rate(cortex_compactor_blocks_marked_for_deletion_total{%s}[$__rate_interval]))' % $.jobMatcher($._config.job_names.compactor), 'blocks') +
-        { yaxes: $.yaxes('ops') },
+        $.timeseriesPanel('Blocks marked for deletion / sec', unit='ops') +
+        $.queryPanel('sum(rate(cortex_compactor_blocks_marked_for_deletion_total{%s}[$__rate_interval]))' % $.jobMatcher($._config.job_names.compactor), 'blocks'),
       )
       .addPanel(
         $.successFailurePanel(
@@ -111,7 +108,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
         ) + { yaxes: $.yaxes('ops') }
       )
       .addPanel(
-        $.panel('Metadata Sync Duration') +
+        $.timeseriesPanel('Metadata Sync Duration', unit='ms') +
         // This metric tracks the duration of a per-tenant metadata sync.
         $.latencyPanel('cortex_compactor_meta_sync_duration_seconds', '{%s}' % $.jobMatcher($._config.job_names.compactor)),
       )

diff --git a/cortex-mixin/dashboards/config.libsonnet b/cortex-mixin/dashboards/config.libsonnet
@@ -8,19 +8,17 @@ local utils = import 'mixin-utils/utils.libsonnet';
     .addRow(
       $.row('Startup config file')
       .addPanel(
-        $.panel('Startup config file hashes') +
+        $.timeseriesPanel('Startup config file hashes', unit='instances') +
         $.queryPanel('count(cortex_config_hash{%s}) by (sha256)' % $.namespaceMatcher(), 'sha256:{{sha256}}') +
-        $.stack +
-        { yaxes: $.yaxes('instances') },
+        $.stack,
       )
     )
     .addRow(
       $.row('Runtime config file')
       .addPanel(
-        $.panel('Runtime config file hashes') +
+        $.timeseriesPanel('Runtime config file hashes', unit='instances') +
         $.queryPanel('count(cortex_runtime_config_hash{%s}) by (sha256)' % $.namespaceMatcher(), 'sha256:{{sha256}}') +
-        $.stack +
-        { yaxes: $.yaxes('instances') },
+        $.stack,
       )
     ),
 }