dashboard: support title customization

Support title customization for dynamic code build and static build with
make.

Author: DifferentialOrange

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+- Dashboard title customization
+
 ### Changed
 - Replace LuaJit deprecated metrics with new ones
 - Set Prometheus `job` dynamically

Makefile

@@ -3,6 +3,7 @@ POLICY ?= autogen
 MEASUREMENT ?= tarantool_http
 WITH_INSTANCE_VARIABLE ?= FALSE
 OUTPUT_STATIC_DASHBOARD ?= dashboard.json
+TITLE ?= 
 
 .PHONY: build-deps
 build-deps:
@@ -18,10 +19,13 @@ ifndef DATASOURCE
 endif
 	# JOB is optional, default is "tarantool"
 	# WITH_INSTANCE_VARIABLE is optional, default is "FALSE"
+	# TITLE is optional, default is "Tarantool dashboard" for plain dashboard
+	#                    and "Tarantool Data Grid dashboard" for TDG one
 	jsonnet -J ./vendor -J . \
 		--ext-str DATASOURCE=${DATASOURCE} \
 		--ext-str JOB=${JOB} \
 		--ext-str WITH_INSTANCE_VARIABLE=${WITH_INSTANCE_VARIABLE} \
+		--ext-str TITLE='${TITLE}' \
 		dashboard/build/prometheus/${DASHBOARD_BUILD_SOURCE} -o ${OUTPUT_STATIC_DASHBOARD}
 
 .PHONY: build-static-prometheus
@@ -41,11 +45,14 @@ endif
 	# POLICY is optional, default is "autogen"
 	# MEASUREMENT is optional, default is "tarantool_http"
 	# WITH_INSTANCE_VARIABLE is optional, default is "FALSE"
+	# TITLE is optional, default is "Tarantool dashboard" for plain dashboard
+	#                    and "Tarantool Data Grid dashboard" for TDG one
 	jsonnet -J ./vendor -J . \
 		--ext-str DATASOURCE=${DATASOURCE} \
 		--ext-str POLICY=${POLICY} \
 		--ext-str MEASUREMENT=${MEASUREMENT} \
 		--ext-str WITH_INSTANCE_VARIABLE=${WITH_INSTANCE_VARIABLE} \
+		--ext-str TITLE='${TITLE}' \
 		dashboard/build/influxdb/${DASHBOARD_BUILD_SOURCE} -o ${OUTPUT_STATIC_DASHBOARD}
 
 .PHONY: build-static-influxdb

README.md

@@ -113,6 +113,8 @@ Variables for Prometheus targets:
 - `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;
+- `TITLE` (optional, default `"Tarantool dashboard"` for plain dashboard
+  and `"Tarantool Data Grid dashobard"` for TDG dashboard): dashboard title;
 - `OUTPUT_STATIC_DASHBOARD` (optional, default `dashboard.json`): compiled dashboard file.
 
 Variables for InfluxDB targets:
@@ -121,6 +123,8 @@ Variables for InfluxDB targets:
 - `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;
+- `TITLE` (optional, default `"Tarantool dashboard"` for plain dashboard
+  and `"Tarantool Data Grid dashobard"` for TDG dashboard): dashboard title;
 - `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.

dashboard/build/influxdb/dashboard_raw.libsonnet

@@ -4,9 +4,16 @@ local dashboard = import 'dashboard/dashboard.libsonnet';
 local section = import 'dashboard/section.libsonnet';
 local variable = import 'dashboard/variable.libsonnet';
 
-function(datasource, policy, measurement, alias) dashboard.new(
+function(
+  datasource,
+  policy,
+  measurement,
+  alias,
+  title='',
+) dashboard.new(
   grafana.dashboard.new(
-    title='Tarantool dashboard',
+    // Cannot use in-built means to work with defaults due to possible ext vars.
+    title=(if title != '' then title else 'Tarantool dashboard'),
     description='Dashboard for Tarantool application and database server monitoring, based on grafonnet library.',
     editable=true,
     schemaVersion=21,

dashboard/build/influxdb/dashboard_static.jsonnet

@@ -7,13 +7,15 @@ 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');
+local TITLE = std.extVar('TITLE');
 
 if WITH_INSTANCE_VARIABLE then
   dashboard_raw(
     datasource=DATASOURCE,
     policy=POLICY,
     measurement=MEASUREMENT,
     alias=variable.influxdb.alias,
+    title=TITLE,
   ).addTemplate(
     grafana.template.new(
       name='alias',
@@ -38,4 +40,5 @@ else
     policy=std.extVar('POLICY'),
     measurement=std.extVar('MEASUREMENT'),
     alias='/^.*$/',
+    title=TITLE,
   ).build()

dashboard/build/influxdb/tdg_dashboard_raw.libsonnet

@@ -4,9 +4,16 @@ local dashboard = import 'dashboard/dashboard.libsonnet';
 local section = import 'dashboard/section.libsonnet';
 local variable = import 'dashboard/variable.libsonnet';
 
-function(datasource, policy, measurement, alias) dashboard.new(
+function(
+  datasource,
+  policy,
+  measurement,
+  alias,
+  title='',
+) dashboard.new(
   grafana.dashboard.new(
-    title='Tarantool Data Grid dashboard',
+    // Cannot use in-built means to work with defaults due to possible ext vars.
+    title=(if title != '' then title else 'Tarantool Data Grid dashboard'),
     description='Dashboard for Tarantool Data Grid ver. 2 application monitoring, based on grafonnet library.',
     editable=true,
     schemaVersion=21,

dashboard/build/influxdb/tdg_dashboard_static.jsonnet

@@ -7,13 +7,15 @@ 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');
+local TITLE = std.extVar('TITLE');
 
 if WITH_INSTANCE_VARIABLE then
   tdg_dashboard_raw(
     datasource=DATASOURCE,
     policy=POLICY,
     measurement=MEASUREMENT,
     alias=variable.influxdb.alias,
+    title=TITLE,
   ).addTemplate(
     grafana.template.new(
       name='alias',
@@ -38,4 +40,5 @@ else
     policy=std.extVar('POLICY'),
     measurement=std.extVar('MEASUREMENT'),
     alias='/^.*$/',
+    title=TITLE,
   ).build()

dashboard/build/prometheus/dashboard_raw.libsonnet

@@ -4,9 +4,15 @@ local dashboard = import 'dashboard/dashboard.libsonnet';
 local section = import 'dashboard/section.libsonnet';
 local variable = import 'dashboard/variable.libsonnet';
 
-function(datasource, job, alias) dashboard.new(
+function(
+  datasource,
+  job,
+  alias,
+  title='',
+) dashboard.new(
   grafana.dashboard.new(
-    title='Tarantool dashboard',
+    // Cannot use in-built means to work with defaults due to possible ext vars.
+    title=(if title != '' then title else 'Tarantool dashboard'),
     description='Dashboard for Tarantool application and database server monitoring, based on grafonnet library.',
     editable=true,
     schemaVersion=21,

dashboard/build/prometheus/dashboard_static.jsonnet

@@ -6,12 +6,14 @@ local variable = import 'dashboard/variable.libsonnet';
 local DATASOURCE = std.extVar('DATASOURCE');
 local JOB = std.extVar('JOB');
 local WITH_INSTANCE_VARIABLE = (std.asciiUpper(std.extVar('WITH_INSTANCE_VARIABLE')) == 'TRUE');
+local TITLE = std.extVar('TITLE');
 
 if WITH_INSTANCE_VARIABLE then
   dashboard_raw(
     datasource=DATASOURCE,
     job=JOB,
     alias=variable.prometheus.alias,
+    title=TITLE,
   ).addTemplate(
     grafana.template.new(
       name='alias',
@@ -29,4 +31,5 @@ else
     datasource=DATASOURCE,
     job=JOB,
     alias='.*',
+    title=TITLE,
   ).build()

dashboard/build/prometheus/tdg_dashboard_raw.libsonnet

@@ -4,9 +4,15 @@ local dashboard = import 'dashboard/dashboard.libsonnet';
 local section = import 'dashboard/section.libsonnet';
 local variable = import 'dashboard/variable.libsonnet';
 
-function(datasource, job, alias) dashboard.new(
+function(
+  datasource,
+  job,
+  alias,
+  title='',
+) dashboard.new(
   grafana.dashboard.new(
-    title='Tarantool Data Grid dashboard',
+    // Cannot use in-built means to work with defaults due to possible ext vars.
+    title=(if title != '' then title else 'Tarantool Data Grid dashboard'),
     description='Dashboard for Tarantool Data Grid ver. 2 application monitoring, based on grafonnet library.',
     editable=true,
     schemaVersion=21,