SideloadNode

The sideload node adds fields and tags to points based on hierarchical data from various sources.

• SideloadNode example
• Constructor
• Property methods: field, order, quiet, source, tag
• Chaining methods

SideloadNode example

The following example shows how to add a field cpu_threshold and a tag foo to each point based on the value loaded from the hierarchical source. The list of templates in the .order() property are evaluated using the points tags. The files paths are checked then checked in order for the specified keys and the first value that is found is used.

|sideload()
  .source('file:///path/to/dir')
  .order('host/{{.host}}.yml', 'hostgroup/{{.hostgroup}}.yml')
  .field('cpu_threshold', 0.0)
  .tag('foo', 'unknown')

Constructor

Property Methods

Chaining Methods

Alert, Barrier, Bottom, ChangeDetect, Combine, Count, CumulativeSum, Deadman, Default, Delete, Derivative, Difference, Distinct, Ec2Autoscale, Elapsed, Eval, First, Flatten, GroupBy, HoltWinters, HoltWintersWithFit, HttpOut, HttpPost, InfluxDBOut, Join, K8sAutoscale, KapacitorLoopback, Last, Log, Max, Mean, Median, Min, Mode, MovingAverage, Percentile, Sample, Shift, Sideload, Spread, StateCount, StateDuration, Stats, Stddev, Sum, SwarmAutoscale, Top, Trickle, Union, Where, Window

Properties

Property methods modify state on the calling node. They do not add another node to the pipeline, and always return a reference to the calling node. Property methods are marked using the . operator.

Field

Field is the name of a field to load from the source and its default value. The type loaded must match the type of the default value. Otherwise an error is recorded and the default value is used.

sideload.field(f string, v interface{})

Order

Order is a list of paths that indicate the hierarchical order. The paths are relative to the source and can have template markers like {{.tagname}} that will be replaced with the tag value of the point. The paths are then searched in order for the keys and the first value that is found is used. This allows for values to be overridden based on a hierarchy of tags.

sideload.order(order ...string)

Quiet

Suppress all error logging events from this node.

sideload.quiet()

Source

Define the source of the data. The following sources are supported:

• a file URI (file://)
• a URL (http://)
• an endpoint name. Use a plain string (without file:// or http://) to ensure the source is interpreted as an endpoint in the [[httpost]] section in the Kapacitor configuration.

Source examples

File source

|sideload()
  .source('file:///path/to/dir')
  .order('host/{{.host}}.yml', 'hostgroup/{{.hostgroup}}.yml')
  .field('cpu_threshold', 0.0)
  .tag('foo', 'unknown')

URL source

|sideload()
  .source('http://localhost:5000/threshold/')
  .order('host/{{.host}}.yml', 'hostgroup/{{.hostgroup}}.yml')
  .field('cpu_threshold', 0.0)
  .tag('foo', 'unknown')

Endpoint source

|sideload()
  .source('host1')
  .order('host/{{.host}}.yml', 'hostgroup/{{.hostgroup}}.yml')
  .field('cpu_threshold', 0.0)
  .tag('foo', 'unknown')

{{% note %}} Kapacitor loads URL or endpoint sources once using an HTTP GET request when a task is enabled, and then on subsequent calls to the /sideload/reload endpoint. {{% /note %}}

An HTTP source endpoint should return a JSON object where each property is a key name specified in the order statement and its value is an object with a set of key-value pairs.

{
    "host1": {
        "cpu_threshold": 99.9,
        "disable": "false"
    },
    "host2": {
        "cpu_threshold": 85,
        "disable": "true"
    },
    "host3": {
        "cpu_threshold": 56,
        "disable": "false"
    }
}

Tag

Tag is the name of a tag to load from the source and its default value. The loaded values must be strings, otherwise an error is recorded and the default value is used.

sideload.tag(t string, v string)

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. Chaining methods are marked using the | operator.

Alert

Create an alert node, which can trigger alerts.

sideload|alert()

Returns: AlertNode

Barrier

Create a new Barrier node that emits a BarrierMessage periodically.

One BarrierMessage will be emitted every period duration.

sideload|barrier()

Returns: BarrierNode

Bottom

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

sideload|bottom(num int64, field string, fieldsAndTags ...string)

Returns: InfluxQLNode

ChangeDetect

Create a new node that only emits new points if different from the previous point.

sideload|changeDetect(field string)

Returns: ChangeDetectNode

Combine

Combine this node with itself. The data is combined on timestamp.

sideload|combine(expressions ...ast.LambdaNode)

Returns: CombineNode

Count

Count the number of points.

sideload|count(field string)

Returns: InfluxQLNode

CumulativeSum

Compute a cumulative sum of each point that is received. A point is emitted for every point collected.

sideload|cumulativeSum(field string)

Returns: InfluxQLNode

Deadman

Helper function for creating an alert on low throughput, a.k.a. 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.

Example:

    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
    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.
    data
        |stats(10s)
            .align()
        |derivative('emitted')
            .unit(10s)
            .nonNegative()
        |alert()
            .id('node \'stream0\' in task \'{{ .TaskName }}\'')
            .message('{{ .ID }} is {{ if eq .Level "OK" }}alive{{ else }}dead{{ end }}: {{ index .Fields "emitted" | printf "%0.3f" }} points/10s.')
            .crit(lambda: "emitted" <= 100.0)
    //Do normal processing of data
    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 usual. Example:

    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)
            .slack()
            .channel('#dead_tasks')
    //Do normal processing of data
    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
    data...

sideload|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)

Returns: AlertNode

Default

Create a node that can set defaults for missing tags or fields.

sideload|default()

Returns: DefaultNode

Delete

Create a node that can delete tags or fields.

sideload|delete()

Returns: DeleteNode

Derivative

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

sideload|derivative(field string)

Returns: DerivativeNode

Difference

Compute the difference between points independent of elapsed time.

sideload|difference(field string)

Returns: InfluxQLNode

Distinct

Produce batch of only the distinct points.

sideload|distinct(field string)

Returns: InfluxQLNode

Ec2Autoscale

Create a node that can trigger autoscale events for a ec2 autoscalegroup.

sideload|ec2Autoscale()

Returns: Ec2AutoscaleNode

Elapsed

Compute the elapsed time between points.

sideload|elapsed(field string, unit time.Duration)

Returns: InfluxQLNode

Eval

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. The results are available to later expressions.

sideload|eval(expressions ...ast.LambdaNode)

Returns: EvalNode

First

Select the first point.

sideload|first(field string)

Returns: InfluxQLNode

Flatten

Flatten points with similar times into a single point.

sideload|flatten()

Returns: FlattenNode

GroupBy

Group the data by a set of tags.

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

    |groupBy(*)

sideload|groupBy(tag ...interface{})

Returns: GroupByNode

HoltWinters

Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) forecast of a data set.

sideload|holtWinters(field string, h int64, m int64, interval time.Duration)

Returns: InfluxQLNode

HoltWintersWithFit

Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) forecast of a data set. This method also outputs all the points used to fit the data in addition to the forecasted data.

sideload|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)

Returns: InfluxQLNode

HttpOut

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 /kapacitor/v1/tasks/<task_id> and endpoint is top10, then the data can be requested from /kapacitor/v1/tasks/<task_id>/top10.

sideload|httpOut(endpoint string)

Returns: HTTPOutNode

HttpPost

Creates an HTTP Post node that POSTS received data to the provided HTTP endpoint. HttpPost expects 0 or 1 arguments. If 0 arguments are provided, you must specify an endpoint property method.

sideload|httpPost(url ...string)

Returns: HTTPPostNode

InfluxDBOut

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

sideload|influxDBOut()

Returns: InfluxDBOutNode

Join

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

sideload|join(others ...Node)

Returns: JoinNode

K8sAutoscale

Create a node that can trigger autoscale events for a kubernetes cluster.

sideload|k8sAutoscale()

Returns: K8sAutoscaleNode

KapacitorLoopback

Create an kapacitor loopback node that will send data back into Kapacitor as a stream.

sideload|kapacitorLoopback()

Returns: KapacitorLoopbackNode

Last

Select the last point.

sideload|last(field string)

Returns: InfluxQLNode

Log

Create a node that logs all data it receives.

sideload|log()

Returns: LogNode

Max

Select the maximum point.

sideload|max(field string)

Returns: InfluxQLNode

Mean

Compute the mean of the data.

sideload|mean(field string)

Returns: InfluxQLNode

Median

Compute the median of the data.

Note: This method is not a selector. If you want the median point, use .percentile(field, 50.0).

sideload|median(field string)

Returns: InfluxQLNode

Min

Select the minimum point.

sideload|min(field string)

Returns: InfluxQLNode

Mode

Compute the mode of the data.

sideload|mode(field string)

Returns: InfluxQLNode

MovingAverage

Compute a moving average of the last window points. No points are emitted until the window is full.

sideload|movingAverage(field string, window int64)

Returns: InfluxQLNode

Percentile

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

sideload|percentile(field string, percentile float64)

Returns: InfluxQLNode

Sample

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

One point will be emitted every count or duration specified.

sideload|sample(rate interface{})

Returns: SampleNode

Shift

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

sideload|shift(shift time.Duration)

Returns: ShiftNode

Sideload

Create a node that can load data from external sources.

sideload|sideload()

Returns: SideloadNode

Spread

Compute the difference between min and max points.

sideload|spread(field string)

Returns: InfluxQLNode

StateCount

Create a node that tracks number of consecutive points in a given state.

sideload|stateCount(expression ast.LambdaNode)

Returns: StateCountNode

StateDuration

Create a node that tracks duration in a given state.

sideload|stateDuration(expression ast.LambdaNode)

Returns: StateDurationNode

Stats

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.

sideload|stats(interval time.Duration)

Returns: StatsNode

Stddev

Compute the standard deviation.

sideload|stddev(field string)

Returns: InfluxQLNode

Sum

Compute the sum of all values.

sideload|sum(field string)

Returns: InfluxQLNode

SwarmAutoscale

Create a node that can trigger autoscale events for a Docker swarm cluster.

sideload|swarmAutoscale()

Returns: SwarmAutoscaleNode

Top

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

sideload|top(num int64, field string, fieldsAndTags ...string)

Returns: InfluxQLNode

Trickle

Create a new node that converts batch data to stream data.

sideload|trickle()

Returns: TrickleNode

Union

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

sideload|union(node ...Node)

Returns: UnionNode

Where

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

sideload|where(expression ast.LambdaNode)

Returns: WhereNode

Window

Create a new node that windows the stream by time.

NOTE: Window can only be applied to stream edges.

sideload|window()

Returns: WindowNode