Warning! This page documents an old version of Kapacitor, which is no longer actively developed. Kapacitor v1.4 is the most recent stable version of Kapacitor.

A UDFNode is a node that can run a User Defined Function (UDF) in a separate process.

A UDF is a custom script or binary that can communicate via Kapacitor's UDF RPC protocol. The path and arguments to the UDF program are specified in Kapacitor's configuration. Using TICKscripts you can invoke and configure your UDF for each task.

See the README.md for details on how to write your own UDF.

UDFs are configured via Kapacitor's main configuration file.


        # Example moving average UDF.
            prog = "/path/to/executable/moving_avg"
            args = []
            timeout = "10s"

UDFs are first class objects in TICKscripts and are referenced via their configuration name.


     // Given you have a UDF that computes a moving average
     // The UDF can define what its options are and then can be
     // invoked via a TICKscript like so:

NOTE: The UDF process runs as the same user as the Kapacitor daemon. As a result make the user is properly secured as well as the configuration file.



Chaining Methods

Chaining Methods

Chaining methods create a new node in the pipeline as a child of the calling node. They do not modify the calling node.


Create an alert node, which can trigger alerts.


Returns: AlertNode


Select the bottom num points for field and sort by any extra tags or fields.

node.bottom(num int64, field string, fieldsAndTags ...string)

Returns: InfluxQLNode


Count the number of points.

node.count(field string)

Returns: InfluxQLNode


Helper function for creating an alert on low throughput, aka deadman's switch.

  • Threshold – trigger alert if throughput drops below threshold in points/interval.
  • Interval – how often to check the throughput.
  • Expressions – optional list of expressions to also evaluate. Useful for time of day alerting.


    var data = stream.from()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    data.deadman(100.0, 10s)
    //Do normal processing of data

The above is equivalent to this Example:

    var data = stream.from()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
              .id('node \'stream0\' in task \'{{ .TaskName }}\'')
              .message('{{ .ID }} is {{ if eq .Level "OK" }}alive{{ else }}dead{{ end }}: {{ index .Fields "collected" | printf "%0.3f" }} points/10s.')
              .crit(lamdba: "collected" <= 100.0)
    //Do normal processing of data

The id and message alert properties can be configured globally via the 'deadman' configuration section.

Since the AlertNode is the last piece it can be further modified as normal. Example:

    var data = stream.from()...
    // Trigger critical alert if the throughput drops below 100 points per 1s and checked every 10s.
    data.deadman(100.0, 10s).slack().channel('#dead_tasks')
    //Do normal processing of data

You can specify additional lambda expressions to further constrain when the deadman's switch is triggered. Example:

    var data = stream.from()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    // Only trigger the alert if the time of day is between 8am-5pm.
    data.deadman(100.0, 10s, lambda: hour("time") >= 8 AND hour("time") <= 17)
    //Do normal processing of data
node.deadman(threshold float64, interval time.Duration, expr ...tick.Node)

Returns: AlertNode


Create a new node that computes the derivative of adjacent points.

node.derivative(field string)

Returns: DerivativeNode


Produce batch of only the distinct points.

node.distinct(field string)

Returns: InfluxQLNode


Create an eval node that will evaluate the given transformation function to each data point. A list of expressions may be provided and will be evaluated in the order they are given and results of previous expressions are made available to later expressions.

node.eval(expressions ...tick.Node)

Returns: EvalNode


Select the first point.

node.first(field string)

Returns: InfluxQLNode


Group the data by a set of tags.

Can pass literal * to group by all dimensions. Example:

node.groupBy(tag ...interface{})

Returns: GroupByNode


Create an http output node that caches the most recent data it has received. The cached data is available at the given endpoint. The endpoint is the relative path from the API endpoint of the running task. For example if the task endpoint is at "/api/v1/task/<task_name>" and endpoint is "top10", then the data can be requested from "/api/v1/task/<task_name>/top10".

node.httpOut(endpoint string)

Returns: HTTPOutNode


Create an influxdb output node that will store the incoming data into InfluxDB.


Returns: InfluxDBOutNode


Join this node with other nodes. The data is joined on timestamp.

node.join(others ...Node)

Returns: JoinNode


Select the last point.

node.last(field string)

Returns: InfluxQLNode


> DEPRECATION WARNING: As of v0.11 you can use the new InfluxQLNode to perform map reduce functions. This way of performing influxql functions will be removed in the 0.12 release.

Perform a map-reduce operation on the data. The built-in functions under influxql provide the selection,aggregation, and transformation functions from the InfluxQL language.

MapReduce may be applied to either a batch or a stream edge. In the case of a batch each batch is passed to the mapper independently. In the case of a stream all incoming data points that have the exact same time are combined into a batch and sent to the mapper.

node.mapReduce(mr MapReduceInfo)

Returns: ReduceNode


Select the maximum point.

node.max(field string)

Returns: InfluxQLNode


Compute the mean of the data.

node.mean(field string)

Returns: InfluxQLNode


Compute the median of the data. Note, this method is not a selector, if you want the median point use .percentile(field, 50.0).

node.median(field string)

Returns: InfluxQLNode


Select the minimum point.

node.min(field string)

Returns: InfluxQLNode


Select a point at the given percentile. This is a selector function, no interpolation between points is performed.

node.percentile(field string, percentile float64)

Returns: InfluxQLNode


Create a new node that samples the incoming points or batches.

One point will be emitted every count or duration specified.

node.sample(rate interface{})

Returns: SampleNode


Create a new node that shifts the incoming points or batches in time.

node.shift(shift time.Duration)

Returns: ShiftNode


Compute the difference between min and max points.

node.spread(field string)

Returns: InfluxQLNode


Create a new stream of data that contains the internal statistics of the node. The interval represents how often to emit the statistics based on real time. This means the interval time is independent of the times of the data points the source node is receiving.

node.stats(interval time.Duration)

Returns: StatsNode


Compute the standard deviation.

node.stddev(field string)

Returns: InfluxQLNode


Compute the sum of all values.

node.sum(field string)

Returns: InfluxQLNode


Select the top num points for field and sort by any extra tags or fields.

node.top(num int64, field string, fieldsAndTags ...string)

Returns: InfluxQLNode


Perform the union of this node and all other given nodes.

node.union(node ...Node)

Returns: UnionNode


Create a new node that filters the data stream by a given expression.

node.where(expression tick.Node)

Returns: WhereNode


Create a new node that windows the stream by time.

NOTE: Window can only be applied to stream edges.


Returns: WindowNode