Skip to content

Commit

Permalink
custom: rename cartridge-specific sections
Browse files Browse the repository at this point in the history
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. tarantool/metrics#491

Part of #224
  • Loading branch information
DifferentialOrange committed Jul 8, 2024
1 parent 573bd17 commit 90d2027
Show file tree
Hide file tree
Showing 13 changed files with 63 additions and 57 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
18 changes: 9 additions & 9 deletions config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -131,8 +131,8 @@ sections:
# job: ['=', 'MyJobWithTarantoolMetrics'],
# }
# sections:
# - cluster
# - replication
# - cluster_cartridge
# - replication_cartridge
# - http
# - net
# - slab
Expand All @@ -150,8 +150,8 @@ sections:
# job: ['=', 'MyJobWithTDGMetrics'],
# }
# sections:
# - cluster
# - replication
# - cluster_cartridge
# - replication_cartridge
# - http
# - net
# - slab
Expand Down
8 changes: 4 additions & 4 deletions dashboard/build/config.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ local variable = import 'dashboard/variable.libsonnet';
filters: {},
metrics_prefix: '',
sections: [
'cluster',
'replication',
'cluster_cartridge',
'replication_cartridge',
'http',
'net',
'slab',
Expand All @@ -54,8 +54,8 @@ local variable = import 'dashboard/variable.libsonnet';
filters: {},
metrics_prefix: '',
sections: [
'cluster',
'replication',
'cluster_cartridge',
'replication_cartridge',
'http',
'net',
'slab',
Expand Down
8 changes: 4 additions & 4 deletions dashboard/build/from_ext_var.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -41,8 +41,8 @@ local sections =
'expirationd',
]
else if DASHBOARD_TEMPLATE == 'TDG' then [
'cluster',
'replication',
'cluster_cartridge',
'replication_cartridge',
'net',
'slab',
'mvcc',
Expand Down
4 changes: 2 additions & 2 deletions dashboard/section.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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 } },
Expand Down Expand Up @@ -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),
Expand Down
4 changes: 2 additions & 2 deletions tests/InfluxDB/dashboard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ measurement: '$measurement'
filters:
label_pairs_alias: ['=~', '/^$alias$/']
sections:
- cluster
- replication
- cluster_cartridge
- replication_cartridge
- http
- net
- slab
Expand Down
4 changes: 2 additions & 2 deletions tests/InfluxDB/dashboard_custom.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ filters:
vendor_app_tag: ['=', 'MyCacheApplication']
metrics_prefix: vendor_tt_
sections:
- cluster
- replication
- cluster_cartridge
- replication_cartridge
- http
- net
- slab
Expand Down
4 changes: 2 additions & 2 deletions tests/InfluxDB/dashboard_tdg.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ measurement: "$measurement"
filters:
label_pairs_alias: ['=~', '/^$alias$/']
sections:
- cluster
- replication
- cluster_cartridge
- replication_cartridge
- net
- slab
- mvcc
Expand Down
4 changes: 2 additions & 2 deletions tests/Prometheus/dashboard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ filters:
job: ['=~', '$job']
alias: ['=~', '$alias']
sections:
- cluster
- replication
- cluster_cartridge
- replication_cartridge
- http
- net
- slab
Expand Down
4 changes: 2 additions & 2 deletions tests/Prometheus/dashboard_custom.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ filters:
vendor_app_label: ['=', 'MyCacheApplication']
metrics_prefix: vendor_tt_
sections:
- cluster
- replication
- cluster_cartridge
- replication_cartridge
- http
- net
- slab
Expand Down
4 changes: 2 additions & 2 deletions tests/Prometheus/dashboard_tdg.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ filters:
job: ['=~', '$job']
alias: ['=~', '$alias']
sections:
- cluster
- replication
- cluster_cartridge
- replication_cartridge
- net
- slab
- mvcc
Expand Down
8 changes: 4 additions & 4 deletions tests/unit/config.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ local config_example = importstr 'config.yml';
job: ['=', 'MyJobWithTarantoolMetrics'],
}
sections:
- cluster
- replication
- cluster_cartridge
- replication_cartridge
- http
- net
- slab
Expand All @@ -68,8 +68,8 @@ local config_example = importstr 'config.yml';
job: ['=', 'MyJobWithTDGMetrics'],
}
sections:
- cluster
- replication
- cluster_cartridge
- replication_cartridge
- http
- net
- slab
Expand Down
44 changes: 22 additions & 22 deletions tests/unit/config_compiled.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
"metrics_prefix": "",
"policy": "$policy",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand All @@ -37,8 +37,8 @@
],
"metrics_prefix": "",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand Down Expand Up @@ -73,8 +73,8 @@
],
"metrics_prefix": "",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand Down Expand Up @@ -107,8 +107,8 @@
"metrics_prefix": "",
"policy": "$policy",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand Down Expand Up @@ -136,8 +136,8 @@
"metrics_prefix": "",
"policy": "default",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand Down Expand Up @@ -172,8 +172,8 @@
],
"metrics_prefix": "",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand Down Expand Up @@ -205,8 +205,8 @@
],
"metrics_prefix": "",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand Down Expand Up @@ -248,8 +248,8 @@
],
"metrics_prefix": "",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand Down Expand Up @@ -284,8 +284,8 @@
],
"metrics_prefix": "",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand Down Expand Up @@ -316,8 +316,8 @@
],
"metrics_prefix": "",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand All @@ -340,8 +340,8 @@
"metrics_prefix": "",
"policy": "$policy",
"sections": [
"cluster",
"replication",
"cluster_cartridge",
"replication_cartridge",
"http",
"net",
"slab",
Expand Down

0 comments on commit 90d2027

Please sign in to comment.