Merge branch 'master' into feat/couchbase-modernization

Author: schmikei

common-lib/CHANGELOG.md

@@ -1,8 +1,17 @@
+# 0.4.0
+- [Signal] Add defaultSignalSource param to set default signal source.
+
+# 0.3.5
+- [Variables] Add queriesSelectorGroupOnly, queriesSelectorFilterOnly attributes
+- [Signal] Add %(queriesSelectorGroupOnly)s, %(queriesSequeriesSelectorFilterOnly)s templates
+- [Signal] Fix legend rendering when aggLevel is none
+- [Panel] Fix id conflict if topkPercentage panel is used with signal.asTarget()
+
 # 0.3.4
 - [Signal] Fix interval template for increase/delta functions.
 
 # 0.3.3
-- [Signal] add `withQuantile(quantile=0.95)` to histogram signals.
+- [Signal] Add `withQuantile(quantile=0.95)` to histogram signals.
 
 # 0.3.2
 - [Signal] Fix combining info metrics.

common-lib/common/panels/generic/timeSeries/topk_percentage.libsonnet

@@ -24,7 +24,8 @@ base {
                       );
     local meanTarget = target
                        { expr: 'avg(' + target.expr + ')' }
-                       + g.query.prometheus.withLegendFormat('Mean');
+                       + g.query.prometheus.withLegendFormat('Mean')
+                       + g.query.prometheus.withRefId('Mean');
     super.new(title, targets=[topTarget, meanTarget], description=description)
     + self.withDataLink(instanceLabels, drillDownDashboardUid),
 

common-lib/common/signal/README.md

@@ -84,6 +84,7 @@ Init level:
 |varAdHocEnabled| Attach ad hoc labels to variables generated. |`true`,`false`|`false`|`false`|
 |varAdHocLabels| Limit ad hoc to the specific labels |*|`["environment"]`|`[]`|
 |enableLokiLogs| Add additional loki datasource to variables generation |`true`,`false`|`true`|`false`|
+|defaultSignalSource| Set default signal source (see below) | * | `prometheus` |
 
 Signal's level:
 
@@ -111,6 +112,8 @@ Signal's level:
 The following is supported in expressions and legends:
 
 - `%(queriesSelector)s` - expands to filteringSelector matchers and matchers based on instanceLabels, and groupLabels
+- `%(queriesSelectorGroupOnly)s` - expands to filteringSelector matchers and matchers based on groupLabels only
+- `%(queriesSelectorFilterOnly)s` - expands to filteringSelector matchers only
 - `%(filteringSelector)s` - expands to filteringSelector matchers
 - `%(groupLabels)s` - expands to groupLabels list
 - `%(instanceLabels)s` - expands to instanceLabels list
@@ -122,7 +125,7 @@ The following is supported in expressions and legends:
 
 ## Making signals optional
 
-When defining signals from multiple sources, you can make some of the signals optional. In this case, rendering will not throw a validation error that signal is missing for the specific source, while internal 'stub' type will be used and empty panel will be rendered instead.
+When defining signals from multiple sources, you can make some of the signals optional. In this case, rendering will not throw a validation error that signal is missing for the specific source (and also in source defined as `defaultSignalSource`), while internal 'stub' type will be used and empty panel will be rendered instead.
 
 ## Example 1: From JSON
 

common-lib/common/signal/base.libsonnet

@@ -82,7 +82,7 @@ local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet';
           (
             if aggLevel == 'group' then super.groupLabels
             else if aggLevel == 'instance' then super.instanceLabels
-            else if aggLevel == 'none' then []
+            else if aggLevel == 'none' then super.instanceLabels
           ),
         aggLegend: utils.labelsToPanelLegend(
           // keep last label
@@ -123,6 +123,8 @@ local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet';
                 ),
               ],
             queriesSelector+: ',' + mixin,
+            queriesSelectorGroupOnly+: ',' + mixin,
+            queriesSelectorFilterOnly+: ',' + mixin,
           },
       },
 
@@ -287,6 +289,8 @@ local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet';
             interval: this.vars.alertsInterval,
             // keep only filteringSelector, remove any Grafana dashboard variables:
             queriesSelector: this.vars.filteringSelector[0],
+            queriesSelectorGroupOnly: this.vars.filteringSelector[0],
+            queriesSelectorFilterOnly: this.vars.filteringSelector[0],
           }
           for source in this.sourceMaps
         ]

common-lib/common/signal/signal.libsonnet

@@ -8,6 +8,7 @@ local info = import './info.libsonnet';
 local log = import './log.libsonnet';
 local raw = import './raw.libsonnet';
 local stub = import './stub.libsonnet';
+local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet';
 {
   //Expected signalsJson format:
   // {
@@ -86,6 +87,7 @@ local stub = import './stub.libsonnet';
         else  //array
           type
       );
+    local defaultSignalSource = std.get(signalsJson, 'defaultSignalSource', 'prometheus');
 
     self.init(
       datasource=std.get(signalsJson, 'datasource', if std.get(signalsJson, 'enableLokiLogs', false) then 'prometheus_datasource' else 'datasource'),
@@ -95,7 +97,7 @@ local stub = import './stub.libsonnet';
       instanceLabels=signalsJson.instanceLabels,
       interval=std.get(signalsJson, 'interval', '$__rate_interval'),
       alertsInterval=std.get(signalsJson, 'alertsInterval', '5m'),
-      varMetric=self.getVarMetric(signalsJson, type),
+      varMetric=self.getVarMetric(signalsJson, type, defaultSignalSource),
       aggLevel=std.get(signalsJson, 'aggLevel', 'none'),
       aggFunction=std.get(signalsJson, 'aggFunction', 'avg'),
       aggKeepLabels=std.get(signalsJson, 'aggKeepLabels', []),
@@ -117,9 +119,18 @@ local stub = import './stub.libsonnet';
             if
               std.get(signalsJson.signals[s], 'optional', false) == false
               &&
-              !std.objectHas(signalsJson.signals[s].sources, sourceName)
+              (
+                !std.objectHas(signalsJson.signals[s].sources, sourceName)
+                &&
+                !std.objectHas(signalsJson.signals[s].sources, defaultSignalSource)
+              )
             then error 'must provide source for signal %s of type=%s' % [s, sourceName]
-            else sourceName
+            else (
+              if
+                std.objectHas(signalsJson.signals[s].sources, sourceName) then sourceName
+              else if
+                std.objectHas(signalsJson.signals[s].sources, defaultSignalSource) then defaultSignalSource
+            )
             for sourceName in typeArr
           ];
           local sourceMaps =
@@ -211,6 +222,8 @@ local stub = import './stub.libsonnet';
       groupLabels: groupLabels,
       instanceLabels: instanceLabels,
       queriesSelector: grafanaVariables.queriesSelector,
+      queriesSelectorGroupOnly: grafanaVariables.queriesSelectorGroupOnly,
+      queriesSelectorFilterOnly: grafanaVariables.queriesSelectorFilterOnly,
       interval: interval,
       alertsInterval: alertsInterval,
     },
@@ -345,14 +358,14 @@ local stub = import './stub.libsonnet';
         ),
   },
 
-  getVarMetric(signalsJson, type):
+  getVarMetric(signalsJson, type, defaultSignalSource):
     if std.objectHas(signalsJson, 'discoveryMetric')
     then
       if std.type(type) == 'array' then
         std.prune(
-          [std.get(signalsJson.discoveryMetric, t, null) for t in type]
+          [std.get(signalsJson.discoveryMetric, t, std.get(signalsJson.discoveryMetric, defaultSignalSource, null)) for t in type]
         )
       else
-        std.get(signalsJson.discoveryMetric, type, 'up')
+        std.get(signalsJson.discoveryMetric, type, std.get(signalsJson.discoveryMetric, defaultSignalSource, 'up'))
     else 'up',
 }