--- title: SideloadNode description: > SideloadNode adds fields and tags to points based on hierarchical data from various sources. note: Auto generated by tickdoc menu: kapacitor_1_5_ref: name: SideloadNode identifier: sideload_node weight: 250 parent: nodes --- The `sideload` node adds fields and tags to points based on hierarchical data from various sources. - [SideloadNode example](#sideloadnode-example) - [Constructor](#constructor) - [Property methods](#property-methods): [field](#field), [order](#order), [quiet](#quiet), [source](#source), [tag](#tag) - [Chaining methods](#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. ```js |sideload() .source('file:///path/to/dir') .order('host/{{.host}}.yml', 'hostgroup/{{.hostgroup}}.yml') .field('cpu_threshold', 0.0) .tag('foo', 'unknown') ``` ### Constructor | Chaining Method | Description | |:---------|:---------| | **sideload ( )** | Create a node that can load data from external sources | ### Property Methods | Setters | Description | |:---|:---| | **[field](#field) ( `f` `string`, `v` `interface{}`)** | 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. | | **[order](#order) ( `order` `...string`)** | 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. | | **[quiet](#quiet) ( )** | Suppress all error logging events from this node. | | **[source](#source) ( `value` `string`)** | Source for the data, for example, `file://` or `http://` | | **[tag](#tag) ( `t` `string`, `v` `string`)** | 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. | ### Chaining Methods [Alert](#alert), [Barrier](#barrier), [Bottom](#bottom), [ChangeDetect](#changedetect), [Combine](#combine), [Count](#count), [CumulativeSum](#cumulativesum), [Deadman](#deadman), [Default](#default), [Delete](#delete), [Derivative](#derivative), [Difference](#difference), [Distinct](#distinct), [Ec2Autoscale](#ec2autoscale), [Elapsed](#elapsed), [Eval](#eval), [First](#first), [Flatten](#flatten), [GroupBy](#groupby), [HoltWinters](#holtwinters), [HoltWintersWithFit](#holtwinterswithfit), [HttpOut](#httpout), [HttpPost](#httppost), [InfluxDBOut](#influxdbout), [Join](#join), [K8sAutoscale](#k8sautoscale), [KapacitorLoopback](#kapacitorloopback), [Last](#last), [Log](#log), [Max](#max), [Mean](#mean), [Median](#median), [Min](#min), [Mode](#mode), [MovingAverage](#movingaverage), [Percentile](#percentile), [Sample](#sample), [Shift](#shift), [Sideload](#sideload), [Spread](#spread), [StateCount](#statecount), [StateDuration](#stateduration), [Stats](#stats), [Stddev](#stddev), [Sum](#sum), [SwarmAutoscale](#swarmautoscale), [Top](#top), [Union](#union), [Where](#where), [Window](#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. ```js 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. ```js sideload.order(order ...string) ``` ### Quiet Suppress all error logging events from this node. ```js 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 ```js |sideload() .source('file:///path/to/dir') .order('host/{{.host}}.yml', 'hostgroup/{{.hostgroup}}.yml') .field('cpu_threshold', 0.0) .tag('foo', 'unknown') ``` ##### URL source ```js |sideload() .source('http://localhost:5000/threshold/') .order('host/{{.host}}.yml', 'hostgroup/{{.hostgroup}}.yml') .field('cpu_threshold', 0.0) .tag('foo', 'unknown') ``` ##### Endpoint source ```js |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. ```js { "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. ```js 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. ```js sideload|alert() ``` Returns: [AlertNode](/kapacitor/v1.5/nodes/alert_node/) ### Barrier Create a new Barrier node that emits a BarrierMessage periodically. One BarrierMessage will be emitted every period duration. ```js sideload|barrier() ``` Returns: [BarrierNode](/kapacitor/v1.5/nodes/barrier_node/) ### Bottom Select the bottom `num` points for `field` and sort by any extra tags or fields. ```js sideload|bottom(num int64, field string, fieldsAndTags ...string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### ChangeDetect Create a new node that only emits new points if different from the previous point. ```js sideload|changeDetect(field string) ``` Returns: [ChangeDetectNode](/kapacitor/v1.5/nodes/change_detect_node/) ### Combine Combine this node with itself. The data is combined on timestamp. ```js sideload|combine(expressions ...ast.LambdaNode) ``` Returns: [CombineNode](/kapacitor/v1.5/nodes/combine_node/) ### Count Count the number of points. ```js sideload|count(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### CumulativeSum Compute a cumulative sum of each point that is received. A point is emitted for every point collected. ```js sideload|cumulativeSum(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### 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: ```js 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: ```js 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](/kapacitor/v1.5/nodes/alert_node/) is the last piece it can be further modified as usual. Example: ```js 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: ```js 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... ``` ```js sideload|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode) ``` Returns: [AlertNode](/kapacitor/v1.5/nodes/alert_node/) ### Default Create a node that can set defaults for missing tags or fields. ```js sideload|default() ``` Returns: [DefaultNode](/kapacitor/v1.5/nodes/default_node/) ### Delete Create a node that can delete tags or fields. ```js sideload|delete() ``` Returns: [DeleteNode](/kapacitor/v1.5/nodes/delete_node/) ### Derivative Create a new node that computes the derivative of adjacent points. ```js sideload|derivative(field string) ``` Returns: [DerivativeNode](/kapacitor/v1.5/nodes/derivative_node/) ### Difference Compute the difference between points independent of elapsed time. ```js sideload|difference(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Distinct Produce batch of only the distinct points. ```js sideload|distinct(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Ec2Autoscale Create a node that can trigger autoscale events for a ec2 autoscalegroup. ```js sideload|ec2Autoscale() ``` Returns: [Ec2AutoscaleNode](/kapacitor/v1.5/nodes/ec2_autoscale_node/) ### Elapsed Compute the elapsed time between points. ```js sideload|elapsed(field string, unit time.Duration) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### 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. ```js sideload|eval(expressions ...ast.LambdaNode) ``` Returns: [EvalNode](/kapacitor/v1.5/nodes/eval_node/) ### First Select the first point. ```js sideload|first(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Flatten Flatten points with similar times into a single point. ```js sideload|flatten() ``` Returns: [FlattenNode](/kapacitor/v1.5/nodes/flatten_node/) ### GroupBy Group the data by a set of tags. Can pass literal * to group by all dimensions. Example: ```js |groupBy(*) ``` ```js sideload|groupBy(tag ...interface{}) ``` Returns: [GroupByNode](/kapacitor/v1.5/nodes/group_by_node/) ### HoltWinters Compute the Holt-Winters (/{{< latest "influxdb" "v1" >}}/query_language/functions/#holt-winters) forecast of a data set. ```js sideload|holtWinters(field string, h int64, m int64, interval time.Duration) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### HoltWintersWithFit Compute the Holt-Winters (/{{< latest "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. ```js sideload|holtWintersWithFit(field string, h int64, m int64, interval time.Duration) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### 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/` and endpoint is `top10`, then the data can be requested from `/kapacitor/v1/tasks//top10`. ```js sideload|httpOut(endpoint string) ``` Returns: [HTTPOutNode](/kapacitor/v1.5/nodes/http_out_node/) ### 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. ```js sideload|httpPost(url ...string) ``` Returns: [HTTPPostNode](/kapacitor/v1.5/nodes/http_post_node/) ### InfluxDBOut Create an influxdb output node that will store the incoming data into InfluxDB. ```js sideload|influxDBOut() ``` Returns: [InfluxDBOutNode](/kapacitor/v1.5/nodes/influx_d_b_out_node/) ### Join Join this node with other nodes. The data is joined on timestamp. ```js sideload|join(others ...Node) ``` Returns: [JoinNode](/kapacitor/v1.5/nodes/join_node/) ### K8sAutoscale Create a node that can trigger autoscale events for a kubernetes cluster. ```js sideload|k8sAutoscale() ``` Returns: [K8sAutoscaleNode](/kapacitor/v1.5/nodes/k8s_autoscale_node/) ### KapacitorLoopback Create an kapacitor loopback node that will send data back into Kapacitor as a stream. ```js sideload|kapacitorLoopback() ``` Returns: [KapacitorLoopbackNode](/kapacitor/v1.5/nodes/kapacitor_loopback_node/) ### Last Select the last point. ```js sideload|last(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Log Create a node that logs all data it receives. ```js sideload|log() ``` Returns: [LogNode](/kapacitor/v1.5/nodes/log_node/) ### Max Select the maximum point. ```js sideload|max(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Mean Compute the mean of the data. ```js sideload|mean(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### 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)`. ```js sideload|median(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Min Select the minimum point. ```js sideload|min(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Mode Compute the mode of the data. ```js sideload|mode(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### MovingAverage Compute a moving average of the last window points. No points are emitted until the window is full. ```js sideload|movingAverage(field string, window int64) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Percentile Select a point at the given percentile. This is a selector function, no interpolation between points is performed. ```js sideload|percentile(field string, percentile float64) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Sample Create a new node that samples the incoming points or batches. One point will be emitted every count or duration specified. ```js sideload|sample(rate interface{}) ``` Returns: [SampleNode](/kapacitor/v1.5/nodes/sample_node/) ### Shift Create a new node that shifts the incoming points or batches in time. ```js sideload|shift(shift time.Duration) ``` Returns: [ShiftNode](/kapacitor/v1.5/nodes/shift_node/) ### Sideload Create a node that can load data from external sources. ```js sideload|sideload() ``` Returns: [SideloadNode](/kapacitor/v1.5/nodes/sideload_node/) ### Spread Compute the difference between `min` and `max` points. ```js sideload|spread(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### StateCount Create a node that tracks number of consecutive points in a given state. ```js sideload|stateCount(expression ast.LambdaNode) ``` Returns: [StateCountNode](/kapacitor/v1.5/nodes/state_count_node/) ### StateDuration Create a node that tracks duration in a given state. ```js sideload|stateDuration(expression ast.LambdaNode) ``` Returns: [StateDurationNode](/kapacitor/v1.5/nodes/state_duration_node/) ### 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. ```js sideload|stats(interval time.Duration) ``` Returns: [StatsNode](/kapacitor/v1.5/nodes/stats_node/) ### Stddev Compute the standard deviation. ```js sideload|stddev(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Sum Compute the sum of all values. ```js sideload|sum(field string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### SwarmAutoscale Create a node that can trigger autoscale events for a Docker swarm cluster. ```js sideload|swarmAutoscale() ``` Returns: [SwarmAutoscaleNode](/kapacitor/v1.5/nodes/swarm_autoscale_node/) ### Top Select the top `num` points for `field` and sort by any extra tags or fields. ```js sideload|top(num int64, field string, fieldsAndTags ...string) ``` Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/) ### Union Perform the union of this node and all other given nodes. ```js sideload|union(node ...Node) ``` Returns: [UnionNode](/kapacitor/v1.5/nodes/union_node/) ### Where Create a new node that filters the data stream by a given expression. ```js sideload|where(expression ast.LambdaNode) ``` Returns: [WhereNode](/kapacitor/v1.5/nodes/where_node/) ### Window Create a new node that windows the stream by time. NOTE: Window can only be applied to stream edges. ```js sideload|window() ``` Returns: [WindowNode](/kapacitor/v1.5/nodes/window_node/)