This is archived documentation for InfluxData product versions that are no longer maintained. For newer documentation, see the latest InfluxData documentation.
Windows data over time.
A window has a length defined by
and a frequency at which it emits the window to the pipeline.
stream .window() .period(10m) .every(5m) .httpOut('recent')
The above windowing example emits a window to the pipeline every
and the window contains the last
10 minutes worth of data.
As a result each time the window is emitted it contains half new data and half old data.
NOTE: Time for a window (or any node) is implemented by inspecting the times on the incoming data points. As a result if the incoming data stream stops then no more windows will be emitted because time is no longer increasing for the window node.
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.
Wether to align the window edges with the zero time. If not aligned the window starts and ends relative to the first data point it receives.
How often the current window is emitted into the pipeline.
The period, or length in time, of the window.
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.
Create a new node that computes the derivative of adjacent points.
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.
Group the data by a set of tags.
Can pass literal * to group by all dimensions. Example:
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".
Create an influxdb output node that will store the incoming data into InfluxDB.
Join this node with other nodes. The data is joined on timestamp.
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 idependently. 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.
Create a new node that samples the incoming points or batches.
One point will be emitted every count or duration specified.
Perform the union of this node and all other given nodes.
Create a new node that filters the data stream by a given expression.
Create a new node that windows the stream by time.
NOTE: Window can only be applied to stream edges.