dashboard: use consistent style for requirements

Before this patch, two different styles were used to note possible
metrics display issues: one similar to luarocks and human-readable one
for non-rock entities. This patch updated these descriptions
to be consistent.

Author: DifferentialOrange

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Changed
+- Use consistent style for panel requirements (PR #231)
+
+### Fixed
+- Missing panel requirement for vinyl Bloom filter panel (PR #231)
+
+
 ## [3.0.0] - 2024-07-09
 Grafana revisions:
 - Tarantool 3:

dashboard/panels/cluster.libsonnet

@@ -345,8 +345,8 @@ local prometheus = grafana.prometheus;
       failover and switchover issues, clock issues, memory fragmentation,
       configuration issues and alien members warnings.
 
-      Panel works with `cartridge >= 2.0.2`, `metrics >= 0.6.0`,
-      while `metrics >= 0.9.0` is recommended for per instance display.
+      Panel minimal requirements: cartridge 2.0.2, metrics 0.6.0;
+      at least metrics 0.9.0 is recommended for per instance display.
     |||,
   ):: cartridge_issues(
     cfg,
@@ -363,8 +363,8 @@ local prometheus = grafana.prometheus;
       "critical" issues includes replication process critical fails and
       running out of available memory.
 
-      Panel works with `cartridge >= 2.0.2`, `metrics >= 0.6.0`,
-      while `metrics >= 0.9.0` is recommended for per instance display.
+      Panel minimal requirements: cartridge 2.0.2, metrics 0.6.0;
+      at least metrics 0.9.0 is recommended for per instance display.
     |||,
   ):: cartridge_issues(
     cfg,
@@ -380,7 +380,7 @@ local prometheus = grafana.prometheus;
       Displays the count of failover triggers in a replicaset.
       Graph shows average per second.
 
-      Panel works with `metrics >= 0.15.0`.
+      Panel minimal requirements: metrics 0.15.0.
     |||,
   ):: common.default_graph(
     cfg,
@@ -400,7 +400,7 @@ local prometheus = grafana.prometheus;
       write operations. `replica` status means instance is
       available only for read operations.
 
-      Panel works with `metrics >= 0.11.0` and Grafana 8.x.
+      Panel minimal requirements: metrics 0.11.0, Grafana 8.
     |||,
     panel_width=12,
   ):: timeseries.new(
@@ -423,7 +423,7 @@ local prometheus = grafana.prometheus;
   local election_warning(description) = std.join(
     '\n',
     [description, |||
-      Panel works with metrics 0.15.0 or newer, Tarantool 2.6.1 or newer.
+      Panel minimal requirements: metrics 0.15.0, Tarantool 2.6.1.
     |||]
   ),
 
@@ -438,7 +438,7 @@ local prometheus = grafana.prometheus;
       `candidate`s are nodes that start a new election round.
       `leader` is a node that collected a quorum of votes.
 
-      Panel works with Grafana 8.x.
+      Panel minimal requirements: Grafana 8.
     |||),
   ):: timeseries.new(
     title=title,

dashboard/panels/cpu.libsonnet

@@ -34,7 +34,7 @@ local prometheus = grafana.prometheus;
       spent by instance process executing in user mode.
       Metrics obtained using `getrusage()` call.
 
-      Panel works with `metrics >= 0.8.0`.
+      Panel minimal requirements: metrics 0.8.0.
     |||,
   ):: getrusage_cpu_percentage_graph(
     cfg=cfg,
@@ -51,7 +51,7 @@ local prometheus = grafana.prometheus;
       spent by instance process executing in kernel mode.
       Metrics obtained using `getrusage()` call.
 
-      Panel works with `metrics >= 0.8.0`.
+      Panel minimal requirements: metrics 0.8.0.
     |||,
   ):: getrusage_cpu_percentage_graph(
     cfg=cfg,

dashboard/panels/luajit.libsonnet

@@ -4,10 +4,10 @@ local common = import 'dashboard/panels/common.libsonnet';
   row:: common.row('Tarantool LuaJit statistics'),
 
   local version_warning(description) =
-    std.join('\n\n', [description, 'Panel works with `metrics >= 0.6.0` and `Tarantool >= 2.6`.']),
+    std.join('\n\n', [description, 'Panel minimal requirements: metrics 0.6.0, Tarantool 2.6.']),
 
   local version_warning_renamed(description) =
-    std.join('\n\n', [description, 'Panel works with `metrics >= 0.15.0` and `Tarantool >= 2.6`.']),
+    std.join('\n\n', [description, 'Panel minimal requirements: metrics 0.15.0, Tarantool 2.6.']),
 
   snap_restores(
     cfg,

dashboard/panels/mvcc.libsonnet

@@ -12,7 +12,7 @@ local prometheus = grafana.prometheus;
   local mvcc_warning(description) = std.join(
     '\n',
     [description, |||
-      Panel works with metrics 0.15.1 or newer, Tarantool 2.10 or newer.
+      Panel minimal requirements: metrics 0.15.1, Tarantool 2.10.
     |||]
   ),
 

dashboard/panels/net.libsonnet

@@ -114,7 +114,7 @@ local prometheus = grafana.prometheus;
     description=|||
       Average number of requests processed by tx thread per second.
 
-      Panel works with `metrics >= 0.13.0` and `Tarantool >= 2.10-beta2`.
+      Panel minimal requirements: metrics 0.13.0, Tarantool 2.10-beta2.
     |||,
   ):: common.default_graph(
     cfg,
@@ -132,7 +132,7 @@ local prometheus = grafana.prometheus;
     description=|||
       Number of requests currently being processed in the tx thread.
 
-      Panel works with `metrics >= 0.13.0` and `Tarantool >= 2.10-beta2`.
+      Panel minimal requirements: metrics 0.13.0, Tarantool 2.10-beta2.
     |||,
   ):: common.default_graph(
     cfg,
@@ -152,7 +152,7 @@ local prometheus = grafana.prometheus;
       Average number of requests which was placed in queues
       of streams per second.
 
-      Panel works with `metrics >= 0.13.0` and `Tarantool >= 2.10-beta2`.
+      Panel minimal requirements: metrics 0.13.0, Tarantool 2.10-beta2.
     |||,
   ):: common.default_graph(
     cfg,
@@ -170,7 +170,7 @@ local prometheus = grafana.prometheus;
     description=|||
       Number of requests currently waiting in queues of streams.
 
-      Panel works with `metrics >= 0.13.0` and `Tarantool >= 2.10-beta2`.
+      Panel minimal requirements: metrics 0.13.0, Tarantool 2.10-beta2.
     |||,
   ):: common.default_graph(
     cfg,
@@ -219,7 +219,7 @@ local prometheus = grafana.prometheus;
   local per_thread_warning(description) = std.join(
     '\n',
     [description, |||
-      Panel works with metrics 0.15.0 or newer, Tarantool 2.10 or newer.
+      Panel minimal requirements: metrics 0.15.0, Tarantool 2.10.
     |||]
   ),
 

dashboard/panels/operations.libsonnet

@@ -182,7 +182,7 @@ local prometheus = grafana.prometheus;
       SQL prepare calls.
       Graph shows average calls per second.
 
-      Panel works with Tarantool 2.x.
+      Panel minimal requirements: Tarantool 2.
     |||,
   ):: operation_rps(
     cfg,
@@ -199,7 +199,7 @@ local prometheus = grafana.prometheus;
       SQL execute calls.
       Graph shows average calls per second.
 
-      Panel works with Tarantool 2.x.
+      Panel minimal requirements: Tarantool 2.
     |||,
   ):: operation_rps(
     cfg,
@@ -218,7 +218,7 @@ local prometheus = grafana.prometheus;
       operations with `TRANSACTION START` and IPROTO_BEGIN operations.
       Graph shows average calls per second.
 
-      Panel works with Tarantool 2.10 or newer.
+      Panel minimal requirements: Tarantool 2.10.
     |||,
   ):: operation_rps(
     cfg,
@@ -237,7 +237,7 @@ local prometheus = grafana.prometheus;
       operations with `COMMIT` and IPROTO_COMMIT operations.
       Graph shows average calls per second.
 
-      Panel works with Tarantool 2.10 or newer.
+      Panel minimal requirements: Tarantool 2.10.
     |||,
   ):: operation_rps(
     cfg,
@@ -256,7 +256,7 @@ local prometheus = grafana.prometheus;
       operations with `ROLLBACK` and IPROTO_ROLLBACK operations.
       Graph shows average calls per second.
 
-      Panel works with Tarantool 2.10 or newer.
+      Panel minimal requirements: Tarantool 2.10.
     |||,
   ):: operation_rps(
     cfg,

dashboard/panels/replication.libsonnet

@@ -17,7 +17,7 @@ local prometheus = grafana.prometheus;
       `follows` status means replication is running.
       Otherwise, `not running` is displayed.
 
-      Panel works with `metrics >= 0.13.0` and Grafana 8.x.
+      Panel minimal requirements: metrics 0.13.0, Grafana 8.
     |||,
     panel_width=8,
   ):: timeseries.new(
@@ -52,7 +52,7 @@ local prometheus = grafana.prometheus;
     description=|||
       Replication lag value for Tarantool instance.
 
-      Panel works with `metrics >= 0.13.0`.
+      Panel minimal requirements: metrics 0.13.0.
     |||,
     panel_width=8,
   ):: common.default_graph(
@@ -83,7 +83,7 @@ local prometheus = grafana.prometheus;
       max shows difference with the fastest clock (always positive),
       min shows difference with the slowest clock (always negative).
 
-      Panel works with `metrics >= 0.10.0`.
+      Panel minimal requirements: metrics 0.10.0.
     |||,
   ):: common.default_graph(
     cfg,
@@ -110,7 +110,7 @@ local prometheus = grafana.prometheus;
   local syncro_warning(description) = std.join(
     '\n',
     [description, |||
-      Panel works with metrics 0.15.0 or newer, Tarantool 2.8.1 or newer.
+      Panel minimal requirements: metrics 0.15.0, Tarantool 2.8.1.
     |||]
   ),
 
@@ -174,7 +174,7 @@ local prometheus = grafana.prometheus;
     description=syncro_warning(|||
       Whether the queue is processing any system entry (CONFIRM/ROLLBACK/PROMOTE/DEMOTE).
 
-      Panel works with Grafana 8.x.
+      Panel minimal requirements: Grafana 8.
     |||),
   ):: timeseries.new(
     title=title,

dashboard/panels/runtime.libsonnet

@@ -70,9 +70,9 @@ local common = import 'dashboard/panels/common.libsonnet';
     cfg,
     title='Number of fibers',
     description=|||
-      Current number of fibers in tx thread. 
+      Current number of fibers in tx thread.
 
-      Panel works with `metrics >= 0.13.0`.
+      Panel minimal requirements: metrics 0.13.0.
     |||,
   ):: common.default_graph(
     cfg,
@@ -152,7 +152,7 @@ local common = import 'dashboard/panels/common.libsonnet';
       possible bad health signals and may be the
       reason of "Too long WAL write" errors.
 
-      Panel works with `metrics >= 0.13.0`.
+      Panel minimal requirements: metrics 0.13.0.
     |||,
   ):: common.default_graph(
     cfg,

dashboard/panels/space.libsonnet

@@ -66,9 +66,9 @@ local prometheus = grafana.prometheus;
       to enable it you must set global variable
       include_vinyl_count to true. Beware that
       count() operation scans the space and may
-      slow down your app. 
+      slow down your app.
 
-      Panel works with `metrics >= 0.13.0`.
+      Panel minimal requirements: metrics 0.13.0.
     |||,
   ):: count(
     cfg,
@@ -118,8 +118,7 @@ local prometheus = grafana.prometheus;
         |||,
         if cfg.type == variable.datasource_type.influxdb then
           |||
-            `No data` may be displayed because of tarantool/metrics issue #321,
-            use `metrics >= 0.12.0` to fix.
+            Panel minimal requirements: metrics 0.12.0.
           |||
         else null,
       ]
@@ -171,8 +170,7 @@ local prometheus = grafana.prometheus;
         |||,
         if cfg.type == variable.datasource_type.influxdb then
           |||
-            `No data` may be displayed because of tarantool/metrics issue #321,
-            use `metrics >= 0.12.0` to fix.
+            Panel minimal requirements: metrics 0.12.0.
           |||
         else null,
       ]