From 90d2027774a921fb799ee79a6cf5b72cdfecd4d0 Mon Sep 17 00:00:00 2001 From: Georgy Moiseev Date: Mon, 8 Jul 2024 11:19:09 +0300 Subject: [PATCH] custom: rename cartridge-specific sections This patch renames `cluster` and `replication` overview panels sections to `cluster_cartridge` and `replication_cartridge` since they use Cartridge-specific metrics [1]. This is a breaking change for all custom-built dashboard which had used them. It has no effect on our published dashboards. 1. https://github.com/tarantool/metrics/pull/491 Part of #224 --- CHANGELOG.md | 6 ++++ config.yml | 18 +++++------ dashboard/build/config.libsonnet | 8 ++--- dashboard/build/from_ext_var.jsonnet | 8 ++--- dashboard/section.libsonnet | 4 +-- tests/InfluxDB/dashboard.yml | 4 +-- tests/InfluxDB/dashboard_custom.yml | 4 +-- tests/InfluxDB/dashboard_tdg.yml | 4 +-- tests/Prometheus/dashboard.yml | 4 +-- tests/Prometheus/dashboard_custom.yml | 4 +-- tests/Prometheus/dashboard_tdg.yml | 4 +-- tests/unit/config.jsonnet | 8 ++--- tests/unit/config_compiled.json | 44 +++++++++++++-------------- 13 files changed, 63 insertions(+), 57 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index efa26959..e2638888 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased +### Changed +- Renamed build `cluster` panels section to `cluster_cartridge`. + It affects all custom-built dashboards which had used `cluster` (#224) +- Renamed build `replication` panels section to `replication_cartridge`. + It affects all custom-built dashboards which had used `replication` (#224) + ### Fixed - Removed extra quotation mark for TDG jobs_average_panel query (#220) diff --git a/config.yml b/config.yml index 74f87c65..f1823b42 100644 --- a/config.yml +++ b/config.yml @@ -58,8 +58,8 @@ metrics_prefix: '' # sections are dashboard panels sections to be included # The list of supported sections: -# - cluster -# - replication +# - cluster_cartridge +# - replication_cartridge # - http # - net # - slab @@ -84,10 +84,10 @@ metrics_prefix: '' # - tdg_iproto # - tdg_rest_api # - tdg_tasks -# default is [cluster, replication, http, net, slab, mvcc, space, vinyl, cpu, runtime, luajit, operations, crud, expirationd] +# default is [cluster_cartridge, replication_cartridge, http, net, slab, mvcc, space, vinyl, cpu, runtime, luajit, operations, crud, expirationd] sections: -- cluster -- replication +- cluster_cartridge +- replication_cartridge - http - net - slab @@ -131,8 +131,8 @@ sections: # job: ['=', 'MyJobWithTarantoolMetrics'], # } # sections: -# - cluster -# - replication +# - cluster_cartridge +# - replication_cartridge # - http # - net # - slab @@ -150,8 +150,8 @@ sections: # job: ['=', 'MyJobWithTDGMetrics'], # } # sections: -# - cluster -# - replication +# - cluster_cartridge +# - replication_cartridge # - http # - net # - slab diff --git a/dashboard/build/config.libsonnet b/dashboard/build/config.libsonnet index d55137b3..7174ebfb 100644 --- a/dashboard/build/config.libsonnet +++ b/dashboard/build/config.libsonnet @@ -27,8 +27,8 @@ local variable = import 'dashboard/variable.libsonnet'; filters: {}, metrics_prefix: '', sections: [ - 'cluster', - 'replication', + 'cluster_cartridge', + 'replication_cartridge', 'http', 'net', 'slab', @@ -54,8 +54,8 @@ local variable = import 'dashboard/variable.libsonnet'; filters: {}, metrics_prefix: '', sections: [ - 'cluster', - 'replication', + 'cluster_cartridge', + 'replication_cartridge', 'http', 'net', 'slab', diff --git a/dashboard/build/from_ext_var.jsonnet b/dashboard/build/from_ext_var.jsonnet index 9d0d8352..1a77d498 100644 --- a/dashboard/build/from_ext_var.jsonnet +++ b/dashboard/build/from_ext_var.jsonnet @@ -25,8 +25,8 @@ local grafana_tags = else if DASHBOARD_TEMPLATE == 'TDG' then ['tarantool', 'TDG']; local sections = if DASHBOARD_TEMPLATE == 'Tarantool' then [ - 'cluster', - 'replication', + 'cluster_cartridge', + 'replication_cartridge', 'http', 'net', 'slab', @@ -41,8 +41,8 @@ local sections = 'expirationd', ] else if DASHBOARD_TEMPLATE == 'TDG' then [ - 'cluster', - 'replication', + 'cluster_cartridge', + 'replication_cartridge', 'net', 'slab', 'mvcc', diff --git a/dashboard/section.libsonnet b/dashboard/section.libsonnet index 38c6901b..b32d1cae 100644 --- a/dashboard/section.libsonnet +++ b/dashboard/section.libsonnet @@ -27,7 +27,7 @@ local tdg_tuples = import 'dashboard/panels/tdg/tuples.libsonnet'; local vinyl = import 'dashboard/panels/vinyl.libsonnet'; { - cluster(cfg):: if cfg.type == variable.datasource_type.prometheus then [ + cluster_cartridge(cfg):: if cfg.type == variable.datasource_type.prometheus then [ // Must be used only in the top of a dashboard, overall stat panels use complicated layout cluster.row, cluster.health_overview_table(cfg) { gridPos: { w: 12, h: 8, x: 0, y: 1 } }, @@ -57,7 +57,7 @@ local vinyl = import 'dashboard/panels/vinyl.libsonnet'; cluster.election_term(cfg), ], - replication(cfg):: [ + replication_cartridge(cfg):: [ replication.row, replication.replication_status(cfg), replication.replication_lag(cfg), diff --git a/tests/InfluxDB/dashboard.yml b/tests/InfluxDB/dashboard.yml index efe7e31f..fa5d2b9e 100644 --- a/tests/InfluxDB/dashboard.yml +++ b/tests/InfluxDB/dashboard.yml @@ -8,8 +8,8 @@ measurement: '$measurement' filters: label_pairs_alias: ['=~', '/^$alias$/'] sections: -- cluster -- replication +- cluster_cartridge +- replication_cartridge - http - net - slab diff --git a/tests/InfluxDB/dashboard_custom.yml b/tests/InfluxDB/dashboard_custom.yml index 0bac87d6..dad51eaa 100644 --- a/tests/InfluxDB/dashboard_custom.yml +++ b/tests/InfluxDB/dashboard_custom.yml @@ -10,8 +10,8 @@ filters: vendor_app_tag: ['=', 'MyCacheApplication'] metrics_prefix: vendor_tt_ sections: -- cluster -- replication +- cluster_cartridge +- replication_cartridge - http - net - slab diff --git a/tests/InfluxDB/dashboard_tdg.yml b/tests/InfluxDB/dashboard_tdg.yml index ccf8be6e..9ebce807 100644 --- a/tests/InfluxDB/dashboard_tdg.yml +++ b/tests/InfluxDB/dashboard_tdg.yml @@ -8,8 +8,8 @@ measurement: "$measurement" filters: label_pairs_alias: ['=~', '/^$alias$/'] sections: - - cluster - - replication + - cluster_cartridge + - replication_cartridge - net - slab - mvcc diff --git a/tests/Prometheus/dashboard.yml b/tests/Prometheus/dashboard.yml index ce156dc5..dc98d265 100644 --- a/tests/Prometheus/dashboard.yml +++ b/tests/Prometheus/dashboard.yml @@ -7,8 +7,8 @@ filters: job: ['=~', '$job'] alias: ['=~', '$alias'] sections: -- cluster -- replication +- cluster_cartridge +- replication_cartridge - http - net - slab diff --git a/tests/Prometheus/dashboard_custom.yml b/tests/Prometheus/dashboard_custom.yml index a0881c98..486e8864 100644 --- a/tests/Prometheus/dashboard_custom.yml +++ b/tests/Prometheus/dashboard_custom.yml @@ -8,8 +8,8 @@ filters: vendor_app_label: ['=', 'MyCacheApplication'] metrics_prefix: vendor_tt_ sections: -- cluster -- replication +- cluster_cartridge +- replication_cartridge - http - net - slab diff --git a/tests/Prometheus/dashboard_tdg.yml b/tests/Prometheus/dashboard_tdg.yml index c935744f..e337c478 100644 --- a/tests/Prometheus/dashboard_tdg.yml +++ b/tests/Prometheus/dashboard_tdg.yml @@ -7,8 +7,8 @@ filters: job: ['=~', '$job'] alias: ['=~', '$alias'] sections: -- cluster -- replication +- cluster_cartridge +- replication_cartridge - net - slab - mvcc diff --git a/tests/unit/config.jsonnet b/tests/unit/config.jsonnet index 6717e0bd..a810fd49 100644 --- a/tests/unit/config.jsonnet +++ b/tests/unit/config.jsonnet @@ -48,8 +48,8 @@ local config_example = importstr 'config.yml'; job: ['=', 'MyJobWithTarantoolMetrics'], } sections: - - cluster - - replication + - cluster_cartridge + - replication_cartridge - http - net - slab @@ -68,8 +68,8 @@ local config_example = importstr 'config.yml'; job: ['=', 'MyJobWithTDGMetrics'], } sections: - - cluster - - replication + - cluster_cartridge + - replication_cartridge - http - net - slab diff --git a/tests/unit/config_compiled.json b/tests/unit/config_compiled.json index 425557dc..b6a5dcd1 100644 --- a/tests/unit/config_compiled.json +++ b/tests/unit/config_compiled.json @@ -10,8 +10,8 @@ "metrics_prefix": "", "policy": "$policy", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -37,8 +37,8 @@ ], "metrics_prefix": "", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -73,8 +73,8 @@ ], "metrics_prefix": "", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -107,8 +107,8 @@ "metrics_prefix": "", "policy": "$policy", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -136,8 +136,8 @@ "metrics_prefix": "", "policy": "default", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -172,8 +172,8 @@ ], "metrics_prefix": "", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -205,8 +205,8 @@ ], "metrics_prefix": "", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -248,8 +248,8 @@ ], "metrics_prefix": "", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -284,8 +284,8 @@ ], "metrics_prefix": "", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -316,8 +316,8 @@ ], "metrics_prefix": "", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab", @@ -340,8 +340,8 @@ "metrics_prefix": "", "policy": "$policy", "sections": [ - "cluster", - "replication", + "cluster_cartridge", + "replication_cartridge", "http", "net", "slab",