dashboard: add instance variable

Instance alias variable can be used to select displayed cluster
instances for a dashboard. For InfluxDB dashboards, set of instances is
based on available in database label_pairs_alias values. For Prometheus
dashboards, set of instances is based on available in database alias
labels of tnt_uptime_info metric.

After this patch, each panel (except for Prometheus cluster aggregation
panels) include instance filters in queries.

After this patch, there are two different forms of static build
dashboards are available: with or without instance variable.

Closes #181

Author: DifferentialOrange

CHANGELOG.md

@@ -4,6 +4,12 @@ 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
+
+### Added
+- Variable to select displayed cluster instances
+
+
 ## [1.4.0] - 2022-08-03
 Grafana revisions: [InfluxDB revision 14](https://grafana.com/api/dashboards/12567/revisions/14/download), [Prometheus revision 14](https://grafana.com/api/dashboards/13054/revisions/14/download), [InfluxDB TDG revision 3](https://grafana.com/api/dashboards/16405/revisions/3/download), [Prometheus TDG revision 3](https://grafana.com/api/dashboards/16406/revisions/3/download).
 

Makefile

@@ -1,6 +1,7 @@
 JOB ?= tarantool
 POLICY ?= autogen
 MEASUREMENT ?= tarantool_http
+WITH_INSTANCE_VARIABLE ?= FALSE
 OUTPUT_STATIC_DASHBOARD ?= dashboard.json
 
 .PHONY: build-deps
@@ -16,9 +17,11 @@ ifndef DATASOURCE
 		false
 endif
 	# JOB is optional, default is "tarantool"
+	# WITH_INSTANCE_VARIABLE is optional, default is "FALSE"
 	jsonnet -J ./vendor -J . \
 		--ext-str DATASOURCE=${DATASOURCE} \
 		--ext-str JOB=${JOB} \
+		--ext-str WITH_INSTANCE_VARIABLE=${WITH_INSTANCE_VARIABLE} \
 		dashboard/build/prometheus/${DASHBOARD_BUILD_SOURCE} -o ${OUTPUT_STATIC_DASHBOARD}
 
 .PHONY: build-static-prometheus
@@ -37,10 +40,12 @@ ifndef DATASOURCE
 endif
 	# POLICY is optional, default is "autogen"
 	# MEASUREMENT is optional, default is "tarantool_http"
+	# WITH_INSTANCE_VARIABLE is optional, default is "FALSE"
 	jsonnet -J ./vendor -J . \
 		--ext-str DATASOURCE=${DATASOURCE} \
 		--ext-str POLICY=${POLICY} \
 		--ext-str MEASUREMENT=${MEASUREMENT} \
+		--ext-str WITH_INSTANCE_VARIABLE=${WITH_INSTANCE_VARIABLE} \
 		dashboard/build/influxdb/${DASHBOARD_BUILD_SOURCE} -o ${OUTPUT_STATIC_DASHBOARD}
 
 .PHONY: build-static-influxdb

README.md

@@ -112,10 +112,12 @@ make test-deps
 ```
 to install build dependencies and dependencies that are required to run tests locally.
 
-To build a static dashboard with no input and dynamic variables, run `make` commands.
+To build a static dashboard with no input, run `make` commands.
 ```bash
 make DATASOURCE=Prometheus JOB=tarantool \
-     OUTPUT_STATIC_DASHBOARD=mydashboard.json build-static-prometheus
+     WITH_INSTANCE_VARIABLE=FALSE \
+     OUTPUT_STATIC_DASHBOARD=mydashboard.json \
+     build-static-prometheus
 ```
 Following targets are available:
 - `build-static-prometheus`: Tarantool dashboard for a Prometheus datasource;
@@ -126,14 +128,21 @@ Following targets are available:
 Variables for Prometheus targets:
 - `DATASOURCE`: name of a Prometheus data source;
 - `JOB` (optional, default `tarantool`): name of a Prometheus job collecting your application metrics;
+- `WITH_INSTANCE_VARIABLE` (optional, default `FALSE`): build a dashboard with variable which
+  can be used to select displayed cluster instances;
 - `OUTPUT_STATIC_DASHBOARD` (optional, default `dashboard.json`): compiled dashboard file.
 
 Variables for InfluxDB targets:
 - `DATASOURCE`: name of a InfluxDB data source;
 - `POLICY` (optional, default `autogen`): InfluxDB metrics retention policy;
 - `MEASUREMENT` (optional, default `tarantool_http`): name of a InfluxDB measurement with your application metrics;
+- `WITH_INSTANCE_VARIABLE` (optional, default `FALSE`): build a dashboard with variable which
+  can be used to select displayed cluster instances;
 - `OUTPUT_STATIC_DASHBOARD` (optional, default `dashboard.json`): compiled dashboard file.
 
+With `WITH_INSTANCE_VARIABLE=FALSE`, dashboard will contain no dynamic variables and Grafana alerts can be used.
+With `WITH_INSTANCE_VARIABLE=TRUE`, dashboard will contain instance dynamic variable (but no inputs).
+
 You can also compile configurable Prometheus dashboard template (the same we publish to
 Grafana Official & community built dashboards) with
 ```bash

dashboard/build/influxdb/dashboard.libsonnet

@@ -6,7 +6,8 @@ local variable = import 'dashboard/variable.libsonnet';
 dashboard_raw(
   datasource=variable.datasource.influxdb,
   policy=variable.influxdb.policy,
-  measurement=variable.influxdb.measurement
+  measurement=variable.influxdb.measurement,
+  alias=variable.influxdb.alias,
 ).addInput(
   name='DS_INFLUXDB',
   label='InfluxDB bank',
@@ -26,4 +27,15 @@ dashboard_raw(
   type='constant',
   value='autogen',
   description='InfluxDB Tarantool metrics policy'
+).addTemplate(
+  grafana.template.new(
+    name='alias',
+    datasource=variable.datasource.influxdb,
+    query=std.format('SHOW TAG VALUES FROM "%s" WITH KEY="label_pairs_alias"', variable.influxdb.measurement),
+    includeAll=true,
+    multi=true,
+    current='all',
+    label='Instances',
+    refresh='time',
+  )
 )

dashboard/build/influxdb/dashboard_raw.libsonnet

@@ -4,7 +4,7 @@ local dashboard = import 'dashboard/dashboard.libsonnet';
 local section = import 'dashboard/section.libsonnet';
 local variable = import 'dashboard/variable.libsonnet';
 
-function(datasource, policy, measurement) dashboard.new(
+function(datasource, policy, measurement, alias) dashboard.new(
   grafana.dashboard.new(
     title='Tarantool dashboard',
     description='Dashboard for Tarantool application and database server monitoring, based on grafonnet library.',
@@ -46,82 +46,94 @@ function(datasource, policy, measurement) dashboard.new(
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.http(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.net(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.slab(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.space(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.vinyl(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.cpu(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.runtime(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.luajit(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.operations(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.crud(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 ).addPanels(
   section.expirationd(
     datasource_type=variable.datasource_type.influxdb,
     datasource=datasource,
     policy=policy,
     measurement=measurement,
+    alias=alias,
   )
 )

dashboard/build/influxdb/dashboard_static.jsonnet

@@ -1,7 +1,41 @@
+local grafana = import 'grafonnet/grafana.libsonnet';
+
 local dashboard_raw = import 'dashboard/build/influxdb/dashboard_raw.libsonnet';
+local variable = import 'dashboard/variable.libsonnet';
+
+local DATASOURCE = std.extVar('DATASOURCE');
+local POLICY = std.extVar('POLICY');
+local MEASUREMENT = std.extVar('MEASUREMENT');
+local WITH_INSTANCE_VARIABLE = (std.asciiUpper(std.extVar('WITH_INSTANCE_VARIABLE')) == 'TRUE');
 
-dashboard_raw(
-  datasource=std.extVar('DATASOURCE'),
-  policy=std.extVar('POLICY'),
-  measurement=std.extVar('MEASUREMENT'),
-).build()
+if WITH_INSTANCE_VARIABLE then
+  dashboard_raw(
+    datasource=DATASOURCE,
+    policy=POLICY,
+    measurement=MEASUREMENT,
+    alias=variable.influxdb.alias,
+  ).addTemplate(
+    grafana.template.new(
+      name='alias',
+      datasource=DATASOURCE,
+      query=std.format(
+        'SHOW TAG VALUES FROM %(policy_prefix)s"%(measurement)s" WITH KEY="label_pairs_alias"',
+        {
+          policy_prefix: if POLICY == 'default' then '' else std.format('"%s".', POLICY),
+          measurement: MEASUREMENT,
+        },
+      ),
+      includeAll=true,
+      multi=true,
+      current='all',
+      label='Instances',
+      refresh='time',
+    )
+  ).build()
+else
+  dashboard_raw(
+    datasource=std.extVar('DATASOURCE'),
+    policy=std.extVar('POLICY'),
+    measurement=std.extVar('MEASUREMENT'),
+    alias='/^.*$/',
+  ).build()

dashboard/build/influxdb/tdg_dashboard.libsonnet

@@ -6,7 +6,8 @@ local variable = import 'dashboard/variable.libsonnet';
 tdg_dashboard_raw(
   datasource=variable.datasource.influxdb,
   policy=variable.influxdb.policy,
-  measurement=variable.influxdb.measurement
+  measurement=variable.influxdb.measurement,
+  alias=variable.influxdb.alias,
 ).addInput(
   name='DS_INFLUXDB',
   label='InfluxDB bank',
@@ -26,4 +27,15 @@ tdg_dashboard_raw(
   type='constant',
   value='autogen',
   description='InfluxDB Tarantool metrics policy'
+).addTemplate(
+  grafana.template.new(
+    name='alias',
+    datasource=variable.datasource.influxdb,
+    query=std.format('SHOW TAG VALUES FROM "%s" WITH KEY="label_pairs_alias"', variable.influxdb.measurement),
+    includeAll=true,
+    multi=true,
+    current='all',
+    label='Instances',
+    refresh='time',
+  )
 )