# StatsNode (Kapacitor TICKscript node)

This page documents an earlier version of Kapacitor. Kapacitor v1.5 is the latest stable version. View this page in the v1.5 documentation.

### Constructor

Chaining Method | Description |
---|---|

stats ( `interval` `time.Duration` ) | 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. |

### Property Methods

Setters | Description |
---|---|

align ( ) | Round times to the StatsNode.Interval value. |

### Chaining Methods

Alert, Barrier, Bottom, 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, Union, Where, Window

### Description

A StatsNode emits internal statistics about another node at a given interval.

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 other node is receiving. As a result the StatsNode is a root node in the task pipeline.

The currently available internal statistics:

- emitted -- the number of points or batches this node has sent to its children.

Each stat is available as a field in the data stream.

The stats are in groups according to the original data. Meaning that if the source node is grouped by the tag ‘host’ as an example, then the counts are output per host with the appropriate ‘host’ tag. Since its possible for groups to change when crossing a node only the emitted groups are considered.

Example:

```
var data = stream
|from()...
// Emit statistics every 1 minute and cache them via the HTTP API.
data
|stats(1m)
|httpOut('stats')
// Continue normal processing of the data stream
data...
```

WARNING: It is not recommended to join the stats stream with the original data stream. Since they operate on different clocks you could potentially create a deadlock. This is a limitation of the current implementation and may be removed in the future.

## 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.

### Align

Round times to the StatsNode.Interval value.

```
stats.align()
```

## 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.

```
stats|alert()
```

Returns: AlertNode

### Barrier

Create a new Barrier node that emits a BarrierMessage periodically

One BarrierMessage will be emitted every period duration

```
stats|barrier()
```

Returns: BarrierNode

### Bottom

Select the bottom `num`

points for `field`

and sort by any extra tags or fields.

```
stats|bottom(num int64, field string, fieldsAndTags ...string)
```

Returns: InfluxQLNode

### Combine

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

```
stats|combine(expressions ...ast.LambdaNode)
```

Returns: CombineNode

### Count

Count the number of points.

```
stats|count(field string)
```

Returns: InfluxQLNode

### CumulativeSum

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

```
stats|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...
```

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

Returns: AlertNode

### Default

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

```
stats|default()
```

Returns: DefaultNode

### Delete

Create a node that can delete tags or fields.

```
stats|delete()
```

Returns: DeleteNode

### Derivative

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

```
stats|derivative(field string)
```

Returns: DerivativeNode

### Difference

Compute the difference between points independent of elapsed time.

```
stats|difference(field string)
```

Returns: InfluxQLNode

### Distinct

Produce batch of only the distinct points.

```
stats|distinct(field string)
```

Returns: InfluxQLNode

### Ec2Autoscale

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

```
stats|ec2Autoscale()
```

Returns: Ec2AutoscaleNode

### Elapsed

Compute the elapsed time between points

```
stats|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.

```
stats|eval(expressions ...ast.LambdaNode)
```

Returns: EvalNode

### First

Select the first point.

```
stats|first(field string)
```

Returns: InfluxQLNode

### Flatten

Flatten points with similar times into a single point.

```
stats|flatten()
```

Returns: FlattenNode

### GroupBy

Group the data by a set of tags.

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

```
|groupBy(*)
```

```
stats|groupBy(tag ...interface{})
```

Returns: GroupByNode

### HoltWinters

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

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

Returns: InfluxQLNode

### HoltWintersWithFit

Compute the holt-winters (/influxdb/v1.8/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.

```
stats|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`

.

```
stats|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.

```
stats|httpPost(url ...string)
```

Returns: HTTPPostNode

### InfluxDBOut

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

```
stats|influxDBOut()
```

Returns: InfluxDBOutNode

### Join

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

```
stats|join(others ...Node)
```

Returns: JoinNode

### K8sAutoscale

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

```
stats|k8sAutoscale()
```

Returns: K8sAutoscaleNode

### KapacitorLoopback

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

```
stats|kapacitorLoopback()
```

Returns: KapacitorLoopbackNode

### Last

Select the last point.

```
stats|last(field string)
```

Returns: InfluxQLNode

### Log

Create a node that logs all data it receives.

```
stats|log()
```

Returns: LogNode

### Max

Select the maximum point.

```
stats|max(field string)
```

Returns: InfluxQLNode

### Mean

Compute the mean of the data.

```
stats|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)`

.

```
stats|median(field string)
```

Returns: InfluxQLNode

### Min

Select the minimum point.

```
stats|min(field string)
```

Returns: InfluxQLNode

### Mode

Compute the mode of the data.

```
stats|mode(field string)
```

Returns: InfluxQLNode

### MovingAverage

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

```
stats|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.

```
stats|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.

```
stats|sample(rate interface{})
```

Returns: SampleNode

### Shift

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

```
stats|shift(shift time.Duration)
```

Returns: ShiftNode

### Sideload

Create a node that can load data from external sources

```
stats|sideload()
```

Returns: SideloadNode

### Spread

Compute the difference between `min`

and `max`

points.

```
stats|spread(field string)
```

Returns: InfluxQLNode

### StateCount

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

```
stats|stateCount(expression ast.LambdaNode)
```

Returns: StateCountNode

### StateDuration

Create a node that tracks duration in a given state.

```
stats|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.

```
stats|stats(interval time.Duration)
```

Returns: StatsNode

### Stddev

Compute the standard deviation.

```
stats|stddev(field string)
```

Returns: InfluxQLNode

### Sum

Compute the sum of all values.

```
stats|sum(field string)
```

Returns: InfluxQLNode

### SwarmAutoscale

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

```
stats|swarmAutoscale()
```

Returns: SwarmAutoscaleNode

### Top

Select the top `num`

points for `field`

and sort by any extra tags or fields.

```
stats|top(num int64, field string, fieldsAndTags ...string)
```

Returns: InfluxQLNode

### Union

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

```
stats|union(node ...Node)
```

Returns: UnionNode

### Where

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

```
stats|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.

```
stats|window()
```

Returns: WindowNode

#### Support and feedback

Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Kapacitor and this documentation. To find support, the following resources are available: