Adds Template Tasks (influxdata#577)

* Add Templates to Kapacitor. TICKscript now allows vars to be overwritten via the API on a per task basis. TICKscript vars can now be any type and can be the result of an expression involving other vars. A template represents a TICKscript and task type that can be shared across many tasks. Each task can supply its own vars to the template.
kprd · May 31, 2016 · 913f6df · 913f6df
1 parent 1315700
commit 913f6df
Show file tree

Hide file tree

Showing 71 changed files with 9,420 additions and 2,350 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,77 @@
 
 ### Release Notes
 
+#### Template Tasks
+
+The ability to create and use template tasks has been added.
+you can define a template for a task and reuse that template across multiple tasks.
+
+A simple example:
+
+```go
+// Which measurement to consume
+var measurement string
+// Optional where filter
+var where_filter = lambda: TRUE
+// Optional list of group by dimensions
+var groups = [*]
+// Which field to process
+var field string
+// Warning criteria, has access to 'mean' field
+var warn lambda
+// Critical criteria, has access to 'mean' field
+var crit lambda
+// How much data to window
+var window = 5m
+// The slack channel for alerts
+var slack_channel = '#alerts'
+
+stream
+    |from()
+        .measurement(measurement)
+        .where(where_filter)
+        .groupBy(groups)
+    |window()
+        .period(window)
+        .every(window)
+    |mean(field)
+    |alert()
+         .warn(warn)
+         .crit(crit)
+         .slack()
+         .channel(slack_channel)
+```
+
+Then you can define the template like so:
+
+```
+kapacitor define-template generic_mean_alert -tick path/to/above/script.tick -type stream
+```
+
+Next define a task that uses the template:
+
+```
+kapacitor define cpu_alert -template-id generic_mean_alert -vars cpu_vars.json -dbrp telegraf.default
+```
+
+Where `cpu_vars.json` would like like this:
+
+```json
+{
+    "measurement": {"type" : "string", "value" : "cpu" },
+    "where_filter": {"type": "lambda", "value": "\"cpu\" == 'cpu-total'"},
+    "groups": {"type": "list", "value": [{"type":"string", "value":"host"},{"type":"string", "value":"dc"}]},
+    "field": {"type" : "string", "value" : "usage_idle" },
+    "warn": {"type" : "lambda", "value" : " \"mean\" < 30.0" },
+    "crit": {"type" : "lambda", "value" : " \"mean\" < 10.0" },
+    "window": {"type" : "duration", "value" : "1m" },
+    "slack_channel": {"type" : "string", "value" : "#alerts_testing" }
+}
+```
+
+
+#### Live Replays
+
 With this release you can now replay data directly against a task from InfluxDB without having to first create a recording.
 Replay the queries defined in the batch task `cpu_alert` for the past 10 hours.
 ```sh
@@ -23,6 +94,7 @@ kapacitor replay-live query -task cpu_alert -query 'SELECT usage_idle FROM teleg
 - [#500](https://github.com/influxdata/kapacitor/issues/500): Support Float,Integer,String and Boolean types.
 - [#82](https://github.com/influxdata/kapacitor/issues/82): Multiple services for PagerDuty alert.
 - [#558](https://github.com/influxdata/kapacitor/pull/558): Preserve fields as well as tags on selector InfluxQL functions.
+- [#259](https://github.com/influxdata/kapacitor/issues/259): Template Tasks have been added.
 
 
 ### Bugfixes

diff --git a/alert.go b/alert.go
@@ -289,31 +289,31 @@ func newAlertNode(et *ExecutingTask, n *pipeline.AlertNode, l *log.Logger) (an *
 	an.scopePools = make([]stateful.ScopePool, CritAlert+1)
 
 	if n.Info != nil {
-		statefulExpression, expressionCompileError := stateful.NewExpression(n.Info)
+		statefulExpression, expressionCompileError := stateful.NewExpression(n.Info.Expression)
 		if expressionCompileError != nil {
 			return nil, fmt.Errorf("Failed to compile stateful expression for info: %s", expressionCompileError)
 		}
 
 		an.levels[InfoAlert] = statefulExpression
-		an.scopePools[InfoAlert] = stateful.NewScopePool(stateful.FindReferenceVariables(n.Info))
+		an.scopePools[InfoAlert] = stateful.NewScopePool(stateful.FindReferenceVariables(n.Info.Expression))
 	}
 
 	if n.Warn != nil {
-		statefulExpression, expressionCompileError := stateful.NewExpression(n.Warn)
+		statefulExpression, expressionCompileError := stateful.NewExpression(n.Warn.Expression)
 		if expressionCompileError != nil {
 			return nil, fmt.Errorf("Failed to compile stateful expression for warn: %s", expressionCompileError)
 		}
 		an.levels[WarnAlert] = statefulExpression
-		an.scopePools[WarnAlert] = stateful.NewScopePool(stateful.FindReferenceVariables(n.Warn))
+		an.scopePools[WarnAlert] = stateful.NewScopePool(stateful.FindReferenceVariables(n.Warn.Expression))
 	}
 
 	if n.Crit != nil {
-		statefulExpression, expressionCompileError := stateful.NewExpression(n.Crit)
+		statefulExpression, expressionCompileError := stateful.NewExpression(n.Crit.Expression)
 		if expressionCompileError != nil {
 			return nil, fmt.Errorf("Failed to compile stateful expression for crit: %s", expressionCompileError)
 		}
 		an.levels[CritAlert] = statefulExpression
-		an.scopePools[CritAlert] = stateful.NewScopePool(stateful.FindReferenceVariables(n.Crit))
+		an.scopePools[CritAlert] = stateful.NewScopePool(stateful.FindReferenceVariables(n.Crit.Expression))
 	}
 
 	// Setup states