1121 lines
29 KiB
Markdown
1121 lines
29 KiB
Markdown
---
|
|
title: FromNode
|
|
description: >
|
|
FromNode selects a subset of the data flowing through a StreamNode. You can select which portion of the stream you want to process.
|
|
note: Auto generated by tickdoc
|
|
|
|
menu:
|
|
kapacitor_1_5_ref:
|
|
name: FromNode
|
|
identifier: from_node
|
|
weight: 110
|
|
parent: nodes
|
|
---
|
|
|
|
The `from` node selects a subset of the data flowing through a [StreamNode.](/kapacitor/v1.5/nodes/stream_node/)
|
|
The stream node allows you to select which portion of the stream you want to process.
|
|
|
|
Example:
|
|
|
|
|
|
```js
|
|
stream
|
|
|from()
|
|
.database('mydb')
|
|
.retentionPolicy('myrp')
|
|
.measurement('mymeasurement')
|
|
.where(lambda: "host" =~ /logger\d+/)
|
|
|window()
|
|
...
|
|
```
|
|
|
|
The above example selects only data points from the database `mydb`
|
|
and retention policy `myrp` and measurement `mymeasurement` where
|
|
the tag `host` matches the regex `logger\d+`.
|
|
|
|
|
|
### Constructor
|
|
|
|
| Chaining Method | Description |
|
|
|:---------|:---------|
|
|
| **from ( )** | Creates a new stream node that can be further filtered using the Database, RetentionPolicy, Measurement and Where properties. From can be called multiple times to create multiple independent forks of the data stream. |
|
|
|
|
### Property Methods
|
|
|
|
| Setters | Description |
|
|
|:---|:---|
|
|
| **[database](#database) ( `value` `string`)** | The database name. If empty any database will be used. |
|
|
| **[groupBy](#groupby) ( `tag` `...interface{}`)** | Group the data by a set of tags. |
|
|
| **[groupByMeasurement](#groupbymeasurement) ( )** | If set will include the measurement name in the group ID. Along with any other group by dimensions. |
|
|
| **[measurement](#measurement) ( `value` `string`)** | The measurement name If empty any measurement will be used. |
|
|
| **[quiet](#quiet) ( )** | Suppress all error logging events from this node. |
|
|
| **[retentionPolicy](#retentionpolicy) ( `value` `string`)** | The retention policy name If empty any retention policy will be used. |
|
|
| **[round](#round) ( `value` `time.Duration`)** | Optional duration for rounding timestamps. Helpful to ensure data points land on specific boundaries Example: stream |from() .measurement('mydata') .round(1s) |
|
|
| **[truncate](#truncate) ( `value` `time.Duration`)** | Optional duration for truncating timestamps. Helpful to ensure data points land on specific boundaries Example: stream |from() .measurement('mydata') .truncate(1s) |
|
|
| **[where](#where) ( `lambda` `ast.LambdaNode`)** | Filter the current stream using the given expression. This expression is a Kapacitor expression. Kapacitor expressions are a superset of InfluxQL WHERE expressions. See the [expression](/kapacitor/v1.5/tick/expr/) docs for more information. |
|
|
|
|
|
|
|
|
### 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),
|
|
[From](#from),
|
|
[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),
|
|
[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.
|
|
|
|
|
|
### Database
|
|
|
|
The database name.
|
|
If empty any database will be used.
|
|
|
|
|
|
```js
|
|
from.database(value string)
|
|
```
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
|
|
### GroupBy
|
|
|
|
Group the data by a set of tags.
|
|
|
|
Can pass literal * to group by all dimensions.
|
|
Example:
|
|
|
|
|
|
```js
|
|
stream
|
|
|from()
|
|
.groupBy(*)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
from.groupBy(tag ...interface{})
|
|
```
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
|
|
### GroupByMeasurement
|
|
|
|
If set will include the measurement name in the group ID.
|
|
Along with any other group by dimensions.
|
|
|
|
Example:
|
|
|
|
|
|
```js
|
|
stream
|
|
|from()
|
|
.database('mydb')
|
|
.groupByMeasurement()
|
|
.groupBy('host')
|
|
```
|
|
|
|
The above example selects all measurements from the database 'mydb' and
|
|
then each point is grouped by the host tag and measurement name.
|
|
Thus keeping measurements in their own groups.
|
|
|
|
|
|
```js
|
|
from.groupByMeasurement()
|
|
```
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
|
|
### Measurement
|
|
|
|
The measurement name
|
|
If empty any measurement will be used.
|
|
|
|
|
|
```js
|
|
from.measurement(value string)
|
|
```
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
|
|
### Quiet
|
|
|
|
Suppress all error logging events from this node.
|
|
|
|
|
|
```js
|
|
from.quiet()
|
|
```
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
|
|
### RetentionPolicy
|
|
|
|
The retention policy name
|
|
If empty any retention policy will be used.
|
|
|
|
|
|
```js
|
|
from.retentionPolicy(value string)
|
|
```
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
|
|
### Round
|
|
|
|
Optional duration for rounding timestamps.
|
|
Helpful to ensure data points land on specific boundaries
|
|
Example:
|
|
|
|
|
|
```js
|
|
stream
|
|
|from()
|
|
.measurement('mydata')
|
|
.round(1s)
|
|
```
|
|
|
|
All incoming data will be rounded to the nearest 1 second boundary.
|
|
|
|
|
|
```js
|
|
from.round(value time.Duration)
|
|
```
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
|
|
### Truncate
|
|
|
|
Optional duration for truncating timestamps.
|
|
Helpful to ensure data points land on specific boundaries
|
|
Example:
|
|
|
|
|
|
```js
|
|
stream
|
|
|from()
|
|
.measurement('mydata')
|
|
.truncate(1s)
|
|
```
|
|
|
|
All incoming data will be truncated to 1 second resolution.
|
|
|
|
|
|
```js
|
|
from.truncate(value time.Duration)
|
|
```
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
|
|
### Where
|
|
|
|
Filter the current stream using the given expression.
|
|
This expression is a Kapacitor expression. Kapacitor
|
|
expressions are a superset of InfluxQL WHERE expressions.
|
|
See the [expression](/kapacitor/v1.5/tick/expr/) docs for more information.
|
|
|
|
Multiple calls to the Where method will `AND` together each expression.
|
|
|
|
Example:
|
|
|
|
|
|
```js
|
|
stream
|
|
|from()
|
|
.where(lambda: condition1)
|
|
.where(lambda: condition2)
|
|
```
|
|
|
|
The above is equivalent to this example:
|
|
|
|
|
|
```js
|
|
stream
|
|
|from()
|
|
.where(lambda: condition1 AND condition2)
|
|
```
|
|
|
|
|
|
NOTE: Becareful to always use `|from` if you want multiple different streams.
|
|
|
|
Example:
|
|
|
|
|
|
```js
|
|
var data = stream
|
|
|from()
|
|
.measurement('cpu')
|
|
var total = data
|
|
.where(lambda: "cpu" == 'cpu-total')
|
|
var others = data
|
|
.where(lambda: "cpu" != 'cpu-total')
|
|
```
|
|
|
|
The example above is equivalent to the example below,
|
|
which is obviously not what was intended.
|
|
|
|
Example:
|
|
|
|
|
|
```js
|
|
var data = stream
|
|
|from()
|
|
.measurement('cpu')
|
|
.where(lambda: "cpu" == 'cpu-total' AND "cpu" != 'cpu-total')
|
|
var total = data
|
|
var others = total
|
|
```
|
|
|
|
The example below will create two different streams each selecting
|
|
a different subset of the original stream.
|
|
|
|
Example:
|
|
|
|
|
|
```js
|
|
var data = stream
|
|
|from()
|
|
.measurement('cpu')
|
|
var total = stream
|
|
|from()
|
|
.measurement('cpu')
|
|
.where(lambda: "cpu" == 'cpu-total')
|
|
var others = stream
|
|
|from()
|
|
.measurement('cpu')
|
|
.where(lambda: "cpu" != 'cpu-total')
|
|
```
|
|
|
|
|
|
If empty then all data points are considered to match.
|
|
|
|
|
|
```js
|
|
from.where(lambda ast.LambdaNode)
|
|
```
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
|
|
## 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
|
|
from|alert()
|
|
```
|
|
|
|
Returns: [AlertNode](/kapacitor/v1.5/nodes/alert_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Barrier
|
|
|
|
Create a new Barrier node that emits a BarrierMessage periodically.
|
|
|
|
One BarrierMessage will be emitted every period duration.
|
|
|
|
|
|
```js
|
|
from|barrier()
|
|
```
|
|
|
|
Returns: [BarrierNode](/kapacitor/v1.5/nodes/barrier_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Bottom
|
|
|
|
Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|
|
|
|
|
```js
|
|
from|bottom(num int64, field string, fieldsAndTags ...string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### ChangeDetect
|
|
|
|
Create a new node that only emits new points if different from the previous point.
|
|
|
|
```js
|
|
from|changeDetect(field string)
|
|
```
|
|
|
|
Returns: [ChangeDetectNode](/kapacitor/v1.5/nodes/change_detect_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Combine
|
|
|
|
Combine this node with itself. The data is combined on timestamp.
|
|
|
|
|
|
```js
|
|
from|combine(expressions ...ast.LambdaNode)
|
|
```
|
|
|
|
Returns: [CombineNode](/kapacitor/v1.5/nodes/combine_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Count
|
|
|
|
Count the number of points.
|
|
|
|
|
|
```js
|
|
from|count(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### CumulativeSum
|
|
|
|
Compute a cumulative sum of each point that is received.
|
|
A point is emitted for every point collected.
|
|
|
|
|
|
```js
|
|
from|cumulativeSum(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### 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
|
|
from|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
|
```
|
|
|
|
Returns: [AlertNode](/kapacitor/v1.5/nodes/alert_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Default
|
|
|
|
Create a node that can set defaults for missing tags or fields.
|
|
|
|
|
|
```js
|
|
from|default()
|
|
```
|
|
|
|
Returns: [DefaultNode](/kapacitor/v1.5/nodes/default_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Delete
|
|
|
|
Create a node that can delete tags or fields.
|
|
|
|
|
|
```js
|
|
from|delete()
|
|
```
|
|
|
|
Returns: [DeleteNode](/kapacitor/v1.5/nodes/delete_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Derivative
|
|
|
|
Create a new node that computes the derivative of adjacent points.
|
|
|
|
|
|
```js
|
|
from|derivative(field string)
|
|
```
|
|
|
|
Returns: [DerivativeNode](/kapacitor/v1.5/nodes/derivative_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Difference
|
|
|
|
Compute the difference between points independent of elapsed time.
|
|
|
|
|
|
```js
|
|
from|difference(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Distinct
|
|
|
|
Produce batch of only the distinct points.
|
|
|
|
|
|
```js
|
|
from|distinct(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Ec2Autoscale
|
|
|
|
Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|
|
|
|
|
```js
|
|
from|ec2Autoscale()
|
|
```
|
|
|
|
Returns: [Ec2AutoscaleNode](/kapacitor/v1.5/nodes/ec2_autoscale_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Elapsed
|
|
|
|
Compute the elapsed time between points.
|
|
|
|
|
|
```js
|
|
from|elapsed(field string, unit time.Duration)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### 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
|
|
from|eval(expressions ...ast.LambdaNode)
|
|
```
|
|
|
|
Returns: [EvalNode](/kapacitor/v1.5/nodes/eval_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### First
|
|
|
|
Select the first point.
|
|
|
|
|
|
```js
|
|
from|first(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Flatten
|
|
|
|
Flatten points with similar times into a single point.
|
|
|
|
|
|
```js
|
|
from|flatten()
|
|
```
|
|
|
|
Returns: [FlattenNode](/kapacitor/v1.5/nodes/flatten_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### From
|
|
|
|
Creates a new stream node that can be further
|
|
filtered using the Database, RetentionPolicy, Measurement and Where properties.
|
|
From can be called multiple times to create multiple
|
|
independent forks of the data stream.
|
|
|
|
Example:
|
|
|
|
|
|
```js
|
|
// Select the 'cpu' measurement from just the database 'mydb'
|
|
// and retention policy 'myrp'.
|
|
var cpu = stream
|
|
|from()
|
|
.database('mydb')
|
|
.retentionPolicy('myrp')
|
|
.measurement('cpu')
|
|
// Select the 'load' measurement from any database and retention policy.
|
|
var load = stream
|
|
|from()
|
|
.measurement('load')
|
|
// Join cpu and load streams and do further processing.
|
|
cpu
|
|
|join(load)
|
|
.as('cpu', 'load')
|
|
...
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
from|from()
|
|
```
|
|
|
|
Returns: [FromNode](/kapacitor/v1.5/nodes/from_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### HoltWinters
|
|
|
|
Compute the Holt-Winters (/{{< latest "influxdb" "v1" >}}/query_language/functions/#holt-winters) forecast of a data set.
|
|
|
|
|
|
```js
|
|
from|holtWinters(field string, h int64, m int64, interval time.Duration)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### 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
|
|
from|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### 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`.
|
|
|
|
|
|
```js
|
|
from|httpOut(endpoint string)
|
|
```
|
|
|
|
Returns: [HTTPOutNode](/kapacitor/v1.5/nodes/http_out_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### 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
|
|
from|httpPost(url ...string)
|
|
```
|
|
|
|
Returns: [HTTPPostNode](/kapacitor/v1.5/nodes/http_post_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### InfluxDBOut
|
|
|
|
Create an influxdb output node that will store the incoming data into InfluxDB.
|
|
|
|
|
|
```js
|
|
from|influxDBOut()
|
|
```
|
|
|
|
Returns: [InfluxDBOutNode](/kapacitor/v1.5/nodes/influx_d_b_out_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Join
|
|
|
|
Join this node with other nodes. The data is joined on timestamp.
|
|
|
|
|
|
```js
|
|
from|join(others ...Node)
|
|
```
|
|
|
|
Returns: [JoinNode](/kapacitor/v1.5/nodes/join_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### K8sAutoscale
|
|
|
|
Create a node that can trigger autoscale events for a kubernetes cluster.
|
|
|
|
|
|
```js
|
|
from|k8sAutoscale()
|
|
```
|
|
|
|
Returns: [K8sAutoscaleNode](/kapacitor/v1.5/nodes/k8s_autoscale_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### KapacitorLoopback
|
|
|
|
Create an kapacitor loopback node that will send data back into Kapacitor as a stream.
|
|
|
|
|
|
```js
|
|
from|kapacitorLoopback()
|
|
```
|
|
|
|
Returns: [KapacitorLoopbackNode](/kapacitor/v1.5/nodes/kapacitor_loopback_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Last
|
|
|
|
Select the last point.
|
|
|
|
|
|
```js
|
|
from|last(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Log
|
|
|
|
Create a node that logs all data it receives.
|
|
|
|
|
|
```js
|
|
from|log()
|
|
```
|
|
|
|
Returns: [LogNode](/kapacitor/v1.5/nodes/log_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Max
|
|
|
|
Select the maximum point.
|
|
|
|
|
|
```js
|
|
from|max(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Mean
|
|
|
|
Compute the mean of the data.
|
|
|
|
|
|
```js
|
|
from|mean(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### 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
|
|
from|median(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Min
|
|
|
|
Select the minimum point.
|
|
|
|
|
|
```js
|
|
from|min(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Mode
|
|
|
|
Compute the mode of the data.
|
|
|
|
|
|
```js
|
|
from|mode(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### MovingAverage
|
|
|
|
Compute a moving average of the last window points.
|
|
No points are emitted until the window is full.
|
|
|
|
|
|
```js
|
|
from|movingAverage(field string, window int64)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Percentile
|
|
|
|
Select a point at the given percentile. This is a selector function, no interpolation between points is performed.
|
|
|
|
|
|
```js
|
|
from|percentile(field string, percentile float64)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Sample
|
|
|
|
Create a new node that samples the incoming points or batches.
|
|
|
|
One point will be emitted every count or duration specified.
|
|
|
|
|
|
```js
|
|
from|sample(rate interface{})
|
|
```
|
|
|
|
Returns: [SampleNode](/kapacitor/v1.5/nodes/sample_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Shift
|
|
|
|
Create a new node that shifts the incoming points or batches in time.
|
|
|
|
|
|
```js
|
|
from|shift(shift time.Duration)
|
|
```
|
|
|
|
Returns: [ShiftNode](/kapacitor/v1.5/nodes/shift_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Sideload
|
|
|
|
Create a node that can load data from external sources.
|
|
|
|
|
|
```js
|
|
from|sideload()
|
|
```
|
|
|
|
Returns: [SideloadNode](/kapacitor/v1.5/nodes/sideload_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Spread
|
|
|
|
Compute the difference between `min` and `max` points.
|
|
|
|
|
|
```js
|
|
from|spread(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### StateCount
|
|
|
|
Create a node that tracks number of consecutive points in a given state.
|
|
|
|
|
|
```js
|
|
from|stateCount(expression ast.LambdaNode)
|
|
```
|
|
|
|
Returns: [StateCountNode](/kapacitor/v1.5/nodes/state_count_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### StateDuration
|
|
|
|
Create a node that tracks duration in a given state.
|
|
|
|
|
|
```js
|
|
from|stateDuration(expression ast.LambdaNode)
|
|
```
|
|
|
|
Returns: [StateDurationNode](/kapacitor/v1.5/nodes/state_duration_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### 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
|
|
from|stats(interval time.Duration)
|
|
```
|
|
|
|
Returns: [StatsNode](/kapacitor/v1.5/nodes/stats_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Stddev
|
|
|
|
Compute the standard deviation.
|
|
|
|
|
|
```js
|
|
from|stddev(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Sum
|
|
|
|
Compute the sum of all values.
|
|
|
|
|
|
```js
|
|
from|sum(field string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### SwarmAutoscale
|
|
|
|
Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|
|
|
|
|
```js
|
|
from|swarmAutoscale()
|
|
```
|
|
|
|
Returns: [SwarmAutoscaleNode](/kapacitor/v1.5/nodes/swarm_autoscale_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Top
|
|
|
|
Select the top `num` points for `field` and sort by any extra tags or fields.
|
|
|
|
|
|
```js
|
|
from|top(num int64, field string, fieldsAndTags ...string)
|
|
```
|
|
|
|
Returns: [InfluxQLNode](/kapacitor/v1.5/nodes/influx_q_l_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Union
|
|
|
|
Perform the union of this node and all other given nodes.
|
|
|
|
|
|
```js
|
|
from|union(node ...Node)
|
|
```
|
|
|
|
Returns: [UnionNode](/kapacitor/v1.5/nodes/union_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|
|
|
|
### Window
|
|
|
|
Create a new node that windows the stream by time.
|
|
|
|
NOTE: Window can only be applied to stream edges.
|
|
|
|
|
|
```js
|
|
from|window()
|
|
```
|
|
|
|
Returns: [WindowNode](/kapacitor/v1.5/nodes/window_node/)
|
|
|
|
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>
|