feat(grafana-builder): let users define what quantiles to show

Makefile

@@ -87,4 +87,5 @@ update-mixins:
 
 tests:
 	pushd . && cd ./common-lib && make vendor && make tests
+	pushd . && cd ./grafana-builder/test && make tests
 	pushd . && cd ./mixin-utils/test && make tests

grafana-builder/grafana.libsonnet

@@ -551,7 +551,8 @@ local utils = import 'mixin-utils/utils.libsonnet';
   },
 
   // Assumes that there is a dashboard variable named latency_metrics, values are -1 (native) or 1 (classic)
-  latencyPanelNativeHistogram(metricName, selector, multiplier='1e3'):: {
+  // By default it shows the 99th and 50th quantile.
+  latencyPanelNativeHistogram(metricName, selector, multiplier='1e3', quantile=[99, 50]):: {
     nullPointMode: 'null as zero',
     fieldConfig+: {
       defaults+: {
@@ -561,44 +562,45 @@ local utils = import 'mixin-utils/utils.libsonnet';
         unit: 'ms',
       },
     },
-    targets: [
-      {
-        expr: utils.showNativeHistogramQuery(utils.ncHistogramQuantile('0.99', metricName, selector, multiplier=multiplier)),
-        format: 'time_series',
-        legendFormat: '99th percentile',
-        refId: 'A',
-      },
-      {
-        expr: utils.showClassicHistogramQuery(utils.ncHistogramQuantile('0.99', metricName, selector, multiplier=multiplier)),
-        format: 'time_series',
-        legendFormat: '99th percentile',
-        refId: 'A_classic',
-      },
-      {
-        expr: utils.showNativeHistogramQuery(utils.ncHistogramQuantile('0.50', metricName, selector, multiplier=multiplier)),
-        format: 'time_series',
-        legendFormat: '50th percentile',
-        refId: 'B',
-      },
-      {
-        expr: utils.showClassicHistogramQuery(utils.ncHistogramQuantile('0.50', metricName, selector, multiplier=multiplier)),
-        format: 'time_series',
-        legendFormat: '50th percentile',
-        refId: 'B_classic',
-      },
-      {
-        expr: utils.showNativeHistogramQuery(utils.ncHistogramAverageRate(metricName, selector, multiplier=multiplier)),
-        format: 'time_series',
-        legendFormat: 'Average',
-        refId: 'C',
-      },
-      {
-        expr: utils.showClassicHistogramQuery(utils.ncHistogramAverageRate(metricName, selector, multiplier=multiplier)),
-        format: 'time_series',
-        legendFormat: 'Average',
-        refId: 'C_classic',
-      },
-    ],
+    targets:
+      local getNextRefId(targets) = std.char(std.codepoint('A') + std.length(targets) / 2);
+      local qTargets =
+        std.foldl(
+          function(acc, q)
+            local qStr = std.toString(q);
+            acc + [
+              {
+                expr: utils.showNativeHistogramQuery(utils.ncHistogramQuantile('0.' + qStr, metricName, selector, multiplier=multiplier)),
+                format: 'time_series',
+                legendFormat: qStr + 'th percentile',
+                refId: getNextRefId(acc),
+              },
+              {
+                expr: utils.showClassicHistogramQuery(utils.ncHistogramQuantile('0.' + qStr, metricName, selector, multiplier=multiplier)),
+                format: 'time_series',
+                legendFormat: qStr + 'th percentile',
+                refId: getNextRefId(acc) + '_classic',
+              },
+            ]
+          ,
+          quantile,
+          []
+        );
+      qTargets +
+      [
+        {
+          expr: utils.showNativeHistogramQuery(utils.ncHistogramAverageRate(metricName, selector, multiplier=multiplier)),
+          format: 'time_series',
+          legendFormat: 'Average',
+          refId: getNextRefId(qTargets),
+        },
+        {
+          expr: utils.showClassicHistogramQuery(utils.ncHistogramAverageRate(metricName, selector, multiplier=multiplier)),
+          format: 'time_series',
+          legendFormat: 'Average',
+          refId: getNextRefId(qTargets) + '_classic',
+        },
+      ],
     yaxes: $.yaxes('ms'),
   },
 

grafana-builder/test/.gitignore

@@ -0,0 +1,2 @@
+vendor/
+jsonnetfile.lock.json

grafana-builder/test/Makefile

@@ -0,0 +1,8 @@
+.PHONY: tests
+
+vendor jsonnetfile.lock.json: jsonnetfile.json
+	jb install
+
+tests: jsonnetfile.lock.json vendor
+	jsonnet -J vendor/ ./test_native-classic-histogram.libsonnet
+

grafana-builder/test/jsonnetfile.json

@@ -0,0 +1,21 @@
+{
+  "version": 1,
+  "dependencies": [
+    {
+      "source": {
+        "git": {
+          "remote": "https://github.com/jsonnet-libs/testonnet.git"
+        }
+      },
+      "version": "master"
+    },
+    {
+      "source": {
+        "local": {
+          "directory": "../../mixin-utils"
+        }
+      }
+    }
+  ],
+  "legacyImports": true
+}

grafana-builder/test/test_native-classic-histogram.libsonnet

@@ -0,0 +1,49 @@
+local builder = import '../grafana.libsonnet';
+local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet';
+
+test.new(std.thisFile)
+
++ test.case.new(
+  name='LatencyPanel fieldConfig',
+  test=test.expect.eq(
+    actual=std.get(builder.latencyPanelNativeHistogram('request_duration_seconds', 'cluster="cluster1", job="job1"'), 'targets', []),
+    expected=[
+      {
+        expr: '(histogram_quantile(0.99, sum (rate(request_duration_seconds{cluster="cluster1", job="job1"}[$__rate_interval]))) * 1e3) and on() (vector($latency_metrics) == -1)',
+        format: 'time_series',
+        legendFormat: '99th percentile',
+        refId: 'A',
+      },
+      {
+        expr: '(histogram_quantile(0.99, sum by (le) (rate(request_duration_seconds_bucket{cluster="cluster1", job="job1"}[$__rate_interval]))) * 1e3) and on() (vector($latency_metrics) == 1)',
+        format: 'time_series',
+        legendFormat: '99th percentile',
+        refId: 'A_classic',
+      },
+      {
+        expr: '(histogram_quantile(0.50, sum (rate(request_duration_seconds{cluster="cluster1", job="job1"}[$__rate_interval]))) * 1e3) and on() (vector($latency_metrics) == -1)',
+        format: 'time_series',
+        legendFormat: '50th percentile',
+        refId: 'B',
+      },
+      {
+        expr: '(histogram_quantile(0.50, sum by (le) (rate(request_duration_seconds_bucket{cluster="cluster1", job="job1"}[$__rate_interval]))) * 1e3) and on() (vector($latency_metrics) == 1)',
+        format: 'time_series',
+        legendFormat: '50th percentile',
+        refId: 'B_classic',
+      },
+      {
+        expr: '(1e3 * sum(histogram_sum(rate(request_duration_seconds{cluster="cluster1", job="job1"}[$__rate_interval]))) /\nsum(histogram_count(rate(request_duration_seconds{cluster="cluster1", job="job1"}[$__rate_interval])))\n) and on() (vector($latency_metrics) == -1)',
+        format: 'time_series',
+        legendFormat: 'Average',
+        refId: 'C',
+      },
+      {
+        expr: '(1e3 * sum(rate(request_duration_seconds_sum{cluster="cluster1", job="job1"}[$__rate_interval])) /\nsum(rate(request_duration_seconds_count{cluster="cluster1", job="job1"}[$__rate_interval]))\n) and on() (vector($latency_metrics) == 1)',
+        format: 'time_series',
+        legendFormat: 'Average',
+        refId: 'C_classic',
+      },
+    ],
+  )
+)