Kapacitor 1.7 (#5151)
* Kapacitor 1.7 and reorg * fixed references to kapacitor 1.6pull/5153/head^2
Scott Anderson
GitHub
parent
7c550ce9c8
commit
09d283ff56
|
|
@ -111,7 +111,7 @@ For example, Chronograf's Slack integration allows users to specify a default ch
|
|||
3. Click **Save Changes** to save the configuration settings.
|
||||
4. Click **Send Test Alert** to verify the configuration.
|
||||
|
||||
To enable Kafka services using TICKscript, see [Kafka event handler (Kapacitor)](/kapacitor/v1/event_handlers/kafka/).
|
||||
To enable Kafka services using TICKscript, see [Kafka event handler (Kapacitor)](/kapacitor/v1/reference/event_handlers/kafka/).
|
||||
|
||||
### OpsGenie
|
||||
|
||||
|
|
@ -146,9 +146,9 @@ Send an incident alert to OpsGenie teams and recipients using the Chronograf ale
|
|||
|
||||
See [Alert API](https://docs.opsgenie.com/docs/alert-api) in the OpsGenie documentation for details on the OpsGenie Alert API
|
||||
|
||||
See [OpsGenie V2 event handler](/kapacitor/v1/event_handlers/opsgenie/v2/) in the Kapacitor documentation for details about the OpsGenie V2 event handler.
|
||||
See [OpsGenie V2 event handler](/kapacitor/v1/reference/event_handlers/opsgenie/v2/) in the Kapacitor documentation for details about the OpsGenie V2 event handler.
|
||||
|
||||
See the [AlertNode (Kapacitor TICKscript node) - OpsGenie v2](/kapacitor/v1/nodes/alert_node/#opsgenie-v2) in the Kapacitor documentation for details about enabling OpsGenie services using TICKscripts.
|
||||
See the [AlertNode (Kapacitor TICKscript node) - OpsGenie v2](/kapacitor/v1/reference/nodes/alert_node/#opsgenie-v2) in the Kapacitor documentation for details about enabling OpsGenie services using TICKscripts.
|
||||
|
||||
### PagerDuty
|
||||
|
||||
|
|
@ -175,7 +175,7 @@ Use the [PagerDuty2](#pagerduty2) alert endpoint.
|
|||
See the [PagerDuty Events API V2 Overview](https://v2.developer.pagerduty.com/docs/events-api-v2)
|
||||
for details on the PagerDuty Events API and recognized event types (`trigger`, `acknowledge`, and `resolve`).
|
||||
|
||||
To enable a new "Generic API" service using TICKscript, see [AlertNode (Kapacitor TICKscript node) - PagerDuty v2](/kapacitor/v1/nodes/alert_node/#pagerduty-v2).
|
||||
To enable a new "Generic API" service using TICKscript, see [AlertNode (Kapacitor TICKscript node) - PagerDuty v2](/kapacitor/v1/reference/nodes/alert_node/#pagerduty-v2).
|
||||
|
||||
### Pushover
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ menu:
|
|||
|
||||
Chronograf provides a user interface for [Kapacitor](/kapacitor/v1/), InfluxData's processing framework for creating alerts, ETL jobs (running extract, transform, load), and detecting anomalies in your data.
|
||||
Chronograf alert rules correspond to Kapacitor tasks that trigger alerts whenever certain conditions are met.
|
||||
Behind the scenes, these tasks are stored as [TICKscripts](/kapacitor/v1/tick/) that can be edited manually or through Chronograf.
|
||||
Behind the scenes, these tasks are stored as [TICKscripts](/kapacitor/v1/reference/tick/) that can be edited manually or through Chronograf.
|
||||
Common alerting use cases that can be managed using Chronograf include:
|
||||
|
||||
* Thresholds with static ceilings, floors, and ranges.
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ What does a leaderboard need to do?
|
|||
1. Store the results.
|
||||
|
||||
To complete step one we need to buffer the incoming stream and return the most recent score update per player per game.
|
||||
Our [TICKscript](/kapacitor/v1/tick/) will look like this:
|
||||
Our [TICKscript](/kapacitor/v1/reference/tick/) will look like this:
|
||||
|
||||
```javascript
|
||||
var topPlayerScores = stream
|
||||
|
|
@ -134,7 +134,7 @@ var topScores = topPlayerScores
|
|||
|
||||
The `topScores` variable now contains the top 15 player's score per game.
|
||||
All we need to be able to build our leaderboard.
|
||||
Kapacitor can expose the scores over HTTP via the [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/).
|
||||
Kapacitor can expose the scores over HTTP via the [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/).
|
||||
We will call our task `top_scores`; with the following addition the most recent scores will be available at
|
||||
`http://localhost:9092/kapacitor/v1/tasks/top_scores/top_scores`.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ v2: /influxdb/v2/query-data/get-started/
|
|||
---
|
||||
|
||||
Flux is a functional data scripting language designed for querying, analyzing, and acting on time series data.
|
||||
Its takes the power of [InfluxQL](/enterprise_influxdb/v1/query_language/spec/) and the functionality of [TICKscript](/kapacitor/v1/tick/introduction/) and combines them into a single, unified syntax.
|
||||
Its takes the power of [InfluxQL](/enterprise_influxdb/v1/query_language/spec/) and the functionality of [TICKscript](/kapacitor/v1/reference/tick/introduction/) and combines them into a single, unified syntax.
|
||||
|
||||
> Flux v0.65 is production-ready and included with **InfluxDB Enterprise v1.8+.
|
||||
> The InfluxDB v1.8 implementation of Flux is read-only and does not support
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ This article outlines many of the tasks possible with Flux but not InfluxQL and
|
|||
- [Work with geo-temporal data](#work-with-geo-temporal-data)
|
||||
|
||||
### Joins
|
||||
InfluxQL has never supported joins. They can be accomplished using [TICKscript](/kapacitor/v1/tick/introduction/),
|
||||
InfluxQL has never supported joins. They can be accomplished using [TICKscript](/kapacitor/v1/reference/tick/introduction/),
|
||||
but even TICKscript's join capabilities are limited.
|
||||
Flux's [`join()` function](/flux/v0/stdlib/universe/join/) lets you
|
||||
to join data **from any bucket, any measurement, and on any columns** as long as
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ and writes them to the `statuses` measurement in the InfluxDB `_monitoring`
|
|||
system bucket.
|
||||
|
||||
This function is comparable to
|
||||
TICKscript [`alert()`](/kapacitor/v1/nodes/alert_node/).
|
||||
TICKscript [`alert()`](/kapacitor/v1/reference/nodes/alert_node/).
|
||||
|
||||
##### Function type signature
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ v2: /influxdb/v2/query-data/get-started/
|
|||
---
|
||||
|
||||
Flux is a functional data scripting language designed for querying, analyzing, and acting on time series data.
|
||||
Its takes the power of [InfluxQL](/influxdb/v1/query_language/spec/) and the functionality of [TICKscript](/kapacitor/v1/tick/introduction/) and combines them into a single, unified syntax.
|
||||
Its takes the power of [InfluxQL](/influxdb/v1/query_language/spec/) and the functionality of [TICKscript](/kapacitor/v1/reference/tick/introduction/) and combines them into a single, unified syntax.
|
||||
|
||||
> Flux v0.65 is production-ready and included with [InfluxDB v1.8](/influxdb/v1/).
|
||||
> The InfluxDB v1.8 implementation of Flux is read-only and does not support
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ This article outlines many of the tasks possible with Flux but not InfluxQL and
|
|||
- [Work with geo-temporal data](#work-with-geo-temporal-data)
|
||||
|
||||
### Joins
|
||||
InfluxQL has never supported joins. They can be accomplished using [TICKscript](/kapacitor/v1/tick/introduction/),
|
||||
InfluxQL has never supported joins. They can be accomplished using [TICKscript](/kapacitor/v1/reference/tick/introduction/),
|
||||
but even TICKscript's join capabilities are limited.
|
||||
Flux's [`join()` function](/flux/v0/stdlib/universe/join/) allows you
|
||||
to join data **from any bucket, any measurement, and on any columns** as long as
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ Check out the following distinctions between Flux and InfluxQL:
|
|||
- [Work with geo-temporal data](#work-with-geo-temporal-data)
|
||||
|
||||
### Joins
|
||||
InfluxQL has never supported joins. Although you can use a join in a [TICKscript](/kapacitor/v1/tick/introduction/),
|
||||
InfluxQL has never supported joins. Although you can use a join in a [TICKscript](/kapacitor/v1/reference/tick/introduction/),
|
||||
TICKscript's join capabilities are limited.
|
||||
Flux's [`join()` function](/flux/v0/stdlib/universe/join/) lets you
|
||||
join data **from any bucket, any measurement, and on any columns** as long as
|
||||
|
|
|
|||
|
|
@ -1,9 +1,11 @@
|
|||
---
|
||||
title: Kapacitor documentation
|
||||
|
||||
description: >
|
||||
Kapacitor is an open source data processing framework that makes it easy to
|
||||
create alerts, run ETL jobs and detect anomalies.
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Kapacitor v1.6
|
||||
name: Kapacitor v1.7
|
||||
weight: 1
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
---
|
||||
title: CLA
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
name: CLA
|
||||
weight: 30
|
||||
parent: About the project
|
||||
url: https://influxdb.com/community/cla.html
|
||||
---
|
||||
|
|
@ -10,7 +10,7 @@ menu:
|
|||
weight: 201
|
||||
related:
|
||||
- /kapacitor/v1/working/api/#users, Kapacitor HTTP API – Manage users
|
||||
- /kapacitor/v1/user-types-permissions
|
||||
- /kapacitor/v1/reference/user-types-permissions
|
||||
---
|
||||
|
||||
Use user-based authorizations and permissions stored in Kapacitor to
|
||||
|
|
@ -98,7 +98,7 @@ authenticate requests to the Kapacitor HTTP API.
|
|||
For more information, see:
|
||||
|
||||
- [Kapacitor HTTP API – Create a user](/kapacitor/v1/working/api/#create-a-user)
|
||||
- [Kapacitor user types and permissions](/kapacitor/v1/user-types-permissions)
|
||||
- [Kapacitor user types and permissions](/kapacitor/v1/reference/user-types-permissions)
|
||||
|
||||
|
||||
## Authenticate with the Kapacitor CLI
|
||||
|
|
|
|||
|
|
@ -174,19 +174,35 @@ Enable and configure user authentication and authorization in Kapacitor.
|
|||
[auth]
|
||||
# Enable authentication for Kapacitor
|
||||
enabled = false
|
||||
|
||||
# User permissions cache expiration time.
|
||||
cache-expiration = "10m"
|
||||
|
||||
# Cost to compute bcrypt password hashes.
|
||||
# bcrypt rounds = 2^cost
|
||||
bcrypt-cost = 10
|
||||
|
||||
# Address of a meta server.
|
||||
# If empty then meta, is not used as a user backend.
|
||||
# host:port
|
||||
meta-addr = "172.17.0.2:8091"
|
||||
meta-use-tls = false
|
||||
|
||||
# Username for basic user authorization when using meta API. meta-password should also be set.
|
||||
meta-username = "kapauser"
|
||||
|
||||
# Password for basic user authorization when using meta API. meta-username must also be set.
|
||||
meta-password = "kapapass"
|
||||
|
||||
# Shared secret for JWT bearer token authentication when using meta API.
|
||||
# If this is set, then the `meta-username` and `meta-password` settings are ignored.
|
||||
# This should match the `[meta] internal-shared-secret` setting on the meta nodes.
|
||||
meta-internal-shared-secret = "MyVoiceIsMyPassport"
|
||||
|
||||
# Absolute path to PEM encoded Certificate Authority (CA) file.
|
||||
# A CA can be provided without a key/certificate pair.
|
||||
meta-ca = "/etc/kapacitor/ca.pem"
|
||||
|
||||
# Absolute paths to PEM encoded private key and server certificate files.
|
||||
meta-cert = "/etc/kapacitor/cert.pem"
|
||||
meta-key = "/etc/kapacitor/key.pem"
|
||||
|
|
@ -382,7 +398,7 @@ Use the `[storage]` group to define the location of the BoltDB database file on
|
|||
#### Deadman
|
||||
|
||||
Use the `[deadman]` group to configure Kapacitor's deadman's switch globally.
|
||||
See the [Deadman](/kapacitor/v1/nodes/alert_node/#deadman) helper function topic in the AlertNode documentation.
|
||||
See the [Deadman](/kapacitor/v1/reference/nodes/alert_node/#deadman) helper function topic in the AlertNode documentation.
|
||||
|
||||
```toml
|
||||
# ...
|
||||
|
|
@ -581,7 +597,7 @@ to store statistics in.
|
|||
|
||||
#### Alert
|
||||
Use the `[alert]` group to globally configure alerts created by the
|
||||
[alertNode](/kapacitor/v1/nodes/alert_node).
|
||||
[alertNode](/kapacitor/v1/reference/nodes/alert_node).
|
||||
|
||||
```toml
|
||||
# ...
|
||||
|
|
@ -616,7 +632,7 @@ Optional features include:
|
|||
|
||||
Event handlers manage communications from Kapacitor to third party services or
|
||||
across Internet standard messaging protocols.
|
||||
They are activated through chaining methods on the [AlertNode](/kapacitor/v1/nodes/alert_node/).
|
||||
They are activated through chaining methods on the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/).
|
||||
|
||||
Every event handler has the property `enabled`.
|
||||
They also need an endpoint to send messages to.
|
||||
|
|
@ -625,12 +641,12 @@ Most include an authentication mechanism such as a `token` or a pair of properti
|
|||
|
||||
For information about available event handlers and their configuration options:
|
||||
|
||||
<a class="btn" href="/kapacitor/v1/event_handlers/">View available event handlers</a>
|
||||
<a class="btn" href="/kapacitor/v1/reference/event_handlers/">View available event handlers</a>
|
||||
|
||||
#### Docker services
|
||||
|
||||
Use Kapacitor to trigger changes in Docker clusters with [SwarmAutoScale](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
and [K8sAutoScale](/kapacitor/v1/nodes/k8s_autoscale_node/) nodes.
|
||||
Use Kapacitor to trigger changes in Docker clusters with [SwarmAutoScale](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
and [K8sAutoScale](/kapacitor/v1/reference/nodes/k8s_autoscale_node/) nodes.
|
||||
|
||||
- [Swarm](#swarm)
|
||||
- [Kubernetes](#kubernetes)
|
||||
|
|
@ -656,7 +672,7 @@ and [K8sAutoScale](/kapacitor/v1/nodes/k8s_autoscale_node/) nodes.
|
|||
# ...
|
||||
```
|
||||
{{% caption %}}
|
||||
See [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/).
|
||||
See [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/).
|
||||
{{% /caption %}}
|
||||
|
||||
##### Kubernetes
|
||||
|
|
@ -691,12 +707,12 @@ See [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/).
|
|||
# ...
|
||||
```
|
||||
{{% caption %}}
|
||||
_See [K8sAutoScaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)._
|
||||
_See [K8sAutoScaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)._
|
||||
{{% /caption %}}
|
||||
|
||||
#### User defined functions (UDFs)
|
||||
|
||||
Use Kapacitor to run user defined functions ([UDF](/kapacitor/v1/nodes/u_d_f_node/)),
|
||||
Use Kapacitor to run user defined functions ([UDF](/kapacitor/v1/reference/nodes/u_d_f_node/)),
|
||||
as chaining methods in a TICKscript.
|
||||
Define a UDF configuration group in your `kapacitor.conf` using the group
|
||||
identifier pattern:
|
||||
|
|
|
|||
|
|
@ -390,7 +390,7 @@ kapacitord -blacklist-cidrs 10.0.0.0/8,0.0.0.0/32
|
|||
### Disable specific alert handlers
|
||||
|
||||
Use the `-disable-handlers` flag to disable a set of alert handlers.
|
||||
Pass a comma-separated list of [handlers](/kapacitor/v1/event_handlers/):
|
||||
Pass a comma-separated list of [handlers](/kapacitor/v1/reference/event_handlers/):
|
||||
|
||||
```sh
|
||||
kapacitord -disable-handlers exec,httppost
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ Kapacitor subscribes to InfluxDB allowing it to capture, manipulate, and act on
|
|||
|
||||
## How Kapacitor subscriptions work
|
||||
Kapacitor allows you to manipulate and act on data as it is written into InfluxDB.
|
||||
Rather than querying InfluxDB for data *(except when using the [BatchNode](/kapacitor/v1/nodes/batch_node/))*,
|
||||
Rather than querying InfluxDB for data *(except when using the [BatchNode](/kapacitor/v1/reference/nodes/batch_node/))*,
|
||||
all data is copied to your Kapacitor server or cluster through an InfluxDB subscription.
|
||||
This reduces the query load on InfluxDB and isolates overhead associated with data
|
||||
manipulation to your Kapacitor server or cluster.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
title: Upgrade to Kapacitor v1.6
|
||||
title: Upgrade to Kapacitor v1
|
||||
description: Upgrade to the latest version of Kapacitor.
|
||||
aliases:
|
||||
- kapacitor/v1.6/introduction/upgrading/
|
||||
- kapacitor/v1/introduction/upgrading/
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
parent: Administration
|
||||
|
|
@ -32,7 +32,7 @@ Before proceeding with the Kapacitor upgrade please ensure that InfluxDB and Tel
|
|||
|
||||
For instructions on upgrading InfluxDB, please see the [InfluxDB upgrade](/influxdb/v1/administration/upgrading/) documentation.
|
||||
|
||||
For information about what is new in the latest Kapacitor release, view the [Changelog](/kapacitor/v1/about_the_project/releasenotes-changelog/).
|
||||
For information about what is new in the latest Kapacitor release, view the [Changelog](/kapacitor/v1/reference/about_the_project/release-notes/).
|
||||
|
||||
In general the steps for upgrading Kapacitor are as follows:
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Guides
|
||||
description: Step-by-step guides for working with Kapacitor.
|
||||
aliases:
|
||||
- kapacitor/v1.6/examples/
|
||||
- kapacitor/v1/examples/
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Guides
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Custom anomaly detection using Kapacitor
|
||||
description: Detect anomalies in Kapacitor with user-defined functions (UDFs).
|
||||
aliases:
|
||||
- kapacitor/v1.6/examples/anomaly_detection/
|
||||
- kapacitor/v1/examples/anomaly_detection/
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Custom anomaly detection
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Kapacitor as a Continuous Query engine
|
||||
description: Use Kapacitor to downsample and process data at scheduled intervals.
|
||||
aliases:
|
||||
- kapacitor/v1.6/examples/continuous_queries/
|
||||
- kapacitor/v1/examples/continuous_queries/
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Kapacitor as a Continuous Query engine
|
||||
|
|
@ -156,7 +156,7 @@ batch
|
|||
|
||||
Kapacitor is a powerful tool.
|
||||
If you need more flexibility than CQs offer, use it.
|
||||
For more information and help writing TICKscripts from InfluxQL queries take a look at these [docs](/kapacitor/v1/nodes/influx_q_l_node/) on the InfluxQL node in Kapacitor.
|
||||
For more information and help writing TICKscripts from InfluxQL queries take a look at these [docs](/kapacitor/v1/reference/nodes/influx_q_l_node/) on the InfluxQL node in Kapacitor.
|
||||
Every function available in the InfluxDB query language is available in Kapacitor, so you can convert any query into a Kapacitor TICKscript.
|
||||
|
||||
## Important to Know
|
||||
|
|
|
|||
|
|
@ -8,17 +8,17 @@ menu:
|
|||
parent: guides
|
||||
---
|
||||
|
||||
Integrate Kapacitor into your monitoring system by sending [alert messages](/kapacitor/v1/nodes/alert_node/#message)
|
||||
Integrate Kapacitor into your monitoring system by sending [alert messages](/kapacitor/v1/reference/nodes/alert_node/#message)
|
||||
to supported event handlers.
|
||||
Currently, Kapacitor can send alert messages to specific log files and specific URLs,
|
||||
as well as to applications such as [Slack](https://slack.com/) and [HipChat](https://www.hipchat.com/).
|
||||
|
||||
This document offers step-by-step instructions for setting up event handlers with Kapacitor,
|
||||
including relevant configuration options and [TICKscript](/kapacitor/v1/tick/) syntax.
|
||||
including relevant configuration options and [TICKscript](/kapacitor/v1/reference/tick/) syntax.
|
||||
Currently, this document doesn't cover every supported event handler, but we will
|
||||
continue to add content to this page over time.
|
||||
For a complete list of the supported event handlers and for additional information,
|
||||
please see the [event handler reference documentation](/kapacitor/v1/nodes/alert_node/).
|
||||
please see the [event handler reference documentation](/kapacitor/v1/reference/nodes/alert_node/).
|
||||
|
||||
[HipChat Setup](#hipchat-setup)
|
||||
[Telegram Setup](#telegram-setup")
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Kapacitor allows you to build out a robust monitoring and alerting solution with
|
|||
multiple "levels" or "tiers" of alerts.
|
||||
However, an issue arises when an event triggers both high-level and low-level alerts
|
||||
and you end up getting multiple alerts from different contexts.
|
||||
The [AlertNode's `.inhibit()`](/kapacitor/v1/nodes/alert_node/#inhibit) method
|
||||
The [AlertNode's `.inhibit()`](/kapacitor/v1/reference/nodes/alert_node/#inhibit) method
|
||||
allows you to suppress other alerts when an alert is triggered.
|
||||
|
||||
For example, let's say you are monitoring a cluster of servers.
|
||||
|
|
@ -62,7 +62,7 @@ stream
|
|||
```
|
||||
|
||||
The following TICKscript is a cluster-level alert that monitors the uptime of hosts in the cluster.
|
||||
It uses the [`deadman()`](/kapacitor/v1/nodes/alert_node/#deadman) function to
|
||||
It uses the [`deadman()`](/kapacitor/v1/reference/nodes/alert_node/#deadman) function to
|
||||
create an alert when a host is unresponsive or offline.
|
||||
The `.inhibit()` method in the deadman alert suppresses all alerts to the `system_alerts`
|
||||
category that include a matching `host` tag, meaning they are from the same host.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Calculate rates across joined series + backfill
|
|||
description: >
|
||||
Use a prepared data generator to calculate rates across joined series and backfill.
|
||||
aliases:
|
||||
- kapacitor/v1.6/examples/join_backfill/
|
||||
- kapacitor/v1/examples/join_backfill/
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Calculate rates across series
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Live leaderboard of game scores
|
|||
description: >
|
||||
Tutorial on using Kapacitor stream processing and Chronograf to build a leaderboard for gamers to be able to see player scores in realtime. Historical data is also available for post-game analysis.
|
||||
aliases:
|
||||
- kapacitor/v1.6/examples/live_leaderboard/
|
||||
- kapacitor/v1/examples/live_leaderboard/
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Live leaderboard
|
||||
|
|
@ -99,7 +99,7 @@ What does a leaderboard need to do?
|
|||
1. Store the results.
|
||||
|
||||
To complete step one we need to buffer the incoming stream and return the most recent score update per player per game.
|
||||
Our [TICKscript](/kapacitor/v1/tick/) will look like this:
|
||||
Our [TICKscript](/kapacitor/v1/reference/tick/) will look like this:
|
||||
|
||||
```js
|
||||
var topPlayerScores = stream
|
||||
|
|
@ -135,7 +135,7 @@ var topScores = topPlayerScores
|
|||
|
||||
The `topScores` variable now contains the top 15 player's score per game.
|
||||
All we need to be able to build our leaderboard.
|
||||
Kapacitor can expose the scores over HTTP via the [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/).
|
||||
Kapacitor can expose the scores over HTTP via the [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/).
|
||||
We will call our task `top_scores`; with the following addition the most recent scores will be available at
|
||||
`http://localhost:9092/kapacitor/v1/tasks/top_scores/top_scores`.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Load directory service
|
|||
description: >
|
||||
The load directory service enables file-based definitions of Kapacitor tasks, templates, and topic handlers that are loaded on startup or when a SIGHUP signal is sent to the process.
|
||||
aliases:
|
||||
- kapacitor/v1.6/examples/load_directory/
|
||||
- kapacitor/v1/examples/load_directory/
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Load directory service
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Reference TICKscripts
|
||||
description: Example TICKscripts available in the Kapacitor repository.
|
||||
aliases:
|
||||
- kapacitor/v1.6/examples/reference_scripts/
|
||||
- kapacitor/v1/examples/reference_scripts/
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Reference TICKscripts
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ without triggering alerts.
|
|||
|
||||
## Sideload
|
||||
Avoid unnecessary alerts during scheduled downtime by using the
|
||||
[`sideload`](/kapacitor/v1/nodes/sideload_node) node to load information from
|
||||
[`sideload`](/kapacitor/v1/reference/nodes/sideload_node) node to load information from
|
||||
files in the filesystem and set fields and tags on data points which can then be used in alert logic.
|
||||
The `sideload` node adds fields and tags to points based on hierarchical data
|
||||
from various file-based sources.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Write socket-based user-defined functions (UDFs)
|
|||
description: >
|
||||
Learn how to write a simple socket-based UDF.
|
||||
aliases:
|
||||
- kapacitor/v1.6/examples/socket_udf/
|
||||
- kapacitor/v1/examples/socket_udf/
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Write socket-based UDFs
|
||||
|
|
@ -649,7 +649,7 @@ custom anomaly detection algorithms, or simply a system to "massage" your data a
|
|||
|
||||
If you want to learn more, here are a few places to start:
|
||||
|
||||
* Modify the mirror UDF, to function like the [DefaultNode](/kapacitor/v1/nodes/default_node/).
|
||||
* Modify the mirror UDF, to function like the [DefaultNode](/kapacitor/v1/reference/nodes/default_node/).
|
||||
Instead of always overwriting a field, only set it if the field is not absent.
|
||||
Also add support for setting tags as well as fields.
|
||||
* Change the mirror UDF to work on batches instead of streams.
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ As an added bonus, we'll also include a query that can be used to graph the perc
|
|||
difference between the two measurements.
|
||||
|
||||
## Comparing measurements and creating an alert
|
||||
The following [TICKscript](/kapacitor/v1/tick/) streams the `m1` and `m2` measurements,
|
||||
The following [TICKscript](/kapacitor/v1/reference/tick/) streams the `m1` and `m2` measurements,
|
||||
joins them, compares them, and triggers an alert if the two measurements are different.
|
||||
|
||||
```js
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Use Kapacitor to import (stream or batch) time series data, and then transform,
|
|||
|
||||
## Overview
|
||||
|
||||
Kapacitor tasks define work to do on a set of data using [TICKscript](/kapacitor/v1/tick/) syntax. Kapacitor tasks include:
|
||||
Kapacitor tasks define work to do on a set of data using [TICKscript](/kapacitor/v1/reference/tick/) syntax. Kapacitor tasks include:
|
||||
|
||||
- `stream` tasks. A stream task replicates data written to InfluxDB in Kapacitor. Offloads query overhead and requires Kapacitor to store the data on disk.
|
||||
- `batch` tasks. A batch task queries and processes data for a specified interval.
|
||||
|
|
@ -474,7 +474,7 @@ Something so simple as defining an alert can quickly be extended to apply to a m
|
|||
With the above script, an alert will be triggered if any service in any datacenter deviates more than 3
|
||||
standard deviations away from normal behavior as defined by the historical 95th percentile of cpu usage, and will do so within 1 minute!
|
||||
|
||||
For more information on how alerting works, see the [AlertNode](/kapacitor/v1/nodes/alert_node/) docs.
|
||||
For more information on how alerting works, see the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) docs.
|
||||
|
||||
## Trigger alerts from batch data
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ menu:
|
|||
|
||||
## Getting Started with TICK and Docker Compose
|
||||
|
||||
This short tutorial will demonstrate starting TICK stack components (InfluxDB, Telegraf, Kapacitor) with Docker Compose and then using that stack to learn the rudiments of working with Kapacitor and the [TICKscript](/kapacitor/v1/tick/) domain specific language (DSL). The following discussion is based on the tutorial project package (named tik-docker-tutorial.tar.gz) that can be downloaded from [this location](/downloads/tik-docker-tutorial.tar.gz). It will create a running deployment of these applications that can be used for an initial evaluation and testing of Kapacitor. Chronograf is currently not included in the package.
|
||||
This short tutorial will demonstrate starting TICK stack components (InfluxDB, Telegraf, Kapacitor) with Docker Compose and then using that stack to learn the rudiments of working with Kapacitor and the [TICKscript](/kapacitor/v1/reference/tick/) domain specific language (DSL). The following discussion is based on the tutorial project package (named tik-docker-tutorial.tar.gz) that can be downloaded from [this location](/downloads/tik-docker-tutorial.tar.gz). It will create a running deployment of these applications that can be used for an initial evaluation and testing of Kapacitor. Chronograf is currently not included in the package.
|
||||
|
||||
This tutorial depends on Docker Compose 3.0 to deploy the latest Docker 17.0+ compatible images of InfluxDB, Telegraf and Kapacitor.
|
||||
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ kapacitord config > kapacitor.generated.conf
|
|||
|
||||
### Shared secret
|
||||
|
||||
If using [Kapacitor v1.5.3](/kapacitor/v1/about_the_project/releasenotes-changelog/#v1-5-3-2019-06-18)
|
||||
If using [Kapacitor v1.5.3](/kapacitor/v1/reference/about_the_project/release-notes/#v1-5-3-2019-06-18)
|
||||
or newer and InfluxDB with [authentication enabled](/influxdb/v1/administration/authentication_and_authorization/),
|
||||
set the `[http].shared-secret` option in your Kapacitor configuration file to the
|
||||
shared secret of your InfluxDB instances.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: Kapacitor reference
|
||||
description: >
|
||||
Reference information related to Kapacitor.
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: Reference
|
||||
---
|
||||
|
||||
{{< children >}}
|
||||
|
|
@ -1,11 +1,16 @@
|
|||
---
|
||||
title: About the project
|
||||
description:
|
||||
View information about the Kapacitor project including release notes, licenses,
|
||||
and contribution guidelines.
|
||||
aliases:
|
||||
- kapacitor/v1.6/contributing/
|
||||
- /kapacitor/v1/contributing/
|
||||
- /kapacitor/v1/about_the_project/
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: About the project
|
||||
weight: 1
|
||||
parent: Reference
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Kapacitor is open source and we welcome contributions from the community.
|
||||
|
|
@ -14,15 +19,18 @@ If you want Kapacitor to be able to output to your own endpoint see
|
|||
[Contributing new Kapacitor output nodes](/kapacitor/v1/working/custom_output/).
|
||||
|
||||
## Kapacitor release notes
|
||||
View the [Kapacitor release notes](/kapacitor/v1/about_the_project/releasenotes-changelog/)
|
||||
|
||||
View the [Kapacitor release notes](/kapacitor/v1/reference/about_the_project/release-notes/)
|
||||
for important information about Kapacitor releases.
|
||||
|
||||
## Contributions and licenses
|
||||
|
||||
- [Contribute to Kapacitor](https://github.com/influxdata/kapacitor/blob/master/CONTRIBUTING.md)
|
||||
- [Contributor License Agreement (CLA)](https://influxdata.com/community/cla/)
|
||||
- [Licenses](https://github.com/influxdata/kapacitor/blob/master/LICENSE)
|
||||
|
||||
### Third Party Software
|
||||
## Third Party Software
|
||||
|
||||
InfluxData products contain third party software, which means the copyrighted, patented, or otherwise legally protected
|
||||
software of third parties that is incorporated in InfluxData products.
|
||||
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: CLA
|
||||
|
||||
menu:
|
||||
kapacitor_v1:
|
||||
name: CLA
|
||||
weight: 30
|
||||
parent: About the project
|
||||
url: https://influxdb.com/community/cla.html
|
||||
---
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: Contributing
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Contributing
|
||||
weight: 10
|
||||
parent: About the project
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: License
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: License
|
||||
weight: 40
|
||||
parent: About the project
|
||||
|
|
@ -2,9 +2,32 @@
|
|||
title: Kapacitor release notes
|
||||
description: Important features and changes in the latest version of Kapacitor.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
parent: About the project
|
||||
name: Release notes
|
||||
aliases:
|
||||
- /kapacitor/v1/about_the_project/releasenotes-changelog/
|
||||
---
|
||||
|
||||
## v1.7.0 [2023-08-18]
|
||||
|
||||
### Features
|
||||
|
||||
- Update topic store to allow incremental updates.
|
||||
|
||||
---
|
||||
|
||||
## v1.6.6 [2023-04-12]
|
||||
|
||||
### Features
|
||||
|
||||
- Add JWT meta API authentication using the `[auth] meta-internal-shared-secret`
|
||||
configuration parameter.
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- Support InfluxDB 1.9.6 and OpenTSB by implementing `WritePointsPrivileged`
|
||||
|
||||
---
|
||||
|
||||
## v1.6.5 [2022-8-18]
|
||||
|
|
@ -19,6 +42,8 @@ menu:
|
|||
- Update the `Kafka` client to fix a bug regarding write latency.
|
||||
- Update to [Flux v0.171.0](/flux/v0.x/release-notes/#v01710-2022-06-14) to fix "interface {} is nil, not string" issue.
|
||||
|
||||
---
|
||||
|
||||
## v1.6.4 [2022-03-15]
|
||||
|
||||
### Features
|
||||
|
|
@ -30,12 +55,14 @@ menu:
|
|||
- Fully deprecate DES based ciphers, RC4 based ciphers and TLS 1.1 and 1.0 ciphers.
|
||||
- Adjust `Flux` injected dependencies so that large data sets can be downloaded without issue.
|
||||
|
||||
---
|
||||
|
||||
## v1.6.3 [2022-01-25]
|
||||
|
||||
### Features
|
||||
|
||||
- Add support for custom `attributes` field in [Alerta event handler](/kapacitor/v1/event_handlers/alerta/).
|
||||
- Add `host` and `attribute` options to [BigPanda event handler](/kapacitor/v1/event_handlers/bigpanda/):
|
||||
- Add support for custom `attributes` field in [Alerta event handler](/kapacitor/v1/reference/event_handlers/alerta/).
|
||||
- Add `host` and `attribute` options to [BigPanda event handler](/kapacitor/v1/reference/event_handlers/bigpanda/):
|
||||
- `host`: Identifies the main object that caused the alert.
|
||||
- `attribute`: Adds additional attribute(s) to the alert payload.
|
||||
- Add new `auto-attributes` configuration option to BigPanda node.
|
||||
|
|
@ -50,6 +77,8 @@ is 1000.
|
|||
- Deprecated ciphers identified as "weak" in response to the [sweet32](https://sweet32.info/) attack.
|
||||
- Add additional detail to the error message `missing flux data`. This error is generated when issues occur when running a **Flux** query within a batch TICKscript.
|
||||
|
||||
---
|
||||
|
||||
## v1.6.2 [2021-09-24]
|
||||
|
||||
### Features
|
||||
|
|
@ -64,6 +93,8 @@ is 1000.
|
|||
- Update `jwt` dependencies and switch to `github.com/golang-jwt/jwt` to remediate the [CVE-2020-26160 vulnerability](https://nvd.nist.gov/vuln/detail/CVE-2020-26160).
|
||||
- Switch task service to use Flux formatter that preserves comments.
|
||||
|
||||
---
|
||||
|
||||
## v1.6.1 [2021-07-22]
|
||||
|
||||
### Features
|
||||
|
|
@ -77,6 +108,8 @@ is 1000.
|
|||
- Align `DeleteGroupMessage` with `GroupInfo` interface.
|
||||
- Fix payload serialization for BigPanda.
|
||||
|
||||
---
|
||||
|
||||
## v1.6.0 [2021-06-28]
|
||||
|
||||
{{% warn %}}
|
||||
|
|
@ -106,35 +139,37 @@ If you are using a 32-bit operating system, continue using Kapacitor 1.5.x.
|
|||
- Provide ARM 64-bit builds.
|
||||
- Add Kapacitor [Flux task commands](/kapacitor/v1/working/cli_client/#flux-tasks) to the `kapacitor` CLI.
|
||||
- Add built-in Flux engine to support [Flux tasks in Kapacitor](/kapacitor/v1/working/flux/).
|
||||
- Add [QueryFluxNode](/kapacitor/v1/nodes/query_flux_node/) for querying with Flux in batch tasks.
|
||||
- Add [Zenoss event handler](/kapacitor/v1/event_handlers/zenoss/).
|
||||
- Route [Kafka alerts](/kapacitor/v1/event_handlers/kafka/) to partitions by
|
||||
- Add [QueryFluxNode](/kapacitor/v1/reference/nodes/query_flux_node/) for querying with Flux in batch tasks.
|
||||
- Add [Zenoss event handler](/kapacitor/v1/reference/event_handlers/zenoss/).
|
||||
- Route [Kafka alerts](/kapacitor/v1/reference/event_handlers/kafka/) to partitions by
|
||||
message ID and support hashing strategy configuration.
|
||||
- Add user-based authentication.
|
||||
- Add [TrickleNode](/kapacitor/v1/nodes/trickle_node/) to convert batches to streams.
|
||||
- Update [Slack event handler](/kapacitor/v1/event_handlers/slack/) to support new-style Slack applications.
|
||||
- Handle Delete messages in [joinNode](/kapacitor/v1/nodes/join_node/).
|
||||
- Add [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/) to convert batches to streams.
|
||||
- Update [Slack event handler](/kapacitor/v1/reference/event_handlers/slack/) to support new-style Slack applications.
|
||||
- Handle Delete messages in [joinNode](/kapacitor/v1/reference/nodes/join_node/).
|
||||
|
||||
### Bug fixes
|
||||
|
||||
- Fix a panic in the scraper handler when debug mode is enabled.
|
||||
|
||||
---
|
||||
|
||||
## v1.5.9 [2021-04-01]
|
||||
|
||||
### Features
|
||||
|
||||
#### New event handler
|
||||
|
||||
- Add new [BigPanda event handler](/kapacitor/v1/event_handlers/bigpanda).
|
||||
- Add new [BigPanda event handler](/kapacitor/v1/reference/event_handlers/bigpanda).
|
||||
|
||||
#### New configuration options
|
||||
|
||||
- Add support for the `correlate` option in the [Alerta event handler](/kapacitor/v1/event_handlers/alerta/), thanks @nermolaev!
|
||||
- Add the `details` option to the [OpsGenie v2 event handler](/kapacitor/v1/event_handlers/opsgenie/v2/); set this option to `true` to use the Kapacitor alert details as OpsGenie description text, thanks @JamesClonk!
|
||||
- Add support for the `correlate` option in the [Alerta event handler](/kapacitor/v1/reference/event_handlers/alerta/), thanks @nermolaev!
|
||||
- Add the `details` option to the [OpsGenie v2 event handler](/kapacitor/v1/reference/event_handlers/opsgenie/v2/); set this option to `true` to use the Kapacitor alert details as OpsGenie description text, thanks @JamesClonk!
|
||||
|
||||
#### Support for HTTP sources in SideLoadNode
|
||||
|
||||
- Add support for HTTP [sources](/kapacitor/v1/nodes/sideload_node/#source) in `SideloadNode` configuration, thanks @jregovic!
|
||||
- Add support for HTTP [sources](/kapacitor/v1/reference/nodes/sideload_node/#source) in `SideloadNode` configuration, thanks @jregovic!
|
||||
|
||||
#### Performance and security improvements
|
||||
|
||||
|
|
@ -145,9 +180,9 @@ If you are using a 32-bit operating system, continue using Kapacitor 1.5.x.
|
|||
|
||||
#### Miscellaneous event updates
|
||||
|
||||
- Send the full event payload to [Pagerduty](/kapacitor/v1/event_handlers/pagerduty/v2/) when the `eventAction` is `resolve`, thanks @asvinours!
|
||||
- Add the default color theme to [Microsoft Teams](/kapacitor/v1/event_handlers/microsoftteams/) alerts, thanks @NoamShaish!
|
||||
- Add barrier handling to [FlattenNode](/kapacitor/v1/nodes/flatten_node/) to ensure points are successfully emitted.
|
||||
- Send the full event payload to [Pagerduty](/kapacitor/v1/reference/event_handlers/pagerduty/v2/) when the `eventAction` is `resolve`, thanks @asvinours!
|
||||
- Add the default color theme to [Microsoft Teams](/kapacitor/v1/reference/event_handlers/microsoftteams/) alerts, thanks @NoamShaish!
|
||||
- Add barrier handling to [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/) to ensure points are successfully emitted.
|
||||
|
||||
### Bug fixes
|
||||
|
||||
|
|
@ -158,34 +193,40 @@ If you are using a 32-bit operating system, continue using Kapacitor 1.5.x.
|
|||
- Remove support for `darwin/386` builds (Go no longer supports).
|
||||
- Rename the alert-handler match function `duration()` to `alertDuration()` to avoid name collision with the type conversion function of the same name.
|
||||
|
||||
---
|
||||
|
||||
## v1.5.8 [2020-01-27]
|
||||
|
||||
{{% warn %}}
|
||||
If you’ve installed this release, please roll back to v1.5.7 as soon as possible. This release introduced a defect wherein large batch tasks will not completely write all points back to InfluxDB. This primarily affects downsampling tasks where information is written to another retention policy. If the source retention policy is short there is the potential for the source data to age out and the downsample to have never been fully written.
|
||||
{{% /warn %}}
|
||||
|
||||
---
|
||||
|
||||
## v1.5.7 [2020-10-26]
|
||||
|
||||
### Features
|
||||
|
||||
- Add the `.recoveryaction()` method to support overriding the OpsGenieV2 alert recovery action in a TICKscript, thanks @zabullet!
|
||||
- Add support for templating URLs in the [`httpPost` node](/kapacitor/v1/nodes/http_post_node/) and [`alert` node](/kapacitor/v1/nodes/alert_node/). To set up an template:
|
||||
- For the `alert` node, see [alert templates](/kapacitor/v1/event_handlers/post/#alert-templates).
|
||||
- For the `http post` node, see [row templates](/kapacitor/v1/event_handlers/post/#row-templates).
|
||||
- Add support for templating URLs in the [`httpPost` node](/kapacitor/v1/reference/nodes/http_post_node/) and [`alert` node](/kapacitor/v1/reference/nodes/alert_node/). To set up an template:
|
||||
- For the `alert` node, see [alert templates](/kapacitor/v1/reference/event_handlers/post/#alert-templates).
|
||||
- For the `http post` node, see [row templates](/kapacitor/v1/reference/event_handlers/post/#row-templates).
|
||||
- Upgrade `github.com/gorhill/cronexpr`, thanks @wuguanyu!
|
||||
- Add the [ServiceNow event handler](/kapacitor/v1/event_handlers/servicenow/) to support ServiceNow integration and provide proxy support.
|
||||
- Add the [ServiceNow event handler](/kapacitor/v1/reference/event_handlers/servicenow/) to support ServiceNow integration and provide proxy support.
|
||||
|
||||
### Bug fixes
|
||||
|
||||
- Add error check when the system fails to read the replay file, thanks @johncming!
|
||||
- Add missing `.Details` to the alert template.
|
||||
|
||||
---
|
||||
|
||||
## v1.5.6 [2020-07-17]
|
||||
|
||||
### Features
|
||||
|
||||
- Add [Microsoft Teams event handler](/kapacitor/v1/event_handlers/microsoftteams/), thanks @mmindenhall!
|
||||
- Add [Discord event handler](/kapacitor/v1/event_handlers/discord/), thanks @mattnotmitt!
|
||||
- Add [Microsoft Teams event handler](/kapacitor/v1/reference/event_handlers/microsoftteams/), thanks @mmindenhall!
|
||||
- Add [Discord event handler](/kapacitor/v1/reference/event_handlers/discord/), thanks @mattnotmitt!
|
||||
- Add [support for TLS 1.3](/kapacitor/v1/administration/configuration/#transport-layer-security-tls).
|
||||
|
||||
### Bug fixes
|
||||
|
|
@ -199,6 +240,8 @@ If you’ve installed this release, please roll back to v1.5.7 as soon as possib
|
|||
- Fix a panic on int div-by-zero and return an error instead.
|
||||
- Fix issue that caused Kapacitor to ignore the `pushover().userKey('')` TICKScript operation.
|
||||
|
||||
---
|
||||
|
||||
## v1.5.5 [2020-04-20]
|
||||
|
||||
### Breaking changes
|
||||
|
|
@ -209,6 +252,8 @@ If you’ve installed this release, please roll back to v1.5.7 as soon as possib
|
|||
|
||||
- Update the Kafka client to ensure errors are added to Kapacitor logs.
|
||||
|
||||
---
|
||||
|
||||
## v1.5.4 [2020-01-16]
|
||||
|
||||
### Features
|
||||
|
|
@ -221,6 +266,8 @@ If you’ve installed this release, please roll back to v1.5.7 as soon as possib
|
|||
- Upgrade the Kafka library to set the timestamp correctly.
|
||||
- Upgrade to Go 1.13, fixes various `go vet` issues.
|
||||
|
||||
---
|
||||
|
||||
## v1.5.3 [2019-06-18]
|
||||
|
||||
{{% warn %}}
|
||||
|
|
@ -260,6 +307,8 @@ kapacitord[4313]: run: open server: open service *influxdb.Service: failed to li
|
|||
- Delete group stats when a group is deleted.
|
||||
- Avoid extra allocation when building GroupID.
|
||||
|
||||
---
|
||||
|
||||
## v1.5.2 [2018-12-12]
|
||||
|
||||
### Features
|
||||
|
|
@ -275,6 +324,8 @@ kapacitord[4313]: run: open server: open service *influxdb.Service: failed to li
|
|||
|
||||
- Fix join not catching up fast enough after a pause in the data stream.
|
||||
|
||||
---
|
||||
|
||||
## v1.5.1 [2018-08-06]
|
||||
|
||||
### Bug fixes
|
||||
|
|
@ -283,6 +334,8 @@ kapacitord[4313]: run: open server: open service *influxdb.Service: failed to li
|
|||
- Fix KafkaTopic not working from TICKscript.
|
||||
- Improve Kafka alert throughput.
|
||||
|
||||
---
|
||||
|
||||
## v1.5.0 [2018-05-17]
|
||||
|
||||
### Features
|
||||
|
|
@ -308,12 +361,16 @@ kapacitord[4313]: run: open server: open service *influxdb.Service: failed to li
|
|||
- Adjust PagerDuty v2 service-test names and capture detailed error messages.
|
||||
- Fix Kafka configuration.
|
||||
|
||||
---
|
||||
|
||||
## v1.4.1 [2018-03-13]
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* Fix bug where task type was invalid when using var for stream/batch
|
||||
|
||||
---
|
||||
|
||||
## v1.4.0 [2017-12-08]
|
||||
|
||||
### Release notes
|
||||
|
|
@ -388,18 +445,24 @@ The `Combine` and `Flatten` nodes previously operated (erroneously) across batch
|
|||
- Fixed issues with recusive symlinks on systemd systems.
|
||||
- Fixed invalid default MQTT config.
|
||||
|
||||
---
|
||||
|
||||
## v1.3.3 [2017-08-11]
|
||||
|
||||
### Bug fixes
|
||||
|
||||
- Expose pprof without authentication, if enabled.
|
||||
|
||||
---
|
||||
|
||||
## v1.3.2 [2017-08-08]
|
||||
|
||||
### Bug fixes
|
||||
|
||||
- Use details field from alert node in PagerDuty.
|
||||
|
||||
---
|
||||
|
||||
## v1.3.1 [2017-06-02]
|
||||
|
||||
### Bug fixes
|
||||
|
|
@ -407,6 +470,8 @@ The `Combine` and `Flatten` nodes previously operated (erroneously) across batch
|
|||
- Proxy from environment for HTTP request to Slack
|
||||
- Fix derivative node preserving fields from previous point in stream tasks
|
||||
|
||||
---
|
||||
|
||||
## v1.3.0 [2017-05-22]
|
||||
|
||||
### Release Notes
|
||||
|
|
@ -585,6 +650,8 @@ For more details on the alerting system, see the full documentation [here](/kapa
|
|||
- Fixed bug where aggregates would not be able to change type.
|
||||
- Fixed panic when the process cannot stat the data dir.
|
||||
|
||||
---
|
||||
|
||||
## v1.2.0 [2017-01-23]
|
||||
|
||||
### Release Notes
|
||||
|
|
@ -664,12 +731,16 @@ See the [API docs on technical preview](/kapacitor/v1/api/api/#technical-preview
|
|||
- logrotate.d ignores kapacitor configuration due to bad file mode.
|
||||
- Fix panic during failed aggregate results.
|
||||
|
||||
---
|
||||
|
||||
## v1.1.1 [2016-12-02]
|
||||
|
||||
### Release Notes
|
||||
|
||||
No changes to Kapacitor, only upgrading to GoLang 1.7.4 for security patches.
|
||||
|
||||
---
|
||||
|
||||
## v1.1.0 [2016-10-07]
|
||||
|
||||
### Release Notes
|
||||
|
|
@ -721,6 +792,8 @@ See the [API docs](/kapacitor/v1/api/api/) for more details.
|
|||
- Sort and dynamically adjust column width in CLI output.
|
||||
- Adds missing strLength function.
|
||||
|
||||
---
|
||||
|
||||
## v1.0.2 [2016-10-06]
|
||||
|
||||
### Bug fixes
|
||||
|
|
@ -728,6 +801,8 @@ See the [API docs](/kapacitor/v1/api/api/) for more details.
|
|||
- Fix bug where errors to save cluster/server ID files were ignored.
|
||||
- Create data_dir on startup if it does not exist.
|
||||
|
||||
---
|
||||
|
||||
## v1.0.1 [2016-09-26]
|
||||
|
||||
### Features
|
||||
|
|
@ -746,6 +821,8 @@ See the [API docs](/kapacitor/v1/api/api/) for more details.
|
|||
- Fix issue with TMax and the Holt-Winters method.
|
||||
- Fix bug with TMax and group by time.
|
||||
|
||||
---
|
||||
|
||||
## v1.0.0 [2016-09-02]
|
||||
|
||||
### Release Notes
|
||||
|
|
@ -5,19 +5,21 @@ description: >
|
|||
aliases:
|
||||
- /kapacitor/v1/working/event-handler-setup/
|
||||
- /kapacitor/v1/event_handlers/talk/
|
||||
- /kapacitor/v1/event_handlers/
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Event handlers
|
||||
weight: 50
|
||||
parent: Reference
|
||||
weight: 50
|
||||
---
|
||||
|
||||
Kapacitor can be integrated into a monitoring system by sending
|
||||
[alert messages](/kapacitor/v1/nodes/alert_node/#message) to supported event
|
||||
[alert messages](/kapacitor/v1/reference/nodes/alert_node/#message) to supported event
|
||||
handlers. Currently, Kapacitor can send alert messages to specific log files and
|
||||
specific URLs, as well as to many third party applications.
|
||||
|
||||
These documents outline configuration options, setup instructions,
|
||||
[handler file](#create-a-topic-handler-with-a-handler-file) and [TICKscript](/kapacitor/v1/tick/introduction/)
|
||||
[handler file](#create-a-topic-handler-with-a-handler-file) and [TICKscript](/kapacitor/v1/reference/tick/introduction/)
|
||||
syntax for officially supported Kapacitor event handlers.
|
||||
|
||||
{{< children type="list" >}}
|
||||
|
|
@ -109,6 +111,6 @@ stream
|
|||
{{% note %}}
|
||||
Events are sent to handlers if the alert is in a state other than ‘OK’ or the
|
||||
alert just changed to the ‘OK’ state from a non ‘OK’ state (the alert recovered).
|
||||
Use the [AlertNode.StateChangesOnly](/kapacitor/v1/nodes/alert_node/#statechangesonly)
|
||||
Use the [AlertNode.StateChangesOnly](/kapacitor/v1/reference/nodes/alert_node/#statechangesonly)
|
||||
property to send events to handlers only if the alert state changes.
|
||||
{{% /note %}}
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Aggregate
|
|||
description: >
|
||||
The aggregate event handler allows you to aggregate alerts messages over a specified interval. This page includes aggregate options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Aggregrate
|
||||
weight: 100
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/aggregate/
|
||||
---
|
||||
|
||||
The aggregate event handler aggregates multiple events into a single event.
|
||||
|
|
@ -16,7 +18,7 @@ interval into an aggregated topic.
|
|||
|
||||
## Options
|
||||
The following aggregate event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file).
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file).
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Alerta
|
|||
description: >
|
||||
The Alerta event handler allows you to send Kapacitor alerts to Alerta. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Alerta
|
||||
weight: 200
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/alerta/
|
||||
---
|
||||
|
||||
[Alerta](http://alerta.io/) is a monitoring tool used to consolidate and
|
||||
|
|
@ -53,7 +55,7 @@ When an alert with the same `resource` is received with an `event` in the `corre
|
|||
|
||||
## Options
|
||||
The following Alerta event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.alerta()` in a TICKscript.
|
||||
|
||||
<span style="color: #ff9e46; font-style: italic; font-size: .8rem;">* Required</span>
|
||||
|
|
@ -128,7 +130,7 @@ define an Alerta handler that subscribes to a topic and sends published alerts
|
|||
to Alerta.
|
||||
|
||||
> To avoid posting a message every alert interval, use
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/nodes/alert_node/#statechangesonly)
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/reference/nodes/alert_node/#statechangesonly)
|
||||
> so only events where the alert changed state are sent to Alerta.
|
||||
|
||||
The examples below use the following Alerta configuration defined in the `kapacitor.conf`:
|
||||
|
|
@ -4,10 +4,12 @@ list_title: BigPanda
|
|||
description: >
|
||||
The BigPanda event handler lets you to send Kapacitor alerts to BigPanda. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: BigPanda
|
||||
weight: 225
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/bigpanda/
|
||||
---
|
||||
|
||||
[BigPanda](https://bigpanda.io/) is an event correlation and automation platform that helps organizations prevent and resolve IT outages.
|
||||
|
|
@ -48,7 +50,7 @@ BigPanda Alert API URL.
|
|||
## Options
|
||||
|
||||
The following BigPanda event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.bigPanda()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Discord
|
|||
description: >
|
||||
The Discord event handler lets you send Kapacitor alerts to Discord. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Discord
|
||||
weight: 250
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/discord/
|
||||
---
|
||||
|
||||
[Discord](https://discordapp.com) is a popular chat service targeted primarily at gamers and by teams outside of gaming looking for a free solution.
|
||||
|
|
@ -90,7 +92,7 @@ _This is necessary if using a self-signed certificate._
|
|||
|
||||
## Options
|
||||
Set the following Discord event handler options in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.discord()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -138,7 +140,7 @@ alerts to Discord or define a Discord handler that subscribes to a topic and sen
|
|||
published alerts to Discord.
|
||||
|
||||
> To avoid posting a message every alert interval, use
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/nodes/alert_node/#statechangesonly)
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/reference/nodes/alert_node/#statechangesonly)
|
||||
> so only events where the alert changed state are sent to Discord.
|
||||
|
||||
See examples below for sample Discord configurations defined the `kapacitor.conf`:
|
||||
|
|
@ -282,7 +284,7 @@ stream
|
|||
.topic('500-errors')
|
||||
```
|
||||
|
||||
Below is an [aggregate](/kapacitor/v1/event_handlers/aggregate/) handler that
|
||||
Below is an [aggregate](/kapacitor/v1/reference/event_handlers/aggregate/) handler that
|
||||
subscribes to the `500-errors` topic, aggregates the number of 500 errors over a
|
||||
24 hour period, then publishes an aggregate message to the `500-errors-24h` topic.
|
||||
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Email (SMTP)
|
|||
description: >
|
||||
The "email" event handler allows you to send Kapacitor alerts via email. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Email
|
||||
weight: 300
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/email/
|
||||
---
|
||||
|
||||
The Email event handler sends alert messages via SMTP/email.
|
||||
|
|
@ -71,7 +73,7 @@ Only applies if `global` is `true`.
|
|||
|
||||
## Options
|
||||
The following Email event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.email()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -105,8 +107,8 @@ options:
|
|||
|
||||
### Using the SMTP/Email event handler
|
||||
The Email event handler can be used in both TICKscripts and handler files to email alerts.
|
||||
The email subject is the [AlertNode.Message](/kapacitor/v1/nodes/alert_node/#message) property.
|
||||
The email body is the [AlertNode.Details](/kapacitor/v1/nodes/alert_node/#details) property.
|
||||
The email subject is the [AlertNode.Message](/kapacitor/v1/reference/nodes/alert_node/#message) property.
|
||||
The email body is the [AlertNode.Details](/kapacitor/v1/reference/nodes/alert_node/#details) property.
|
||||
The emails are sent as HTML emails so the body can contain html markup.
|
||||
|
||||
_**SMTP settings in kapacitor.conf**_
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Exec
|
|||
description: >
|
||||
The "exec" event handler allows you to execute external programs when Kapacitor alert messages are triggered. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Exec
|
||||
weight: 400
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/exec/
|
||||
---
|
||||
|
||||
The exec event handler executes an external program.
|
||||
|
|
@ -15,7 +17,7 @@ Event data is passed over STDIN to the process.
|
|||
|
||||
## Options
|
||||
The following exec event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.exec()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: HipChat
|
|||
description: >
|
||||
The HipChat event handler allows you to send Kapacitor alerts to HipChat. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: HipChat
|
||||
weight: 500
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/hipchat/
|
||||
---
|
||||
|
||||
[HipChat](https://www.hipchat.com/) is Atlassian's web service for group chat,
|
||||
|
|
@ -58,7 +60,7 @@ This only applies if the `global` is also set to `true`.
|
|||
|
||||
## Options
|
||||
The following HipChat event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.hipchat()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -116,7 +118,7 @@ With the HipChat event handler enabled in your `kapacitor.conf`, use the
|
|||
HipChat handler that subscribes to a topic and sends published alerts to HipChat.
|
||||
|
||||
> To avoid posting a message every alert interval, use
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/nodes/alert_node/#statechangesonly)
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/reference/nodes/alert_node/#statechangesonly)
|
||||
> so only events where the alert changed state are sent to Alerta.
|
||||
|
||||
The examples below use the following HipChat configuration defined in the `kapacitor.conf`:
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Kafka
|
|||
description: >
|
||||
The Kafka event handler allows you to send Kapacitor alerts to an Apache Kafka cluster. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Kafka
|
||||
weight: 600
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/kafka/
|
||||
---
|
||||
|
||||
[Apache Kafka](https://kafka.apache.org/) is a distributed streaming platform
|
||||
|
|
@ -129,7 +131,7 @@ Used if the SASL mechanism is `OAUTHBEARER` (experimental).
|
|||
|
||||
## Options
|
||||
The following Kafka event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.kafka()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Log
|
|||
description: >
|
||||
The "log" event handler allows you to send Kapacitor alert messages to a log file. This page includes options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Log
|
||||
weight: 700
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/log/
|
||||
---
|
||||
|
||||
The log event handler writes to a specified log file with one alert event per line.
|
||||
|
|
@ -15,7 +17,7 @@ If the specified log file does not exist, it will be created.
|
|||
|
||||
## Options
|
||||
The following log event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.log()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Microsoft Teams
|
|||
description: >
|
||||
The Microsoft Teams event handler lets you send Kapacitor alerts to a Microsoft Teams channel. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Microsoft Teams
|
||||
weight: 750
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/microsoftteams/
|
||||
---
|
||||
|
||||
[Microsoft Teams](https://www.microsoft.com/en-us/microsoft-365/microsoft-teams/group-chat-software) is a widely used "digital workspace" that facilitates communication among team members. To configure Kapacitor to send alerts to one or more Microsoft Teams channels, do the following:
|
||||
|
|
@ -62,7 +64,7 @@ _Only applies if `global` is `true`._
|
|||
|
||||
### Handler file options
|
||||
|
||||
The following options can be set in a Microsoft Teams event [handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
The following options can be set in a Microsoft Teams event [handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.teams()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -81,7 +83,7 @@ options:
|
|||
channel: '#alerts'
|
||||
```
|
||||
|
||||
For information about using handler files, see [Add and use event handlers](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file).
|
||||
For information about using handler files, see [Add and use event handlers](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file).
|
||||
|
||||
## Example alerts
|
||||
|
||||
|
|
@ -110,7 +112,7 @@ Use the `.teams()` attribute in your TICKscripts to:
|
|||
- Define a Teams handler that subscribes to a topic and sends published alerts to Teams
|
||||
|
||||
> To avoid posting a message every alert interval, use
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/nodes/alert_node/#statechangesonly)
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/reference/nodes/alert_node/#statechangesonly)
|
||||
> so only events where the alert changed state are sent to Teams.
|
||||
|
||||
The following TICKscript uses the `.teams()` event handler to send the message,
|
||||
|
|
@ -4,10 +4,12 @@ list_title: MQTT
|
|||
description: >
|
||||
The MQTT event handler allows you to send Kapacitor alert messages to an MQTT handler. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: MQTT
|
||||
weight: 800
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/mqtt/
|
||||
---
|
||||
|
||||
[MQTT](http://mqtt.org/) is a lightweight messaging protocol for small sensors and mobile devices.
|
||||
|
|
@ -76,7 +78,7 @@ MQTT password.
|
|||
|
||||
## Options
|
||||
The following MQTT event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.mqtt()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -13,7 +13,7 @@ This page is specific to OpsGenie's v1 API which has been deprecated.
|
|||
OpsGenie recommends migrating to their v2 API. View the
|
||||
[OpsGenie API migration guide](https://docs.opsgenie.com/docs/migration-guide-for-alert-rest-api)
|
||||
for more information about upgrading.
|
||||
If using the v2 API, view the [OpsGenie v2 event handler](/kapacitor/v1/event_handlers/opsgenie/v2) documentation.
|
||||
If using the v2 API, view the [OpsGenie v2 event handler](/kapacitor/v1/reference/event_handlers/opsgenie/v2) documentation.
|
||||
{{% /warn %}}
|
||||
|
||||
## Configuration
|
||||
|
|
@ -58,7 +58,7 @@ The team and recipients can still be overridden.
|
|||
|
||||
## Options
|
||||
The following OpsGenie v1 event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.opsGenie()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,10 @@ list_title: OpsGenie v2
|
|||
description: >
|
||||
The OpsGenie v2 event handler allows you to send Kapacitor alerts to OpsGenie. This page includes configuration options and usage examples.
|
||||
aliases:
|
||||
- kapacitor/v1.6/event_handlers/opsgenie
|
||||
|
||||
- /kapacitor/v1/event_handlers/opsgenie/
|
||||
- /kapacitor/v1/event_handlers/opsgenie/v2/
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: OpsGenie
|
||||
weight: 900
|
||||
parent: Event handlers
|
||||
|
|
@ -18,7 +18,7 @@ platform for DevOps & ITOps teams.
|
|||
Kapacitor can be configured to send alert messages to OpsGenie.
|
||||
|
||||
> This page is specific to OpsGenie's v2 API. If still using their v1 API, view
|
||||
> the [OpsGenie v1 event handler](/kapacitor/v1/event_handlers/opsgenie/v1/) documentation.
|
||||
> the [OpsGenie v1 event handler](/kapacitor/v1/reference/event_handlers/opsgenie/v1/) documentation.
|
||||
|
||||
## Configuration
|
||||
Configuration as well as default [option](#options) values for the OpsGenie v2
|
||||
|
|
@ -69,7 +69,7 @@ The team and recipients can still be overridden.
|
|||
|
||||
## Options
|
||||
The following OpsGenie v2 event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.opsGenie2()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -14,7 +14,7 @@ This page is specific to PagerDuty's v1 API which has been deprecated.
|
|||
PagerDuty recommends migrating to their v2 API. View the
|
||||
[PagerDuty API migration guide](https://v2.developer.pagerduty.com/docs/migrating-to-api-v2)
|
||||
for more information about upgrading. If using the v2 API, view the
|
||||
[PagerDuty v2 event handler](/kapacitor/v1/event_handlers/pagerduty/v2) documentation.
|
||||
[PagerDuty v2 event handler](/kapacitor/v1/reference/event_handlers/pagerduty/v2) documentation.
|
||||
{{% /warn %}}
|
||||
|
||||
## Configuration
|
||||
|
|
@ -46,7 +46,7 @@ PagerDuty in TICKscripts.
|
|||
|
||||
## Options
|
||||
The following PagerDuty v1 event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.pagerDuty()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -5,9 +5,9 @@ description: >
|
|||
The PagerDuty v2 event handler allows you to send Kapacitor alerts to PagerDuty. This page includes configuration options and usage examples.
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/pagerduty/
|
||||
|
||||
- /kapacitor/v1/event_handlers/pagerduty/v2/
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: PagerDuty
|
||||
weight: 1000
|
||||
parent: Event handlers
|
||||
|
|
@ -18,7 +18,7 @@ helps teams detect and fix infrastructure problems quickly.
|
|||
Kapacitor can be configured to send alert messages to PagerDuty.
|
||||
|
||||
> This page is specific to PagerDuty's v2 API. If still using their v1 API, view
|
||||
> the [PagerDuty v1 event handler](/kapacitor/v1/event_handlers/pagerduty/v1/) documentation.
|
||||
> the [PagerDuty v1 event handler](/kapacitor/v1/reference/event_handlers/pagerduty/v1/) documentation.
|
||||
|
||||
## Configuration
|
||||
Configuration as well as default [option](#options) values for the PagerDuty v2
|
||||
|
|
@ -49,7 +49,7 @@ PagerDuty in TICKscripts.
|
|||
|
||||
## Options
|
||||
The following PagerDuty v2 event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.pagerDuty2()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Post (HTTP)
|
|||
description: >
|
||||
The "post" event handler allows you to POST Kapacitor alert data to an HTTP endpoint. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Post
|
||||
weight: 1100
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/post/
|
||||
---
|
||||
|
||||
The post event handler posts JSON encoded data to an HTTP endpoint.
|
||||
|
|
@ -53,7 +55,7 @@ Set of authentication credentials to set on the POST request.
|
|||
#### `alert-template`
|
||||
|
||||
Alert template for constructing a custom HTTP body.
|
||||
Alert templates are only used with post [alert](/kapacitor/v1/nodes/alert_node/)
|
||||
Alert templates are only used with post [alert](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
handlers as they consume alert data.
|
||||
_Skip to [alert templating](#alert-templates)._
|
||||
|
||||
|
|
@ -65,7 +67,7 @@ _Skip to [alert templating](#alert-templates)._
|
|||
#### `row-template`
|
||||
|
||||
Row template for constructing a custom HTTP body.
|
||||
Row templates are only used with the [httpPost node](/kapacitor/v1/nodes/http_post_node/)
|
||||
Row templates are only used with the [httpPost node](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
pipeline nodes as they consume a row at a time.
|
||||
_Skip to [row templating](#row-templates)._
|
||||
|
||||
|
|
@ -125,7 +127,7 @@ KAPACITOR_HTTPPOST_1_HEADERS_Example2 = "header2"
|
|||
## Options
|
||||
|
||||
The following post event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.post()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -298,7 +300,7 @@ POSTs with alert and row templates.
|
|||
### Alert templates
|
||||
|
||||
Alert templates are used to construct a custom HTTP body.
|
||||
They are only used with post [alert](/kapacitor/v1/nodes/alert_node/) handlers
|
||||
They are only used with post [alert](/kapacitor/v1/reference/nodes/alert_node/) handlers
|
||||
as they consume alert data.
|
||||
Templates are defined either inline in the `kapacitor.conf` using the
|
||||
[`alert-template`](#alert-template) configuration or in a separate file and referenced
|
||||
|
|
@ -347,7 +349,7 @@ _**/etc/templates/alert.html**_
|
|||
### Row templates
|
||||
|
||||
Row templates are used to construct a custom HTTP body.
|
||||
They are only used with [httpPost](/kapacitor/v1/nodes/http_post_node/)
|
||||
They are only used with [httpPost](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
handlers as they consume a row at a time.
|
||||
Templates are defined either inline in the `kapacitor.conf` using the
|
||||
[`row-template`](#row-template) configuration or in a separate file and referenced
|
||||
|
|
@ -4,17 +4,19 @@ list_title: Publish
|
|||
description: >
|
||||
The "publish" event handler allows you to publish Kapacitor alerts messages to mulitple Kapacitor topics. This page includes options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Publish
|
||||
weight: 1200
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/publish/
|
||||
---
|
||||
|
||||
The publish event handler publishes events to another topic.
|
||||
|
||||
## Options
|
||||
The following publish event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file).
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file).
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Pushover
|
|||
description: >
|
||||
The Pushover event handler allows you to send Kapacitor alerts to Pushover. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Pushover
|
||||
weight: 1300
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/pushover/
|
||||
---
|
||||
|
||||
[Pushover](https://pushover.net/) is a service that sends instant push
|
||||
|
|
@ -41,7 +43,7 @@ The URL for the Pushover API. _**This should not need to be changed.**_
|
|||
|
||||
## Options
|
||||
The following Pushover event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.pushover()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Sensu
|
|||
description: >
|
||||
The Sensu event handler allows you to send Kapacitor alerts to Sensu. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Sensu
|
||||
weight: 1400
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/sensu/
|
||||
---
|
||||
|
||||
[Sensu](https://sensu.io/) is a service that provides infrastructure, service,
|
||||
|
|
@ -42,7 +44,7 @@ List of [Sensu handlers](https://docs.sensu.io/sensu-core/1.3/guides/intro-to-ha
|
|||
|
||||
## Options
|
||||
The following Sensu event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.sensu()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: ServiceNow
|
|||
description: >
|
||||
The ServiceNow event handler lets you to send Kapacitor alerts to ServiceNow. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: ServiceNow
|
||||
weight: 1500
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/servicenow/
|
||||
---
|
||||
|
||||
[ServiceNow](https://www.servicenow.com/) provides service management software with a comprehensive managed workflow that supports
|
||||
|
|
@ -57,7 +59,7 @@ Password to use for basic HTTP authentication.
|
|||
## Options
|
||||
|
||||
The following ServiceNow event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.serviceNow()` in a TICKscript. These options set corresponding fields in the ServiceNow alert or event. For information about ServiceNow alerts, see [Manually create an alert](https://docs.servicenow.com/bundle/paris-it-operations-management/page/product/event-management/task/t_EMManuallyCreateAlert.html).
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Slack
|
|||
description: >
|
||||
The Slack event handler allows you to send Kapacitor alerts to Slack. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Slack
|
||||
weight: 1600
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/slack/
|
||||
---
|
||||
|
||||
[Slack](https://slack.com) is a widely used "digital workspace" that facilitates
|
||||
|
|
@ -94,7 +96,7 @@ _This is necessary if using a self-signed certificate._
|
|||
|
||||
## Options
|
||||
The following Slack event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.slack()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -158,7 +160,7 @@ published alerts to Slack.
|
|||
|
||||
{{% note %}}
|
||||
To avoid posting a message every alert interval, use
|
||||
[AlertNode.StateChangesOnly](/kapacitor/v1/nodes/alert_node/#statechangesonly)
|
||||
[AlertNode.StateChangesOnly](/kapacitor/v1/reference/nodes/alert_node/#statechangesonly)
|
||||
so only events where the alert changed state are sent to Slack.
|
||||
{{% /note %}}
|
||||
|
||||
|
|
@ -300,7 +302,7 @@ stream
|
|||
.topic('500-errors')
|
||||
```
|
||||
|
||||
Below is an [aggregate](/kapacitor/v1/event_handlers/aggregate/) handler that
|
||||
Below is an [aggregate](/kapacitor/v1/reference/event_handlers/aggregate/) handler that
|
||||
subscribes to the `500-errors` topic, aggregates the number of 500 errors over a
|
||||
24 hour period, then publishes an aggregate message to the `500-errors-24h` topic.
|
||||
|
||||
|
|
@ -4,10 +4,12 @@ list_title: SNMP trap
|
|||
description: >
|
||||
The "snmptrap" event handler allows you to send Kapacitor alerts SNMP traps. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: SNMP Trap
|
||||
weight: 1700
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/snmptrap/
|
||||
---
|
||||
|
||||
The SNMP trap event handler sends alert messages as SNMP traps.
|
||||
|
|
@ -40,7 +42,7 @@ Number of retries when sending traps.
|
|||
|
||||
## Options
|
||||
The following SNMP trap event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.snmpTrap()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,16 +4,18 @@ list_title: TCP
|
|||
description: >
|
||||
The "tcp" event handler allows you to send Kapacitor alert data to a TCP endpoint. This page includes options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: TCP
|
||||
weight: 1900
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/tcp/
|
||||
---
|
||||
|
||||
The TCP event handler sends JSON encoded alert data to a TCP endpoint.
|
||||
|
||||
## Options
|
||||
The following TCP event handler options can be set in a [handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using `.tcp()` in a TICKscript.
|
||||
The following TCP event handler options can be set in a [handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using `.tcp()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
|
|
@ -4,10 +4,12 @@ list_title: Telegram
|
|||
description: >
|
||||
The Telegram event handler allows you to send Kapacitor alerts to Telegram. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Telegram
|
||||
weight: 2000
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/telegram/
|
||||
---
|
||||
|
||||
[Telegram](https://telegram.org/) is a messaging app built with a focus on
|
||||
|
|
@ -70,7 +72,7 @@ This only applies if the `global` is also set to `true`.
|
|||
|
||||
## Options
|
||||
The following Telegram event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.telegram()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -239,7 +241,7 @@ Telegram bot or define a Telegram handler that subscribes to a topic and sends
|
|||
published alerts to your Telegram bot.
|
||||
|
||||
> To avoid posting a message every alert interval, use
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/nodes/alert_node/#statechangesonly)
|
||||
> [AlertNode.StateChangesOnly](/kapacitor/v1/reference/nodes/alert_node/#statechangesonly)
|
||||
> so only events where the alert changed state are sent to Telegram.
|
||||
|
||||
The examples below use the following Telegram configuration defined in the `kapacitor.conf`:
|
||||
|
|
@ -4,10 +4,12 @@ list_title: VictorOps
|
|||
description: >
|
||||
The VictorOps event handler allows you to send Kapacitor alerts to VictorOps. This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: VictorOps
|
||||
weight: 2100
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/victorops/
|
||||
---
|
||||
|
||||
[VictorOps](https://victorops.com/) is an incident management platform that
|
||||
|
|
@ -56,7 +58,7 @@ _The routing key can still be overridden._
|
|||
|
||||
## Options
|
||||
The following VictorOpas event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.victorOps()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -4,10 +4,12 @@ description: >
|
|||
The Zenoss event handler sends Kapacitor alerts to Zenoss.
|
||||
This page includes configuration options and usage examples.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: Zenoss
|
||||
weight: 2200
|
||||
parent: Event handlers
|
||||
aliases:
|
||||
- /kapacitor/v1/event_handlers/zenoss/
|
||||
---
|
||||
|
||||
[Zenoss](https://www.zenoss.com/) is a hybrid IT monitoring service for
|
||||
|
|
@ -88,7 +90,7 @@ _Only applies if `global` is `true`._
|
|||
|
||||
## Options
|
||||
The following Zenoss event handler options can be set in a
|
||||
[handler file](/kapacitor/v1/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
[handler file](/kapacitor/v1/reference/event_handlers/#create-a-topic-handler-with-a-handler-file) or when using
|
||||
`.zenoss()` in a TICKscript.
|
||||
|
||||
| Name | Type | Description |
|
||||
|
|
@ -151,7 +153,7 @@ options:
|
|||
|
||||
{{% note %}}
|
||||
To avoid posting a message every alert interval, use
|
||||
[AlertNode.StateChangesOnly](/kapacitor/v1/nodes/alert_node/#statechangesonly)
|
||||
[AlertNode.StateChangesOnly](/kapacitor/v1/reference/nodes/alert_node/#statechangesonly)
|
||||
so only events where the alert changed state are sent to Zenoss.
|
||||
{{% /note %}}
|
||||
|
||||
|
|
@ -2,19 +2,21 @@
|
|||
title: TICKscript nodes overview
|
||||
description: Overview of nodes in TICKscript.
|
||||
aliases:
|
||||
- kapacitor/v1.6/nodes/source_batch_node/
|
||||
- kapacitor/v1.6/nodes/source_stream_node/
|
||||
- kapacitor/v1.6/nodes/map_node/
|
||||
- kapacitor/v1.6/nodes/reduce_node/
|
||||
- /kapacitor/v1/nodes/source_batch_node/
|
||||
- /kapacitor/v1/nodes/map_node/
|
||||
- /kapacitor/v1/nodes/source_stream_node/
|
||||
- /kapacitor/v1/nodes/
|
||||
- /kapacitor/v1/nodes/reduce_node/
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: TICKscript nodes
|
||||
identifier: nodes
|
||||
weight: 40
|
||||
parent: Reference
|
||||
weight: 40
|
||||
---
|
||||
|
||||
> ***Note:*** Before continuing, please make sure you have read the
|
||||
> [TICKscript Language Specification](/kapacitor/v1/tick/).
|
||||
> [TICKscript Language Specification](/kapacitor/v1/reference/tick/).
|
||||
|
||||
Nodes represent process invocation units that either take data as a batch or a point-by-point stream, and then alter the data, store the data, or trigger some other activity based on changes in the data (e.g., an alert).
|
||||
|
||||
|
|
@ -3,27 +3,28 @@ title: AlertNode
|
|||
description: >
|
||||
A Kapacitor AlertNode triggers an event of varying severity levels and passes the event to alert handlers. The criteria for triggering an alert is specified using a lambda expression.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: AlertNode
|
||||
identifier: alert_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/alert_node/
|
||||
---
|
||||
|
||||
The `alert` node triggers an event of varying severity levels and passes the
|
||||
event to [event handlers](/kapacitor/v1/event_handlers/). The criteria for
|
||||
triggering an alert is specified via a [lambda expression](/kapacitor/v1/tick/expr/).
|
||||
See [AlertNode.Info](/kapacitor/v1/nodes/alert_node/#info),
|
||||
[AlertNode.Warn](/kapacitor/v1/nodes/alert_node/#warn),
|
||||
and [AlertNode.Crit](/kapacitor/v1/nodes/alert_node/#crit) below.
|
||||
event to [event handlers](/kapacitor/v1/reference/event_handlers/). The criteria for
|
||||
triggering an alert is specified via a [lambda expression](/kapacitor/v1/reference/tick/expr/).
|
||||
See [AlertNode.Info](/kapacitor/v1/reference/nodes/alert_node/#info),
|
||||
[AlertNode.Warn](/kapacitor/v1/reference/nodes/alert_node/#warn),
|
||||
and [AlertNode.Crit](/kapacitor/v1/reference/nodes/alert_node/#crit) below.
|
||||
|
||||
### Constructor
|
||||
|
||||
| Chaining method | Description |
|
||||
|:---------|:---------|
|
||||
| **alert ( )** | Create an alert node, which can trigger alerts. <br> <br>To dynamically construct a custom HTTP body or URL, use an [**alert template**](/kapacitor/v1/event_handlers/post/#alert-templates). For example, `httpPost('localhost/?host={{ index .Tags "host"}}&cpu={{ index .Tags "cpu" }}')`. <br> <br> |
|
||||
| **alert ( )** | Create an alert node, which can trigger alerts. <br> <br>To dynamically construct a custom HTTP body or URL, use an [**alert template**](/kapacitor/v1/reference/event_handlers/post/#alert-templates). For example, `httpPost('localhost/?host={{ index .Tags "host"}}&cpu={{ index .Tags "cpu" }}')`. <br> <br> |
|
||||
|
||||
### Property methods
|
||||
|
||||
|
|
@ -131,7 +132,7 @@ and [AlertNode.Crit](/kapacitor/v1/nodes/alert_node/#crit) below.
|
|||
|
||||
#### Available event handlers
|
||||
|
||||
Different event handlers can be configured for each [AlertNode.](/kapacitor/v1/nodes/alert_node/)
|
||||
Different event handlers can be configured for each [AlertNode.](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
Some handlers like Email, HipChat, Sensu, Slack, OpsGenie, VictorOps, PagerDuty, Telegram and Talk have a configuration
|
||||
option, `global`, that indicates that all alerts implicitly use the handler.
|
||||
|
||||
|
|
@ -177,7 +178,7 @@ Each event that gets sent to a handler contains the following alert data:
|
|||
|
||||
Events are sent to handlers if the alert is in a state other than 'OK'
|
||||
or the alert just changed to the 'OK' state from a non 'OK' state (a.k.a. the alert recovered).
|
||||
Using the [AlertNode.StateChangesOnly](/kapacitor/v1/nodes/alert_node/#statechangesonly)
|
||||
Using the [AlertNode.StateChangesOnly](/kapacitor/v1/reference/nodes/alert_node/#statechangesonly)
|
||||
property events will only be sent to handlers if the alert changed state.
|
||||
|
||||
It is valid to configure multiple alert handlers, even with the same type.
|
||||
|
|
@ -255,7 +256,7 @@ Property methods are marked using the `.` operator.
|
|||
|
||||
Send the alert to Alerta.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Alerta Event Handler](/kapacitor/v1/event_handlers/alerta/) article.
|
||||
[Alerta Event Handler](/kapacitor/v1/reference/event_handlers/alerta/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -289,7 +290,7 @@ alert.all()
|
|||
|
||||
Send the alert to BigPanda.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[BigPanda Event Handler](/kapacitor/v1/event_handlers/bigpanda/) article.
|
||||
[BigPanda Event Handler](/kapacitor/v1/reference/event_handlers/bigpanda/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -340,7 +341,7 @@ alert.critReset(value ast.LambdaNode)
|
|||
### Details
|
||||
|
||||
Template for constructing a detailed HTML message for the alert.
|
||||
The same template data is available as the [AlertNode.Message](/kapacitor/v1/nodes/alert_node/#message) property,
|
||||
The same template data is available as the [AlertNode.Message](/kapacitor/v1/reference/nodes/alert_node/#message) property,
|
||||
in addition to a Message field that contains the rendered Message value.
|
||||
|
||||
The intent is that the Message property be a single line summary while the
|
||||
|
|
@ -376,7 +377,7 @@ alert.details(value string)
|
|||
|
||||
Send the alert to Discord.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Discord Event Handler](/kapacitor/v1/event_handlers/discord/) article.
|
||||
[Discord Event Handler](/kapacitor/v1/reference/event_handlers/discord/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -406,7 +407,7 @@ alert.durationField(value string)
|
|||
|
||||
Email the alert data to specified "To" email addresses.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Email Event Handler](/kapacitor/v1/event_handlers/email/) article.
|
||||
[Email Event Handler](/kapacitor/v1/reference/event_handlers/email/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -441,7 +442,7 @@ Value: {{ index .Fields "value" }}
|
|||
|
||||
Execute a command whenever an alert is triggered and pass the alert data over STDIN in JSON format.
|
||||
Detailed usage instructions and examples are provided in the
|
||||
[Exec Event Handler](/kapacitor/v1/event_handlers/exec/) article.
|
||||
[Exec Event Handler](/kapacitor/v1/reference/event_handlers/exec/) article.
|
||||
|
||||
```js
|
||||
// Pattern
|
||||
|
|
@ -479,7 +480,7 @@ alert.flapping(0.25, 0.5)
|
|||
|
||||
Send the alert to an Apache Kafka cluster.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Kafka Event Handler](/kapacitor/v1/event_handlers/kafka/) article.
|
||||
[Kafka Event Handler](/kapacitor/v1/reference/event_handlers/kafka/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
|
||||
|
|
@ -519,7 +520,7 @@ alert.history(21)
|
|||
|
||||
Send the alert to HipChat.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[HipChat Event Handler](/kapacitor/v1/event_handlers/hipchat/) article.
|
||||
[HipChat Event Handler](/kapacitor/v1/reference/event_handlers/hipchat/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
|
||||
|
|
@ -689,7 +690,7 @@ alert.inhibit(category string, equalTags ...string)
|
|||
|
||||
Send the alert to a Kafka topic.
|
||||
Detailed setup and usage instructions are provided in the
|
||||
[Kafka Event Handler](/kapacitor/v1/event_handlers/kafka/) article.
|
||||
[Kafka Event Handler](/kapacitor/v1/reference/event_handlers/kafka/) article.
|
||||
|
||||
_**Example: kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -736,7 +737,7 @@ alert.levelTag('level')
|
|||
|
||||
Log JSON alert data to file.
|
||||
Detailed setup and usage instructions are provided in the
|
||||
[Log Event Handler](/kapacitor/v1/event_handlers/log/) article.
|
||||
[Log Event Handler](/kapacitor/v1/reference/event_handlers/log/) article.
|
||||
|
||||
_**Example TICKscript**_
|
||||
```js
|
||||
|
|
@ -797,7 +798,7 @@ alert.messageField('message')
|
|||
|
||||
Send alert to an MQTT broker.
|
||||
Detailed configuration options and usage instructions are provided in the
|
||||
[MQTT Event Handler](/kapacitor/v1/event_handlers/mqtt/) article.
|
||||
[MQTT Event Handler](/kapacitor/v1/reference/event_handlers/mqtt/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -831,7 +832,7 @@ alert.noRecoveries()
|
|||
|
||||
Send alert to OpsGenie using OpsGenie's v1 API.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[OpsGenie v1 Event Handler](/kapacitor/v1/event_handlers/opsgenie/v1/) article.
|
||||
[OpsGenie v1 Event Handler](/kapacitor/v1/reference/event_handlers/opsgenie/v1/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -853,7 +854,7 @@ stream
|
|||
|
||||
Send alert to OpsGenie using OpsGenie's v2 API.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[OpsGenie v2 Event Handler](/kapacitor/v1/event_handlers/opsgenie/v2/) article.
|
||||
[OpsGenie v2 Event Handler](/kapacitor/v1/reference/event_handlers/opsgenie/v2/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -875,7 +876,7 @@ stream
|
|||
|
||||
Send the alert to PagerDuty using PagerDuty's v1 API.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[PagerDuty v1 Event Handler](/kapacitor/v1/event_handlers/pagerduty/v1/) article.
|
||||
[PagerDuty v1 Event Handler](/kapacitor/v1/reference/event_handlers/pagerduty/v1/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -896,7 +897,7 @@ stream
|
|||
|
||||
Send the alert to PagerDuty using PagerDuty's v2 API.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[PagerDuty v2 Event Handler](/kapacitor/v1/event_handlers/pagerduty/v2/) article.
|
||||
[PagerDuty v2 Event Handler](/kapacitor/v1/reference/event_handlers/pagerduty/v2/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -917,7 +918,7 @@ stream
|
|||
|
||||
HTTP POST JSON alert data to a specified URL.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Post Event Handler](/kapacitor/v1/event_handlers/post/) article.
|
||||
[Post Event Handler](/kapacitor/v1/reference/event_handlers/post/) article.
|
||||
|
||||
_**Example TICKscript**_
|
||||
|
||||
|
|
@ -932,7 +933,7 @@ stream
|
|||
|
||||
Send the alert to Pushover.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Pushover Event Handler](/kapacitor/v1/event_handlers/pushover/) article.
|
||||
[Pushover Event Handler](/kapacitor/v1/reference/event_handlers/pushover/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -967,7 +968,7 @@ alert.quiet()
|
|||
|
||||
Send the alert to Sensu.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Sensu Event Handler](/kapacitor/v1/event_handlers/sensu/) article.
|
||||
[Sensu Event Handler](/kapacitor/v1/reference/event_handlers/sensu/) article.
|
||||
|
||||
_**Example kapacitor.conf*_
|
||||
```toml
|
||||
|
|
@ -990,7 +991,7 @@ stream
|
|||
|
||||
Send the alert to Slack.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Slack Event Handler](/kapacitor/v1/event_handlers/slack/) article.
|
||||
[Slack Event Handler](/kapacitor/v1/reference/event_handlers/slack/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -1013,7 +1014,7 @@ stream
|
|||
|
||||
Send the alert using SNMP traps.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[SNMP Trap Event Handler](/kapacitor/v1/event_handlers/snmptrap/) article.
|
||||
[SNMP Trap Event Handler](/kapacitor/v1/reference/event_handlers/snmptrap/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -1073,32 +1074,11 @@ stream
|
|||
.slack()
|
||||
```
|
||||
|
||||
### Talk
|
||||
|
||||
Send the alert to Talk.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Talk Event Handler](/kapacitor/v1/event_handlers/talk/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
[talk]
|
||||
enabled = true
|
||||
url = "https://jianliao.com/v2/services/webhook/uuid"
|
||||
author_name = "Kapacitor"
|
||||
```
|
||||
|
||||
_**Example TICKscript**_
|
||||
```js
|
||||
stream
|
||||
alert()
|
||||
.talk()
|
||||
```
|
||||
|
||||
### TCP
|
||||
|
||||
Send JSON alert data to a specified address over TCP.
|
||||
Detailed usage instructions are provided in the
|
||||
[TCPEvent Handler](/kapacitor/v1/event_handlers/tcp/) article.
|
||||
[TCPEvent Handler](/kapacitor/v1/reference/event_handlers/tcp/) article.
|
||||
|
||||
```js
|
||||
// Pattern
|
||||
|
|
@ -1112,7 +1092,7 @@ alert.tcp('127.0.0.1:7777')
|
|||
|
||||
Send the alert to Telegram.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[Telegram Event Handler](/kapacitor/v1/event_handlers/telegram/) article.
|
||||
[Telegram Event Handler](/kapacitor/v1/reference/event_handlers/telegram/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -1150,7 +1130,7 @@ alert.topic('cpu')
|
|||
|
||||
Send alert to VictorOps.
|
||||
Detailed configuration options and setup instructions are provided in the
|
||||
[VictorOps Event Handler](/kapacitor/v1/event_handlers/victorops/) article.
|
||||
[VictorOps Event Handler](/kapacitor/v1/reference/event_handlers/victorops/) article.
|
||||
|
||||
_**Example kapacitor.conf**_
|
||||
```toml
|
||||
|
|
@ -1207,7 +1187,7 @@ Create an alert node, which can trigger alerts.
|
|||
alert|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -1219,7 +1199,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
alert|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -1229,7 +1209,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
alert|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -1240,7 +1220,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
alert|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -1250,7 +1230,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
alert|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -1260,7 +1240,7 @@ Count the number of points.
|
|||
alert|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -1271,7 +1251,7 @@ A point is emitted for every point collected.
|
|||
alert|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -1315,7 +1295,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
```js
|
||||
|
|
@ -1349,7 +1329,7 @@ Example:
|
|||
alert|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -1359,7 +1339,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
alert|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -1369,7 +1349,7 @@ Create a node that can delete tags or fields.
|
|||
alert|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -1379,7 +1359,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
alert|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -1389,7 +1369,7 @@ Compute the difference between points independent of elapsed time.
|
|||
alert|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -1399,7 +1379,7 @@ Produce batch of only the distinct points.
|
|||
alert|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -1409,7 +1389,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
alert|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -1419,7 +1399,7 @@ Compute the elapsed time between points.
|
|||
alert|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -1431,7 +1411,7 @@ The results are available to later expressions.
|
|||
alert|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -1441,7 +1421,7 @@ Select the first point.
|
|||
alert|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -1451,7 +1431,7 @@ Flatten points with similar times into a single point.
|
|||
alert|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -1469,7 +1449,7 @@ Example:
|
|||
alert|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -1479,7 +1459,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
alert|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -1490,7 +1470,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
alert|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -1504,7 +1484,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
alert|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -1516,7 +1496,7 @@ endpoint property method.
|
|||
alert|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -1526,7 +1506,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
alert|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -1536,7 +1516,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
alert|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -1546,7 +1526,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
alert|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -1556,7 +1536,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
alert|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -1566,7 +1546,7 @@ Select the last point.
|
|||
alert|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -1576,7 +1556,7 @@ Select the maximum point.
|
|||
alert|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -1586,7 +1566,7 @@ Compute the mean of the data.
|
|||
alert|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -1599,7 +1579,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
alert|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -1609,7 +1589,7 @@ Select the minimum point.
|
|||
alert|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -1619,7 +1599,7 @@ Compute the mode of the data.
|
|||
alert|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -1630,7 +1610,7 @@ No points are emitted until the window is full.
|
|||
alert|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -1640,7 +1620,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
alert|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -1652,7 +1632,7 @@ One point will be emitted every count or duration specified.
|
|||
alert|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -1662,7 +1642,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
alert|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -1672,7 +1652,7 @@ Create a node that can load data from external sources.
|
|||
alert|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -1682,7 +1662,7 @@ Compute the difference between `min` and `max` points.
|
|||
alert|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -1692,7 +1672,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
alert|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -1702,7 +1682,7 @@ Create a node that tracks duration in a given state.
|
|||
alert|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -1714,7 +1694,7 @@ This means the interval time is independent of the times of the data points the
|
|||
alert|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -1724,7 +1704,7 @@ Compute the standard deviation.
|
|||
alert|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -1734,7 +1714,7 @@ Compute the sum of all values.
|
|||
alert|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -1744,7 +1724,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
alert|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -1754,7 +1734,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
alert|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -1764,7 +1744,7 @@ Create a new node that converts batch data to stream data.
|
|||
alert|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -1774,7 +1754,7 @@ Perform the union of this node and all other given nodes.
|
|||
alert|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -1784,7 +1764,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
alert|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -1796,4 +1776,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
alert|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: BarrierNode
|
|||
description: >
|
||||
BarrierNode emits a barrier with the current time, according to the system clock, and allows pipelines to be forced in the absence of data traffic. The barrier emitted will be based on either idle time since the last received message or on a periodic timer based on the system clock.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: BarrierNode
|
||||
identifier: barrier_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/barrier_node/
|
||||
---
|
||||
|
||||
The `barrier` node emits a barrier based on one of the following:
|
||||
|
|
@ -129,7 +130,7 @@ barrier.idle(value time.Duration)
|
|||
|
||||
{{% warn %}}
|
||||
#### Barrier idle time and window period
|
||||
`idle` must be greater than `period` of the associated [window](/kapacitor/v1/nodes/window_node/).
|
||||
`idle` must be greater than `period` of the associated [window](/kapacitor/v1/reference/nodes/window_node/).
|
||||
If `idle` times are less than the window `period`, data may be lost.
|
||||
{{% /warn %}}
|
||||
|
||||
|
|
@ -191,7 +192,7 @@ Create an alert node, which can trigger alerts.
|
|||
barrier|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -204,7 +205,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
barrier|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -215,7 +216,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
barrier|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -225,7 +226,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
barrier|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -236,7 +237,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
barrier|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -247,7 +248,7 @@ Count the number of points.
|
|||
barrier|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -259,7 +260,7 @@ A point is emitted for every point collected.
|
|||
barrier|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -305,7 +306,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -342,7 +343,7 @@ Example:
|
|||
barrier|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -353,7 +354,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
barrier|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -364,7 +365,7 @@ Create a node that can delete tags or fields.
|
|||
barrier|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -375,7 +376,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
barrier|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -386,7 +387,7 @@ Compute the difference between points independent of elapsed time.
|
|||
barrier|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -397,7 +398,7 @@ Produce batch of only the distinct points.
|
|||
barrier|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -408,7 +409,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
barrier|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -419,7 +420,7 @@ Compute the elapsed time between points.
|
|||
barrier|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -432,7 +433,7 @@ The results are available to later expressions.
|
|||
barrier|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -443,7 +444,7 @@ Select the first point.
|
|||
barrier|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -454,7 +455,7 @@ Flatten points with similar times into a single point.
|
|||
barrier|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -474,7 +475,7 @@ Example:
|
|||
barrier|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -485,7 +486,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
barrier|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -497,7 +498,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
barrier|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -512,7 +513,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
barrier|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -525,7 +526,7 @@ endpoint property method.
|
|||
barrier|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -536,7 +537,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
barrier|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -547,7 +548,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
barrier|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -558,7 +559,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
barrier|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -569,7 +570,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
barrier|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -580,7 +581,7 @@ Select the last point.
|
|||
barrier|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -591,7 +592,7 @@ Create a node that logs all data it receives.
|
|||
barrier|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -602,7 +603,7 @@ Select the maximum point.
|
|||
barrier|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -613,7 +614,7 @@ Compute the mean of the data.
|
|||
barrier|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -627,7 +628,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
barrier|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -638,7 +639,7 @@ Select the minimum point.
|
|||
barrier|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -649,7 +650,7 @@ Compute the mode of the data.
|
|||
barrier|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -661,7 +662,7 @@ No points are emitted until the window is full.
|
|||
barrier|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -672,7 +673,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
barrier|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -685,7 +686,7 @@ One point will be emitted every count or duration specified.
|
|||
barrier|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -696,7 +697,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
barrier|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -707,7 +708,7 @@ Create a node that can load data from external sources.
|
|||
barrier|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -718,7 +719,7 @@ Compute the difference between `min` and `max` points.
|
|||
barrier|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -729,7 +730,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
barrier|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -740,7 +741,7 @@ Create a node that tracks duration in a given state.
|
|||
barrier|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -753,7 +754,7 @@ This means the interval time is independent of the times of the data points the
|
|||
barrier|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -764,7 +765,7 @@ Compute the standard deviation.
|
|||
barrier|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -775,7 +776,7 @@ Compute the sum of all values.
|
|||
barrier|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -786,7 +787,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
barrier|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -797,7 +798,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
barrier|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -807,7 +808,7 @@ Create a new node that converts batch data to stream data.
|
|||
barrier|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -818,7 +819,7 @@ Perform the union of this node and all other given nodes.
|
|||
barrier|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -829,7 +830,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
barrier|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -842,4 +843,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
barrier|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -5,19 +5,21 @@ description: >
|
|||
Each call to `query` or `queryFlux` creates a child batch node that can further be configured.
|
||||
The `batch` variable in batch tasks is an instance of BatchNode.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: BatchNode
|
||||
identifier: batch_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/batch_node/
|
||||
---
|
||||
|
||||
The `batch` node handles the creation of several child QueryNode or QueryFluxNodes.
|
||||
Each call to [`query`](/kapacitor/v1/nodes/query_node) or [`queryFlux`](/kapacitor/v1/nodes/query_flux_node)
|
||||
Each call to [`query`](/kapacitor/v1/reference/nodes/query_node) or [`queryFlux`](/kapacitor/v1/reference/nodes/query_flux_node)
|
||||
creates a child batch node that can further be configured.
|
||||
_See [QueryNode](/kapacitor/v1/nodes/query_node/) and [QueryFluxNode](/kapacitor/v1/nodes/query_flux_node/)._
|
||||
_See [QueryNode](/kapacitor/v1/reference/nodes/query_node/) and [QueryFluxNode](/kapacitor/v1/reference/nodes/query_flux_node/)._
|
||||
The `batch` variable in batch tasks is an instance of
|
||||
a [BatchNode.](/kapacitor/v1/nodes/batch_node/)
|
||||
a [BatchNode.](/kapacitor/v1/reference/nodes/batch_node/)
|
||||
|
||||
> A **QueryNode** or **QueryFluxNode** is required when using **BatchNode**.
|
||||
> They defines the source and schedule for batch data and should be used before
|
||||
|
|
@ -154,7 +156,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -191,7 +193,7 @@ Example:
|
|||
batch|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Query
|
||||
|
||||
|
|
@ -206,7 +208,7 @@ passed to the `groupBy` method.
|
|||
batch|query(q string)
|
||||
```
|
||||
|
||||
Returns: [QueryNode](/kapacitor/v1/nodes/query_node/)
|
||||
Returns: [QueryNode](/kapacitor/v1/reference/nodes/query_node/)
|
||||
|
||||
### QueryFlux
|
||||
|
||||
|
|
@ -216,7 +218,7 @@ The Flux query to execute.
|
|||
batch|QueryFlux(queryStr string)
|
||||
```
|
||||
|
||||
Returns: [QueryFluxNode](/kapacitor/v1/nodes/query_flux_node/)
|
||||
Returns: [QueryFluxNode](/kapacitor/v1/reference/nodes/query_flux_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -229,4 +231,4 @@ This means the interval time is independent of the times of the data points the
|
|||
batch|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: ChangeDetectNode (Kapacitor TICKscript node)
|
|||
list_title: ChangeDetectNode
|
||||
description: >
|
||||
ChangeDetectNode creates a new node that only emits new points if different from the previous point.
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: ChangeDetectNode
|
||||
identifier: change_detect_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/change_detect_node/
|
||||
---
|
||||
|
||||
The `changeDetect` node creates a new node that emits new points only if different from the previous point.
|
||||
|
|
@ -124,7 +125,7 @@ Create an alert node, which can trigger alerts.
|
|||
changeDetect|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -137,7 +138,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
changeDetect|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -148,7 +149,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
changeDetect|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -159,7 +160,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
changeDetect|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -170,7 +171,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
changeDetect|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -181,7 +182,7 @@ Count the number of points.
|
|||
changeDetect|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -193,7 +194,7 @@ A point is emitted for every point collected.
|
|||
changeDetect|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -239,7 +240,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -276,7 +277,7 @@ Example:
|
|||
changeDetect|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -287,7 +288,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
changeDetect|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -298,7 +299,7 @@ Create a node that can delete tags or fields.
|
|||
changeDetect|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -309,7 +310,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
changeDetect|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -320,7 +321,7 @@ Compute the difference between points independent of elapsed time.
|
|||
changeDetect|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -331,7 +332,7 @@ Produce batch of only the distinct points.
|
|||
changeDetect|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -342,7 +343,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
changeDetect|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -353,7 +354,7 @@ Compute the elapsed time between points.
|
|||
changeDetect|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -366,7 +367,7 @@ The results are available to later expressions.
|
|||
changeDetect|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -377,7 +378,7 @@ Select the first point.
|
|||
changeDetect|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -388,7 +389,7 @@ Flatten points with similar times into a single point.
|
|||
changeDetect|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -408,7 +409,7 @@ Example:
|
|||
changeDetect|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -419,7 +420,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
changeDetect|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -431,7 +432,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
changeDetect|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -446,7 +447,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
changeDetect|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -459,7 +460,7 @@ endpoint property method.
|
|||
changeDetect|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -470,7 +471,7 @@ Create an InfluxDB output node that will store the incoming data into InfluxDB.
|
|||
changeDetect|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -481,7 +482,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
changeDetect|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -492,7 +493,7 @@ Create a node that can trigger autoscale events for a Kubernetes cluster.
|
|||
changeDetect|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -503,7 +504,7 @@ Create an Kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
changeDetect|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -514,7 +515,7 @@ Select the last point.
|
|||
changeDetect|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -525,7 +526,7 @@ Create a node that logs all data it receives.
|
|||
changeDetect|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -536,7 +537,7 @@ Select the maximum point.
|
|||
changeDetect|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -547,7 +548,7 @@ Compute the mean of the data.
|
|||
changeDetect|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -561,7 +562,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
changeDetect|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -572,7 +573,7 @@ Select the minimum point.
|
|||
changeDetect|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -583,7 +584,7 @@ Compute the mode of the data.
|
|||
changeDetect|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -595,7 +596,7 @@ No points are emitted until the window is full.
|
|||
changeDetect|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -606,7 +607,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
changeDetect|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -619,7 +620,7 @@ One point will be emitted every count or duration specified.
|
|||
changeDetect|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -630,7 +631,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
changeDetect|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -641,7 +642,7 @@ Create a node that can load data from external sources.
|
|||
changeDetect|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -652,7 +653,7 @@ Compute the difference between `min` and `max` points.
|
|||
changeDetect|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -663,7 +664,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
changeDetect|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -674,7 +675,7 @@ Create a node that tracks duration in a given state.
|
|||
changeDetect|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -687,7 +688,7 @@ This means the interval time is independent of the times of the data points the
|
|||
changeDetect|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -698,7 +699,7 @@ Compute the standard deviation.
|
|||
changeDetect|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -709,7 +710,7 @@ Compute the sum of all values.
|
|||
changeDetect|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -720,7 +721,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
changeDetect|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -731,7 +732,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
changeDetect|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -741,7 +742,7 @@ Create a new node that converts batch data to stream data.
|
|||
changeDetect|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -752,7 +753,7 @@ Perform the union of this node and all other given nodes.
|
|||
changeDetect|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -763,7 +764,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
changeDetect|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -776,4 +777,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
changeDetect|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: CombineNode
|
|||
description: >
|
||||
CombineNode combines data from a single node with itself. Points with the same time are grouped and then combinations are created. The size of the combinations is defined by how many expressions are given.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: CombineNode
|
||||
identifier: combine_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/combine_node/
|
||||
---
|
||||
|
||||
The `combine` node combines data from a single node with itself.
|
||||
|
|
@ -212,7 +213,7 @@ Create an alert node, which can trigger alerts.
|
|||
combine|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -225,7 +226,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
combine|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -236,7 +237,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
combine|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -246,7 +247,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
combine|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -257,7 +258,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
combine|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -268,7 +269,7 @@ Count the number of points.
|
|||
combine|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -280,7 +281,7 @@ A point is emitted for every point collected.
|
|||
combine|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -326,7 +327,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -363,7 +364,7 @@ Example:
|
|||
combine|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -374,7 +375,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
combine|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -385,7 +386,7 @@ Create a node that can delete tags or fields.
|
|||
combine|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -396,7 +397,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
combine|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -407,7 +408,7 @@ Compute the difference between points independent of elapsed time.
|
|||
combine|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -418,7 +419,7 @@ Produce batch of only the distinct points.
|
|||
combine|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -429,7 +430,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
combine|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -440,7 +441,7 @@ Compute the elapsed time between points.
|
|||
combine|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -453,7 +454,7 @@ The results are available to later expressions.
|
|||
combine|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -464,7 +465,7 @@ Select the first point.
|
|||
combine|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -475,7 +476,7 @@ Flatten points with similar times into a single point.
|
|||
combine|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -495,7 +496,7 @@ Example:
|
|||
combine|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -506,7 +507,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
combine|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -518,7 +519,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
combine|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -533,7 +534,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
combine|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -546,7 +547,7 @@ endpoint property method.
|
|||
combine|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -557,7 +558,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
combine|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -568,7 +569,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
combine|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -579,7 +580,7 @@ Create a node that can trigger autoscale events for a Kubernetes cluster.
|
|||
combine|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -590,7 +591,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
combine|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -601,7 +602,7 @@ Select the last point.
|
|||
combine|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -612,7 +613,7 @@ Create a node that logs all data it receives.
|
|||
combine|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -623,7 +624,7 @@ Compute the mean of the data.
|
|||
combine|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -637,7 +638,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
combine|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -648,7 +649,7 @@ Select the minimum point.
|
|||
combine|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -659,7 +660,7 @@ Compute the mode of the data.
|
|||
combine|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -671,7 +672,7 @@ No points are emitted until the window is full.
|
|||
combine|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -682,7 +683,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
combine|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -695,7 +696,7 @@ One point will be emitted every count or duration specified.
|
|||
combine|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -706,7 +707,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
combine|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -717,7 +718,7 @@ Create a node that can load data from external sources.
|
|||
combine|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -728,7 +729,7 @@ Compute the difference between `min` and `max` points.
|
|||
combine|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -739,7 +740,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
combine|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -750,7 +751,7 @@ Create a node that tracks duration in a given state.
|
|||
combine|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -763,7 +764,7 @@ This means the interval time is independent of the times of the data points the
|
|||
combine|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -774,7 +775,7 @@ Compute the standard deviation.
|
|||
combine|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -785,7 +786,7 @@ Compute the sum of all values.
|
|||
combine|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -796,7 +797,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
combine|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -807,7 +808,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
combine|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -817,7 +818,7 @@ Create a new node that converts batch data to stream data.
|
|||
combine|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -828,7 +829,7 @@ Perform the union of this node and all other given nodes.
|
|||
combine|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -839,7 +840,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
combine|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -852,4 +853,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
combine|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -2,13 +2,14 @@
|
|||
title: DefaultNode
|
||||
description: DefaultNode sets defaults of fields and tags on data points.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: DefaultNode
|
||||
identifier: default_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/default_node/
|
||||
---
|
||||
|
||||
The `default` node sets defaults fields and tags on data points.
|
||||
|
|
@ -154,7 +155,7 @@ Create an alert node, which can trigger alerts.
|
|||
default|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -167,7 +168,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
default|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -178,7 +179,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
default|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -188,7 +189,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
default|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -199,7 +200,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
default|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -210,7 +211,7 @@ Count the number of points.
|
|||
default|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -222,7 +223,7 @@ A point is emitted for every point collected.
|
|||
default|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -268,7 +269,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -305,7 +306,7 @@ Example:
|
|||
default|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -316,7 +317,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
default|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -327,7 +328,7 @@ Create a node that can delete tags or fields.
|
|||
default|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -338,7 +339,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
default|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -349,7 +350,7 @@ Compute the difference between points independent of elapsed time.
|
|||
default|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -360,7 +361,7 @@ Produce batch of only the distinct points.
|
|||
default|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -371,7 +372,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
default|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -382,7 +383,7 @@ Compute the elapsed time between points.
|
|||
default|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -395,7 +396,7 @@ The results are available to later expressions.
|
|||
default|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -406,7 +407,7 @@ Select the first point.
|
|||
default|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -417,7 +418,7 @@ Flatten points with similar times into a single point.
|
|||
default|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -437,7 +438,7 @@ Example:
|
|||
default|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -448,7 +449,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
default|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -460,7 +461,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
default|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -475,7 +476,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
default|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -488,7 +489,7 @@ endpoint property method.
|
|||
default|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -499,7 +500,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
default|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -510,7 +511,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
default|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -521,7 +522,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
default|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -532,7 +533,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
default|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -543,7 +544,7 @@ Select the last point.
|
|||
default|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -554,7 +555,7 @@ Create a node that logs all data it receives.
|
|||
default|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -565,7 +566,7 @@ Select the maximum point.
|
|||
default|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -576,7 +577,7 @@ Compute the mean of the data.
|
|||
default|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -590,7 +591,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
default|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -601,7 +602,7 @@ Select the minimum point.
|
|||
default|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -612,7 +613,7 @@ Compute the mode of the data.
|
|||
default|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -624,7 +625,7 @@ No points are emitted until the window is full.
|
|||
default|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -635,7 +636,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
default|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -648,7 +649,7 @@ One point will be emitted every count or duration specified.
|
|||
default|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -659,7 +660,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
default|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -670,7 +671,7 @@ Create a node that can load data from external sources.
|
|||
default|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -681,7 +682,7 @@ Compute the difference between `min` and `max` points.
|
|||
default|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -692,7 +693,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
default|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -703,7 +704,7 @@ Create a node that tracks duration in a given state.
|
|||
default|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -716,7 +717,7 @@ This means the interval time is independent of the times of the data points the
|
|||
default|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -727,7 +728,7 @@ Compute the standard deviation.
|
|||
default|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -738,7 +739,7 @@ Compute the sum of all values.
|
|||
default|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -749,7 +750,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
default|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -760,7 +761,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
default|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -770,7 +771,7 @@ Create a new node that converts batch data to stream data.
|
|||
default|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -781,7 +782,7 @@ Perform the union of this node and all other given nodes.
|
|||
default|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -792,7 +793,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
default|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -805,4 +806,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
default|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -2,13 +2,14 @@
|
|||
title: DeleteNode
|
||||
description: DeleteNode deletes fields and tags from data points.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: DeleteNode
|
||||
identifier: delete_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/delete_node/
|
||||
---
|
||||
|
||||
The `delete` node deletes fields and tags from data points.
|
||||
|
|
@ -152,7 +153,7 @@ Create an alert node, which can trigger alerts.
|
|||
delete|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -165,7 +166,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
delete|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -176,7 +177,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
delete|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -186,7 +187,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
delete|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -197,7 +198,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
delete|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -208,7 +209,7 @@ Count the number of points.
|
|||
delete|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -220,7 +221,7 @@ A point is emitted for every point collected.
|
|||
delete|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -266,7 +267,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -303,7 +304,7 @@ Example:
|
|||
delete|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -314,7 +315,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
delete|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -325,7 +326,7 @@ Create a node that can delete tags or fields.
|
|||
delete|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -336,7 +337,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
delete|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -347,7 +348,7 @@ Compute the difference between points independent of elapsed time.
|
|||
delete|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -358,7 +359,7 @@ Produce batch of only the distinct points.
|
|||
delete|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -369,7 +370,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
delete|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -380,7 +381,7 @@ Compute the elapsed time between points.
|
|||
delete|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -393,7 +394,7 @@ The results are available to later expressions.
|
|||
delete|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -404,7 +405,7 @@ Select the first point.
|
|||
delete|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -415,7 +416,7 @@ Flatten points with similar times into a single point.
|
|||
delete|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -435,7 +436,7 @@ Example:
|
|||
delete|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -446,7 +447,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
delete|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -458,7 +459,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
delete|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -473,7 +474,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
delete|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -486,7 +487,7 @@ endpoint property method.
|
|||
delete|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -497,7 +498,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
delete|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -508,7 +509,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
delete|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -519,7 +520,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
delete|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -530,7 +531,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
delete|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -541,7 +542,7 @@ Select the last point.
|
|||
delete|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -552,7 +553,7 @@ Create a node that logs all data it receives.
|
|||
delete|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -563,7 +564,7 @@ Select the maximum point.
|
|||
delete|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -574,7 +575,7 @@ Compute the mean of the data.
|
|||
delete|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -588,7 +589,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
delete|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -599,7 +600,7 @@ Select the minimum point.
|
|||
delete|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -610,7 +611,7 @@ Compute the mode of the data.
|
|||
delete|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -622,7 +623,7 @@ No points are emitted until the window is full.
|
|||
delete|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -633,7 +634,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
delete|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -646,7 +647,7 @@ One point will be emitted every count or duration specified.
|
|||
delete|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -657,7 +658,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
delete|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -668,7 +669,7 @@ Create a node that can load data from external sources.
|
|||
delete|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -679,7 +680,7 @@ Compute the difference between `min` and `max` points.
|
|||
delete|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -690,7 +691,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
delete|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -701,7 +702,7 @@ Create a node that tracks duration in a given state.
|
|||
delete|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -714,7 +715,7 @@ This means the interval time is independent of the times of the data points the
|
|||
delete|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -725,7 +726,7 @@ Compute the standard deviation.
|
|||
delete|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -736,7 +737,7 @@ Compute the sum of all values.
|
|||
delete|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -747,7 +748,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
delete|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -758,7 +759,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
delete|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -768,7 +769,7 @@ Create a new node that converts batch data to stream data.
|
|||
delete|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -779,7 +780,7 @@ Perform the union of this node and all other given nodes.
|
|||
delete|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -790,7 +791,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
delete|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -803,4 +804,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
delete|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: DerivativeNode
|
|||
description: >
|
||||
DerivativeNode computes the derivative of a stream or batch. The derivative is computed on a single field and behaves similarly to the InfluxQL derivative function.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: DerivativeNode
|
||||
identifier: derivative_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/derivative_node/
|
||||
---
|
||||
|
||||
The `derivative` node computes the derivative of a stream or batch.
|
||||
|
|
@ -176,7 +177,7 @@ Create an alert node, which can trigger alerts.
|
|||
derivative|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -189,7 +190,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
derivative|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -200,7 +201,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
derivative|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -210,7 +211,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
derivative|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -221,7 +222,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
derivative|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -232,7 +233,7 @@ Count the number of points.
|
|||
derivative|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -244,7 +245,7 @@ A point is emitted for every point collected.
|
|||
derivative|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -290,7 +291,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -327,7 +328,7 @@ Example:
|
|||
derivative|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -338,7 +339,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
derivative|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -349,7 +350,7 @@ Create a node that can delete tags or fields.
|
|||
derivative|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -360,7 +361,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
derivative|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -371,7 +372,7 @@ Compute the difference between points independent of elapsed time.
|
|||
derivative|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -382,7 +383,7 @@ Produce batch of only the distinct points.
|
|||
derivative|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -393,7 +394,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
derivative|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -404,7 +405,7 @@ Compute the elapsed time between points.
|
|||
derivative|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -417,7 +418,7 @@ The results are available to later expressions.
|
|||
derivative|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -428,7 +429,7 @@ Select the first point.
|
|||
derivative|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -439,7 +440,7 @@ Flatten points with similar times into a single point.
|
|||
derivative|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -459,7 +460,7 @@ Example:
|
|||
derivative|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -470,7 +471,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
derivative|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -482,7 +483,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
derivative|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -497,7 +498,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
derivative|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -510,7 +511,7 @@ endpoint property method.
|
|||
derivative|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -521,7 +522,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
derivative|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -532,7 +533,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
derivative|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -543,7 +544,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
derivative|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -554,7 +555,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
derivative|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -565,7 +566,7 @@ Select the last point.
|
|||
derivative|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -576,7 +577,7 @@ Create a node that logs all data it receives.
|
|||
derivative|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -587,7 +588,7 @@ Select the maximum point.
|
|||
derivative|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -598,7 +599,7 @@ Compute the mean of the data.
|
|||
derivative|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -612,7 +613,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
derivative|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -623,7 +624,7 @@ Select the minimum point.
|
|||
derivative|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -634,7 +635,7 @@ Compute the mode of the data.
|
|||
derivative|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -646,7 +647,7 @@ No points are emitted until the window is full.
|
|||
derivative|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -657,7 +658,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
derivative|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -670,7 +671,7 @@ One point will be emitted every count or duration specified.
|
|||
derivative|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -681,7 +682,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
derivative|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -692,7 +693,7 @@ Create a node that can load data from external sources.
|
|||
derivative|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -703,7 +704,7 @@ Compute the difference between `min` and `max` points.
|
|||
derivative|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -714,7 +715,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
derivative|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -725,7 +726,7 @@ Create a node that tracks duration in a given state.
|
|||
derivative|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -738,7 +739,7 @@ This means the interval time is independent of the times of the data points the
|
|||
derivative|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -749,7 +750,7 @@ Compute the standard deviation.
|
|||
derivative|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -760,7 +761,7 @@ Compute the sum of all values.
|
|||
derivative|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -771,7 +772,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
derivative|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -782,7 +783,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
derivative|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -792,7 +793,7 @@ Create a new node that converts batch data to stream data.
|
|||
derivative|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -803,7 +804,7 @@ Perform the union of this node and all other given nodes.
|
|||
derivative|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -814,7 +815,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
derivative|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -827,4 +828,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
derivative|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: EC2AutoscaleNode
|
|||
description: >
|
||||
EC2AutoscaleNode triggers autoscale events on an AWS Autoscaling group. The node also outputs points for the triggered events.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: EC2AutoscaleNode
|
||||
identifier: ec2_autoscale_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/ec2_autoscale_node/
|
||||
---
|
||||
|
||||
The `ec2Autoscale` node triggers autoscale events for a group on a AWS Autoscaling group.
|
||||
|
|
@ -301,7 +302,7 @@ Create an alert node, which can trigger alerts.
|
|||
ec2Autoscale|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -314,7 +315,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
ec2Autoscale|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -325,7 +326,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
ec2Autoscale|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -335,7 +336,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
ec2Autoscale|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -346,7 +347,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
ec2Autoscale|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -357,7 +358,7 @@ Count the number of points.
|
|||
ec2Autoscale|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -369,7 +370,7 @@ A point is emitted for every point collected.
|
|||
ec2Autoscale|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -415,7 +416,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -452,7 +453,7 @@ Example:
|
|||
ec2Autoscale|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -463,7 +464,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
ec2Autoscale|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -474,7 +475,7 @@ Create a node that can delete tags or fields.
|
|||
ec2Autoscale|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -485,7 +486,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
ec2Autoscale|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -496,7 +497,7 @@ Compute the difference between points independent of elapsed time.
|
|||
ec2Autoscale|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -507,7 +508,7 @@ Produce batch of only the distinct points.
|
|||
ec2Autoscale|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -518,7 +519,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
ec2Autoscale|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -529,7 +530,7 @@ Compute the elapsed time between points.
|
|||
ec2Autoscale|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -542,7 +543,7 @@ The results are available to later expressions.
|
|||
ec2Autoscale|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -553,7 +554,7 @@ Select the first point.
|
|||
ec2Autoscale|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -564,7 +565,7 @@ Flatten points with similar times into a single point.
|
|||
ec2Autoscale|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -584,7 +585,7 @@ Example:
|
|||
ec2Autoscale|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -595,7 +596,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
ec2Autoscale|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -607,7 +608,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
ec2Autoscale|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -622,7 +623,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
ec2Autoscale|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -635,7 +636,7 @@ endpoint property method.
|
|||
ec2Autoscale|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -646,7 +647,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
ec2Autoscale|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -657,7 +658,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
ec2Autoscale|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -668,7 +669,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
ec2Autoscale|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -679,7 +680,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
ec2Autoscale|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -690,7 +691,7 @@ Select the last point.
|
|||
ec2Autoscale|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -701,7 +702,7 @@ Create a node that logs all data it receives.
|
|||
ec2Autoscale|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -712,7 +713,7 @@ Compute the mean of the data.
|
|||
ec2Autoscale|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -726,7 +727,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
ec2Autoscale|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -737,7 +738,7 @@ Compute the mode of the data.
|
|||
ec2Autoscale|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -749,7 +750,7 @@ No points are emitted until the window is full.
|
|||
ec2Autoscale|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -760,7 +761,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
ec2Autoscale|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -773,7 +774,7 @@ One point will be emitted every count or duration specified.
|
|||
ec2Autoscale|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -784,7 +785,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
ec2Autoscale|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -795,7 +796,7 @@ Create a node that can load data from external sources.
|
|||
ec2Autoscale|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -806,7 +807,7 @@ Compute the difference between `min` and `max` points.
|
|||
ec2Autoscale|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -817,7 +818,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
ec2Autoscale|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -828,7 +829,7 @@ Create a node that tracks duration in a given state.
|
|||
ec2Autoscale|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -841,7 +842,7 @@ This means the interval time is independent of the times of the data points the
|
|||
ec2Autoscale|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -852,7 +853,7 @@ Compute the standard deviation.
|
|||
ec2Autoscale|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -863,7 +864,7 @@ Compute the sum of all values.
|
|||
ec2Autoscale|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -874,7 +875,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
ec2Autoscale|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -885,7 +886,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
ec2Autoscale|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -895,7 +896,7 @@ Create a new node that converts batch data to stream data.
|
|||
ec2Autoscale|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -906,7 +907,7 @@ Perform the union of this node and all other given nodes.
|
|||
ec2Autoscale|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -917,7 +918,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
ec2Autoscale|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -930,4 +931,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
ec2Autoscale|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,19 +3,20 @@ title: EvalNode
|
|||
description: >
|
||||
EvalNode evaluates expressions on each data point it receives. A list of expressions may be provided and will be evaluated in the order they are given. The results of expressions are available to later expressions in the list.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: EvalNode
|
||||
identifier: eval_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/eval_node/
|
||||
---
|
||||
|
||||
The `eval` node evaluates expressions on each data point it receives.
|
||||
A list of expressions may be provided and will be evaluated in the order they are given.
|
||||
The results of expressions are available to later expressions in the list.
|
||||
See the property [EvalNode.As](/kapacitor/v1/nodes/eval_node/#as) for details on how to reference the results.
|
||||
See the property [EvalNode.As](/kapacitor/v1/reference/nodes/eval_node/#as) for details on how to reference the results.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -243,7 +244,7 @@ Create an alert node, which can trigger alerts.
|
|||
eval|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -256,7 +257,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
eval|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -267,7 +268,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
eval|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -277,7 +278,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
eval|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -288,7 +289,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
eval|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -299,7 +300,7 @@ Count the number of points.
|
|||
eval|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -311,7 +312,7 @@ A point is emitted for every point collected.
|
|||
eval|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -357,7 +358,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -394,7 +395,7 @@ Example:
|
|||
eval|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -405,7 +406,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
eval|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -416,7 +417,7 @@ Create a node that can delete tags or fields.
|
|||
eval|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -427,7 +428,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
eval|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -438,7 +439,7 @@ Compute the difference between points independent of elapsed time.
|
|||
eval|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -449,7 +450,7 @@ Produce batch of only the distinct points.
|
|||
eval|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -460,7 +461,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
eval|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -471,7 +472,7 @@ Compute the elapsed time between points.
|
|||
eval|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -484,7 +485,7 @@ The results are available to later expressions.
|
|||
eval|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -495,7 +496,7 @@ Select the first point.
|
|||
eval|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -506,7 +507,7 @@ Flatten points with similar times into a single point.
|
|||
eval|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -526,7 +527,7 @@ Example:
|
|||
eval|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -537,7 +538,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
eval|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -549,7 +550,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
eval|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -564,7 +565,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
eval|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -577,7 +578,7 @@ endpoint property method.
|
|||
eval|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -588,7 +589,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
eval|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -599,7 +600,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
eval|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -610,7 +611,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
eval|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -621,7 +622,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
eval|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -632,7 +633,7 @@ Select the last point.
|
|||
eval|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -643,7 +644,7 @@ Create a node that logs all data it receives.
|
|||
eval|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -654,7 +655,7 @@ Select the maximum point.
|
|||
eval|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -665,7 +666,7 @@ Compute the mean of the data.
|
|||
eval|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -679,7 +680,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
eval|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -690,7 +691,7 @@ Select the minimum point.
|
|||
eval|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -701,7 +702,7 @@ Compute the mode of the data.
|
|||
eval|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -713,7 +714,7 @@ No points are emitted until the window is full.
|
|||
eval|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -724,7 +725,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
eval|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -737,7 +738,7 @@ One point will be emitted every count or duration specified.
|
|||
eval|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -748,7 +749,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
eval|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -759,7 +760,7 @@ Create a node that can load data from external sources.
|
|||
eval|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -770,7 +771,7 @@ Compute the difference between `min` and `max` points.
|
|||
eval|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -781,7 +782,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
eval|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -792,7 +793,7 @@ Create a node that tracks duration in a given state.
|
|||
eval|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -805,7 +806,7 @@ This means the interval time is independent of the times of the data points the
|
|||
eval|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -816,7 +817,7 @@ Compute the standard deviation.
|
|||
eval|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -827,7 +828,7 @@ Compute the sum of all values.
|
|||
eval|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -838,7 +839,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
eval|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -849,7 +850,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
eval|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -859,7 +860,7 @@ Create a new node that converts batch data to stream data.
|
|||
eval|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -870,7 +871,7 @@ Perform the union of this node and all other given nodes.
|
|||
eval|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -881,7 +882,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
eval|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -894,4 +895,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
eval|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -2,13 +2,14 @@
|
|||
title: FlattenNode
|
||||
description: FlattenNode flattens a set of points on specific dimensions.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: FlattenNode
|
||||
identifier: flatten_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/flatten_node/
|
||||
---
|
||||
|
||||
The `flatten` node flattens a set of points on specific dimensions.
|
||||
|
|
@ -208,7 +209,7 @@ Create an alert node, which can trigger alerts.
|
|||
flatten|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -221,7 +222,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
flatten|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -232,7 +233,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
flatten|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -242,7 +243,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
flatten|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -253,7 +254,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
flatten|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -264,7 +265,7 @@ Count the number of points.
|
|||
flatten|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -276,7 +277,7 @@ A point is emitted for every point collected.
|
|||
flatten|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -322,7 +323,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -359,7 +360,7 @@ Example:
|
|||
flatten|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -370,7 +371,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
flatten|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -381,7 +382,7 @@ Create a node that can delete tags or fields.
|
|||
flatten|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -392,7 +393,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
flatten|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -403,7 +404,7 @@ Compute the difference between points independent of elapsed time.
|
|||
flatten|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -414,7 +415,7 @@ Produce batch of only the distinct points.
|
|||
flatten|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -425,7 +426,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
flatten|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -436,7 +437,7 @@ Compute the elapsed time between points.
|
|||
flatten|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -449,7 +450,7 @@ The results are available to later expressions.
|
|||
flatten|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -460,7 +461,7 @@ Select the first point.
|
|||
flatten|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -471,7 +472,7 @@ Flatten points with similar times into a single point.
|
|||
flatten|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -491,7 +492,7 @@ Example:
|
|||
flatten|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -502,7 +503,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
flatten|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -514,7 +515,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
flatten|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -529,7 +530,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
flatten|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -542,7 +543,7 @@ endpoint property method.
|
|||
flatten|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -553,7 +554,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
flatten|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -564,7 +565,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
flatten|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -575,7 +576,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
flatten|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -586,7 +587,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
flatten|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -597,7 +598,7 @@ Select the last point.
|
|||
flatten|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -608,7 +609,7 @@ Create a node that logs all data it receives.
|
|||
flatten|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -619,7 +620,7 @@ Select the maximum point.
|
|||
flatten|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -630,7 +631,7 @@ Compute the mean of the data.
|
|||
flatten|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -644,7 +645,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
flatten|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -655,7 +656,7 @@ Select the minimum point.
|
|||
flatten|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -666,7 +667,7 @@ Compute the mode of the data.
|
|||
flatten|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -678,7 +679,7 @@ No points are emitted until the window is full.
|
|||
flatten|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -689,7 +690,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
flatten|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -702,7 +703,7 @@ One point will be emitted every count or duration specified.
|
|||
flatten|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -713,7 +714,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
flatten|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -724,7 +725,7 @@ Create a node that can load data from external sources.
|
|||
flatten|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -735,7 +736,7 @@ Compute the difference between `min` and `max` points.
|
|||
flatten|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -746,7 +747,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
flatten|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -757,7 +758,7 @@ Create a node that tracks duration in a given state.
|
|||
flatten|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -770,7 +771,7 @@ This means the interval time is independent of the times of the data points the
|
|||
flatten|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -781,7 +782,7 @@ Compute the standard deviation.
|
|||
flatten|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -792,7 +793,7 @@ Compute the sum of all values.
|
|||
flatten|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -803,7 +804,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
flatten|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -814,7 +815,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
flatten|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -824,7 +825,7 @@ Create a new node that converts batch data to stream data.
|
|||
flatten|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -835,7 +836,7 @@ Perform the union of this node and all other given nodes.
|
|||
flatten|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -846,7 +847,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
flatten|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -859,4 +860,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
flatten|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,16 +3,17 @@ 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_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: FromNode
|
||||
identifier: from_node
|
||||
weight: 110
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/from_node/
|
||||
---
|
||||
|
||||
The `from` node selects a subset of the data flowing through a [StreamNode.](/kapacitor/v1/nodes/stream_node/)
|
||||
The `from` node selects a subset of the data flowing through a [StreamNode.](/kapacitor/v1/reference/nodes/stream_node/)
|
||||
The stream node allows you to select which portion of the stream you want to process.
|
||||
|
||||
Example:
|
||||
|
|
@ -52,7 +53,7 @@ the tag `host` matches the regex `logger\d+`.
|
|||
| **[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/tick/expr/) docs for more information. |
|
||||
| **[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/reference/tick/expr/) docs for more information. |
|
||||
|
||||
|
||||
|
||||
|
|
@ -255,7 +256,7 @@ from.truncate(value time.Duration)
|
|||
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/tick/expr/) docs for more information.
|
||||
See the [expression](/kapacitor/v1/reference/tick/expr/) docs for more information.
|
||||
|
||||
Multiple calls to the Where method will `AND` together each expression.
|
||||
|
||||
|
|
@ -354,7 +355,7 @@ Create an alert node, which can trigger alerts.
|
|||
from|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -367,7 +368,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
from|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -378,7 +379,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
from|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -388,7 +389,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
from|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -399,7 +400,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
from|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -410,7 +411,7 @@ Count the number of points.
|
|||
from|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -422,7 +423,7 @@ A point is emitted for every point collected.
|
|||
from|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -468,7 +469,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -505,7 +506,7 @@ Example:
|
|||
from|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -516,7 +517,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
from|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -527,7 +528,7 @@ Create a node that can delete tags or fields.
|
|||
from|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -538,7 +539,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
from|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -549,7 +550,7 @@ Compute the difference between points independent of elapsed time.
|
|||
from|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -560,7 +561,7 @@ Produce batch of only the distinct points.
|
|||
from|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -571,7 +572,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
from|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -582,7 +583,7 @@ Compute the elapsed time between points.
|
|||
from|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -595,7 +596,7 @@ The results are available to later expressions.
|
|||
from|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -606,7 +607,7 @@ Select the first point.
|
|||
from|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -617,7 +618,7 @@ Flatten points with similar times into a single point.
|
|||
from|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### From
|
||||
|
||||
|
|
@ -654,7 +655,7 @@ Example:
|
|||
from|from()
|
||||
```
|
||||
|
||||
Returns: [FromNode](/kapacitor/v1/nodes/from_node/)
|
||||
Returns: [FromNode](/kapacitor/v1/reference/nodes/from_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -665,7 +666,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
from|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -677,7 +678,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
from|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -692,7 +693,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
from|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -705,7 +706,7 @@ endpoint property method.
|
|||
from|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -716,7 +717,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
from|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -727,7 +728,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
from|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -738,7 +739,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
from|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -749,7 +750,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
from|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -760,7 +761,7 @@ Select the last point.
|
|||
from|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -771,7 +772,7 @@ Create a node that logs all data it receives.
|
|||
from|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -782,7 +783,7 @@ Select the maximum point.
|
|||
from|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -793,7 +794,7 @@ Compute the mean of the data.
|
|||
from|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -807,7 +808,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
from|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -818,7 +819,7 @@ Select the minimum point.
|
|||
from|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -829,7 +830,7 @@ Compute the mode of the data.
|
|||
from|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -841,7 +842,7 @@ No points are emitted until the window is full.
|
|||
from|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -852,7 +853,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
from|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -865,7 +866,7 @@ One point will be emitted every count or duration specified.
|
|||
from|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -876,7 +877,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
from|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -887,7 +888,7 @@ Create a node that can load data from external sources.
|
|||
from|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -898,7 +899,7 @@ Compute the difference between `min` and `max` points.
|
|||
from|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -909,7 +910,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
from|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -920,7 +921,7 @@ Create a node that tracks duration in a given state.
|
|||
from|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -933,7 +934,7 @@ This means the interval time is independent of the times of the data points the
|
|||
from|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -944,7 +945,7 @@ Compute the standard deviation.
|
|||
from|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -955,7 +956,7 @@ Compute the sum of all values.
|
|||
from|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -966,7 +967,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
from|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -977,7 +978,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
from|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -988,7 +989,7 @@ Perform the union of this node and all other given nodes.
|
|||
from|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -1001,4 +1002,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
from|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: GroupByNode
|
|||
description: >
|
||||
GroupByNode groups incoming data. Each group is then processed independently for the rest of the pipeline. Only tags that are dimensions in the grouping will be preserved; all other tags are dropped.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: GroupByNode
|
||||
identifier: group_by_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/group_by_node/
|
||||
---
|
||||
|
||||
The `groupBy` node will group the incoming data.
|
||||
|
|
@ -170,7 +171,7 @@ Create an alert node, which can trigger alerts.
|
|||
groupBy|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -183,7 +184,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
groupBy|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -194,7 +195,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
groupBy|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -204,7 +205,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
groupBy|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -215,7 +216,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
groupBy|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -226,7 +227,7 @@ Count the number of points.
|
|||
groupBy|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -238,7 +239,7 @@ A point is emitted for every point collected.
|
|||
groupBy|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -284,7 +285,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -321,7 +322,7 @@ Example:
|
|||
groupBy|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -332,7 +333,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
groupBy|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -343,7 +344,7 @@ Create a node that can delete tags or fields.
|
|||
groupBy|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -354,7 +355,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
groupBy|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -365,7 +366,7 @@ Compute the difference between points independent of elapsed time.
|
|||
groupBy|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -376,7 +377,7 @@ Produce batch of only the distinct points.
|
|||
groupBy|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -387,7 +388,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
groupBy|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -398,7 +399,7 @@ Compute the elapsed time between points.
|
|||
groupBy|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -411,7 +412,7 @@ The results are available to later expressions.
|
|||
groupBy|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### Exclude
|
||||
|
||||
|
|
@ -422,7 +423,7 @@ Exclude removes any tags from the group.
|
|||
groupBy|exclude(dims ...string)
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -433,7 +434,7 @@ Select the first point.
|
|||
groupBy|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -444,7 +445,7 @@ Flatten points with similar times into a single point.
|
|||
groupBy|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -464,7 +465,7 @@ Example:
|
|||
groupBy|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -475,7 +476,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
groupBy|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -487,7 +488,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
groupBy|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -502,7 +503,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
groupBy|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -515,7 +516,7 @@ endpoint property method.
|
|||
groupBy|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -526,7 +527,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
groupBy|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -537,7 +538,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
groupBy|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -548,7 +549,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
groupBy|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -559,7 +560,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
groupBy|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -570,7 +571,7 @@ Select the last point.
|
|||
groupBy|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -581,7 +582,7 @@ Create a node that logs all data it receives.
|
|||
groupBy|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -592,7 +593,7 @@ Select the maximum point.
|
|||
groupBy|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -603,7 +604,7 @@ Compute the mean of the data.
|
|||
groupBy|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -617,7 +618,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
groupBy|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -628,7 +629,7 @@ Select the minimum point.
|
|||
groupBy|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -639,7 +640,7 @@ Compute the mode of the data.
|
|||
groupBy|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -651,7 +652,7 @@ No points are emitted until the window is full.
|
|||
groupBy|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -662,7 +663,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
groupBy|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -675,7 +676,7 @@ One point will be emitted every count or duration specified.
|
|||
groupBy|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -686,7 +687,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
groupBy|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -697,7 +698,7 @@ Create a node that can load data from external sources.
|
|||
groupBy|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -708,7 +709,7 @@ Compute the difference between `min` and `max` points.
|
|||
groupBy|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -719,7 +720,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
groupBy|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -730,7 +731,7 @@ Create a node that tracks duration in a given state.
|
|||
groupBy|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -743,7 +744,7 @@ This means the interval time is independent of the times of the data points the
|
|||
groupBy|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -754,7 +755,7 @@ Compute the standard deviation.
|
|||
groupBy|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -765,7 +766,7 @@ Compute the sum of all values.
|
|||
groupBy|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -776,7 +777,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
groupBy|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -787,7 +788,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
groupBy|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -797,7 +798,7 @@ Create a new node that converts batch data to stream data.
|
|||
groupBy|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -808,7 +809,7 @@ Perform the union of this node and all other given nodes.
|
|||
groupBy|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -819,7 +820,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
groupBy|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -832,4 +833,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
groupBy|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: HTTPOutNode
|
|||
description: >
|
||||
HTTPOutNode caches the most recent data for each group it has received. The cached data is available at the given endpoint, which is the relative path from the API endpoint of the running task.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: HTTPOutNode
|
||||
identifier: http_out_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/http_out_node/
|
||||
---
|
||||
|
||||
The `httpOut` node acts as a simple passthrough and caches the most recent data for each group it has received.
|
||||
|
|
@ -140,7 +141,7 @@ Create an alert node, which can trigger alerts.
|
|||
httpOut|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -153,7 +154,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
httpOut|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -164,7 +165,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
httpOut|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -174,7 +175,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
httpOut|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -185,7 +186,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
httpOut|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -196,7 +197,7 @@ Count the number of points.
|
|||
httpOut|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -208,7 +209,7 @@ A point is emitted for every point collected.
|
|||
httpOut|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -254,7 +255,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -291,7 +292,7 @@ Example:
|
|||
httpOut|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -302,7 +303,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
httpOut|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -313,7 +314,7 @@ Create a node that can delete tags or fields.
|
|||
httpOut|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -324,7 +325,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
httpOut|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -335,7 +336,7 @@ Compute the difference between points independent of elapsed time.
|
|||
httpOut|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -346,7 +347,7 @@ Produce batch of only the distinct points.
|
|||
httpOut|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -357,7 +358,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
httpOut|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -368,7 +369,7 @@ Compute the elapsed time between points.
|
|||
httpOut|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -381,7 +382,7 @@ The results are available to later expressions.
|
|||
httpOut|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -392,7 +393,7 @@ Select the first point.
|
|||
httpOut|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -403,7 +404,7 @@ Flatten points with similar times into a single point.
|
|||
httpOut|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -423,7 +424,7 @@ Example:
|
|||
httpOut|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -434,7 +435,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
httpOut|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -446,7 +447,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
httpOut|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -461,7 +462,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
httpOut|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -474,7 +475,7 @@ endpoint property method.
|
|||
httpOut|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -485,7 +486,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
httpOut|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -496,7 +497,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
httpOut|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -507,7 +508,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
httpOut|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -518,7 +519,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
httpOut|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -529,7 +530,7 @@ Select the last point.
|
|||
httpOut|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -540,7 +541,7 @@ Create a node that logs all data it receives.
|
|||
httpOut|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -551,7 +552,7 @@ Select the maximum point.
|
|||
httpOut|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -562,7 +563,7 @@ Compute the mean of the data.
|
|||
httpOut|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -576,7 +577,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
httpOut|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -587,7 +588,7 @@ Select the minimum point.
|
|||
httpOut|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -598,7 +599,7 @@ Compute the mode of the data.
|
|||
httpOut|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -610,7 +611,7 @@ No points are emitted until the window is full.
|
|||
httpOut|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -621,7 +622,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
httpOut|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -634,7 +635,7 @@ One point will be emitted every count or duration specified.
|
|||
httpOut|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -645,7 +646,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
httpOut|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -656,7 +657,7 @@ Create a node that can load data from external sources.
|
|||
httpOut|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -667,7 +668,7 @@ Compute the difference between `min` and `max` points.
|
|||
httpOut|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -678,7 +679,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
httpOut|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -689,7 +690,7 @@ Create a node that tracks duration in a given state.
|
|||
httpOut|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -702,7 +703,7 @@ This means the interval time is independent of the times of the data points the
|
|||
httpOut|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -713,7 +714,7 @@ Compute the standard deviation.
|
|||
httpOut|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -724,7 +725,7 @@ Compute the sum of all values.
|
|||
httpOut|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -735,7 +736,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
httpOut|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -746,7 +747,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
httpOut|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -756,7 +757,7 @@ Create a new node that converts batch data to stream data.
|
|||
httpOut|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -767,7 +768,7 @@ Perform the union of this node and all other given nodes.
|
|||
httpOut|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -778,7 +779,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
httpOut|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -791,4 +792,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
httpOut|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: HTTPPostNode
|
|||
description: >
|
||||
HTTPPostNode takes the incoming data stream and will POST it to an HTTP endpoint. That endpoint may be specified as a positional argument, or as an endpoint property method on httpPost. Multiple endpoint property methods may be specified.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: HTTPPostNode
|
||||
identifier: http_post_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/http_post_node/
|
||||
---
|
||||
|
||||
The `httpPost` node will take the incoming data stream and POST it to an HTTP endpoint.
|
||||
|
|
@ -46,7 +47,7 @@ stream
|
|||
|
||||
| Chaining Method | Description |
|
||||
|:---------|:---------|
|
||||
| **httpPost ( `url` `...string`)** | 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.<br> <br>To dynamically construct a custom HTTP body or URL, use a [**row template**](/kapacitor/v1/event_handlers/post/#row-templates ). For example: `httpPost('localhost/?host={{ index .Tags "host"}}&cpu={{ index .Tags "cpu" }}')`.
|
||||
| **httpPost ( `url` `...string`)** | 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.<br> <br>To dynamically construct a custom HTTP body or URL, use a [**row template**](/kapacitor/v1/reference/event_handlers/post/#row-templates ). For example: `httpPost('localhost/?host={{ index .Tags "host"}}&cpu={{ index .Tags "cpu" }}')`.
|
||||
|
||||
### Property Methods
|
||||
|
||||
|
|
@ -221,7 +222,7 @@ Create an alert node, which can trigger alerts.
|
|||
httpPost|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -234,7 +235,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
httpPost|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -245,7 +246,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
httpPost|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -255,7 +256,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
httpPost|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -266,7 +267,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
httpPost|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -277,7 +278,7 @@ Count the number of points.
|
|||
httpPost|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -289,7 +290,7 @@ A point is emitted for every point collected.
|
|||
httpPost|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -335,7 +336,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -372,7 +373,7 @@ Example:
|
|||
httpPost|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -383,7 +384,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
httpPost|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -394,7 +395,7 @@ Create a node that can delete tags or fields.
|
|||
httpPost|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -405,7 +406,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
httpPost|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -416,7 +417,7 @@ Compute the difference between points independent of elapsed time.
|
|||
httpPost|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -427,7 +428,7 @@ Produce batch of only the distinct points.
|
|||
httpPost|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -438,7 +439,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
httpPost|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -449,7 +450,7 @@ Compute the elapsed time between points.
|
|||
httpPost|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -462,7 +463,7 @@ The results are available to later expressions.
|
|||
httpPost|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -473,7 +474,7 @@ Select the first point.
|
|||
httpPost|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -484,7 +485,7 @@ Flatten points with similar times into a single point.
|
|||
httpPost|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -504,7 +505,7 @@ Example:
|
|||
httpPost|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -515,7 +516,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
httpPost|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -527,7 +528,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
httpPost|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -542,7 +543,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
httpPost|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -555,7 +556,7 @@ endpoint property method.
|
|||
httpPost|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -566,7 +567,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
httpPost|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -577,7 +578,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
httpPost|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -588,7 +589,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
httpPost|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -599,7 +600,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
httpPost|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -610,7 +611,7 @@ Select the last point.
|
|||
httpPost|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -621,7 +622,7 @@ Create a node that logs all data it receives.
|
|||
httpPost|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -632,7 +633,7 @@ Select the maximum point.
|
|||
httpPost|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -643,7 +644,7 @@ Compute the mean of the data.
|
|||
httpPost|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -657,7 +658,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
httpPost|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -668,7 +669,7 @@ Select the minimum point.
|
|||
httpPost|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -679,7 +680,7 @@ Compute the mode of the data.
|
|||
httpPost|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -691,7 +692,7 @@ No points are emitted until the window is full.
|
|||
httpPost|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -702,7 +703,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
httpPost|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -715,7 +716,7 @@ One point will be emitted every count or duration specified.
|
|||
httpPost|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -726,7 +727,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
httpPost|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -737,7 +738,7 @@ Create a node that can load data from external sources.
|
|||
httpPost|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -748,7 +749,7 @@ Compute the difference between `min` and `max` points.
|
|||
httpPost|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -759,7 +760,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
httpPost|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -770,7 +771,7 @@ Create a node that tracks duration in a given state.
|
|||
httpPost|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -783,7 +784,7 @@ This means the interval time is independent of the times of the data points the
|
|||
httpPost|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -794,7 +795,7 @@ Compute the standard deviation.
|
|||
httpPost|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -805,7 +806,7 @@ Compute the sum of all values.
|
|||
httpPost|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -816,7 +817,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
httpPost|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -827,7 +828,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
httpPost|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -837,7 +838,7 @@ Create a new node that converts batch data to stream data.
|
|||
httpPost|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -848,7 +849,7 @@ Perform the union of this node and all other given nodes.
|
|||
httpPost|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -859,7 +860,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
httpPost|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -872,4 +873,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
httpPost|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: InfluxDBOutNode
|
|||
description: >
|
||||
InfluxDBOutNode writes data to an InfluxDB database as it is received.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: InfluxDBOutNode
|
||||
identifier: influx_d_b_out_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/influx_d_b_out_node/
|
||||
---
|
||||
|
||||
The `influxDBOut` node writes data to InfluxDB as it is received.
|
||||
|
|
@ -246,7 +247,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -283,7 +284,7 @@ Example:
|
|||
influxDBOut|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -296,4 +297,4 @@ This means the interval time is independent of the times of the data points the
|
|||
influxDBOut|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: InfluxQLNode
|
|||
description: >
|
||||
InfluxQLNode performs the available function from the InfluxQL language. The function can be performed on a stream or batch edge. The resulting edge is dependent on the function.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: InfluxQLNode
|
||||
identifier: influx_q_l_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/influx_q_l_node/
|
||||
---
|
||||
|
||||
The `influxQL` node performs [InfluxQL functions](/influxdb/v1/query_language/functions/).
|
||||
|
|
@ -32,7 +33,7 @@ stream
|
|||
```
|
||||
|
||||
|
||||
Note: Derivative has its own implementation as a [DerivativeNode](/kapacitor/v1/nodes/derivative_node/) instead of as part of the
|
||||
Note: Derivative has its own implementation as a [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/) instead of as part of the
|
||||
InfluxQL functions.
|
||||
|
||||
|
||||
|
|
@ -162,7 +163,7 @@ Create an alert node, which can trigger alerts.
|
|||
influxQL|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -175,7 +176,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
influxQL|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -186,7 +187,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
influxQL|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -196,7 +197,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
influxQL|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -207,7 +208,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
influxQL|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -218,7 +219,7 @@ Count the number of points.
|
|||
influxQL|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -230,7 +231,7 @@ A point is emitted for every point collected.
|
|||
influxQL|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -276,7 +277,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -313,7 +314,7 @@ Example:
|
|||
influxQL|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -324,7 +325,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
influxQL|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -335,7 +336,7 @@ Create a node that can delete tags or fields.
|
|||
influxQL|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -346,7 +347,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
influxQL|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -357,7 +358,7 @@ Compute the difference between points independent of elapsed time.
|
|||
influxQL|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -368,7 +369,7 @@ Produce batch of only the distinct points.
|
|||
influxQL|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -379,7 +380,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
influxQL|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -390,7 +391,7 @@ Compute the elapsed time between points.
|
|||
influxQL|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -403,7 +404,7 @@ The results are available to later expressions.
|
|||
influxQL|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -414,7 +415,7 @@ Select the first point.
|
|||
influxQL|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -425,7 +426,7 @@ Flatten points with similar times into a single point.
|
|||
influxQL|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -445,7 +446,7 @@ Example:
|
|||
influxQL|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -456,7 +457,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
influxQL|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -468,7 +469,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
influxQL|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -483,7 +484,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
influxQL|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -496,7 +497,7 @@ endpoint property method.
|
|||
influxQL|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -507,7 +508,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
influxQL|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -518,7 +519,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
influxQL|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -529,7 +530,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
influxQL|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -540,7 +541,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
influxQL|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -551,7 +552,7 @@ Select the last point.
|
|||
influxQL|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -562,7 +563,7 @@ Create a node that logs all data it receives.
|
|||
influxQL|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -573,7 +574,7 @@ Select the maximum point.
|
|||
influxQL|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -584,7 +585,7 @@ Compute the mean of the data.
|
|||
influxQL|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -598,7 +599,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
influxQL|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -609,7 +610,7 @@ Select the minimum point.
|
|||
influxQL|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -620,7 +621,7 @@ Compute the mode of the data.
|
|||
influxQL|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -632,7 +633,7 @@ No points are emitted until the window is full.
|
|||
influxQL|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -643,7 +644,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
influxQL|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -656,7 +657,7 @@ One point will be emitted every count or duration specified.
|
|||
influxQL|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -667,7 +668,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
influxQL|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -678,7 +679,7 @@ Create a node that can load data from external sources.
|
|||
influxQL|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -689,7 +690,7 @@ Compute the difference between `min` and `max` points.
|
|||
influxQL|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -700,7 +701,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
influxQL|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -711,7 +712,7 @@ Create a node that tracks duration in a given state.
|
|||
influxQL|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -724,7 +725,7 @@ This means the interval time is independent of the times of the data points the
|
|||
influxQL|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -735,7 +736,7 @@ Compute the standard deviation.
|
|||
influxQL|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -746,7 +747,7 @@ Compute the sum of all values.
|
|||
influxQL|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -757,7 +758,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
influxQL|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -768,7 +769,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
influxQL|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -779,7 +780,7 @@ Perform the union of this node and all other given nodes.
|
|||
influxQL|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -790,7 +791,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
influxQL|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -803,4 +804,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
influxQL|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: JoinNode
|
|||
description: >
|
||||
JoinNode joins the data from any number of nodes. As each data point is received from a parent node it is paired with the next data points from the other parent nodes with a matching timestamp.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: JoinNode
|
||||
identifier: join_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/join_node/
|
||||
---
|
||||
|
||||
The `join` node joins data from any number of nodes.
|
||||
|
|
@ -24,7 +25,7 @@ they arrive.
|
|||
|
||||
Aliases are used to prefix all fields from the respective nodes.
|
||||
|
||||
The join can be an inner or outer join, see the [JoinNode.Fill](/kapacitor/v1/nodes/join_node/#fill) property.
|
||||
The join can be an inner or outer join, see the [JoinNode.Fill](/kapacitor/v1/reference/nodes/join_node/#fill) property.
|
||||
|
||||
#### Example: Joining two measurements
|
||||
In the example below, the `errors` and `requests` streams are joined
|
||||
|
|
@ -228,7 +229,7 @@ Options are:
|
|||
> When using a numerical or null fill, the fields names are determined by copying
|
||||
> the field names from another point.
|
||||
> This doesn't work well when different sources have different field names.
|
||||
> Use the [DefaultNode](/kapacitor/v1/nodes/default_node/) and [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
> Use the [DefaultNode](/kapacitor/v1/reference/nodes/default_node/) and [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
> to finalize the fill operation if necessary.
|
||||
|
||||
```js
|
||||
|
|
@ -272,7 +273,7 @@ Example:
|
|||
#### Handling null fill values in outer joins
|
||||
When using Kapacitor to perform an outer join, it's important to set default values
|
||||
for `null` fields resulting from the join and fill operations.
|
||||
This is done using the [DefaultNode](/kapacitor/v1/nodes/default_node/),
|
||||
This is done using the [DefaultNode](/kapacitor/v1/reference/nodes/default_node/),
|
||||
which replaces null values for a specific field key with a specified default value.
|
||||
Not doing so may result in invalid line protocol (as `null` isn't an appropriate
|
||||
value for all field types) causing the join to fail.
|
||||
|
|
@ -298,7 +299,7 @@ source1
|
|||
> When using this method, you must know all fields and field types resulting from
|
||||
> the join and provide the appropriate default values.
|
||||
|
||||
You can also use the [DeleteNode](/kapacitor/v1/nodes/delete_node/) to remove
|
||||
You can also use the [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/) to remove
|
||||
unnecessary fields or tags resulting from the join.
|
||||
|
||||
```js
|
||||
|
|
@ -408,7 +409,7 @@ Create an alert node, which can trigger alerts.
|
|||
join|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -421,7 +422,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
join|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -432,7 +433,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
join|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -442,7 +443,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
join|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -453,7 +454,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
join|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -464,7 +465,7 @@ Count the number of points.
|
|||
join|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -476,7 +477,7 @@ A point is emitted for every point collected.
|
|||
join|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -522,7 +523,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -559,7 +560,7 @@ Example:
|
|||
join|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -570,7 +571,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
join|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -581,7 +582,7 @@ Create a node that can delete tags or fields.
|
|||
join|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -592,7 +593,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
join|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -603,7 +604,7 @@ Compute the difference between points independent of elapsed time.
|
|||
join|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -614,7 +615,7 @@ Produce batch of only the distinct points.
|
|||
join|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -625,7 +626,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
join|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -636,7 +637,7 @@ Compute the elapsed time between points.
|
|||
join|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -649,7 +650,7 @@ The results are available to later expressions.
|
|||
join|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -660,7 +661,7 @@ Select the first point.
|
|||
join|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -671,7 +672,7 @@ Flatten points with similar times into a single point.
|
|||
join|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -691,7 +692,7 @@ Example:
|
|||
join|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -702,7 +703,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
join|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -714,7 +715,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
join|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -729,7 +730,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
join|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -742,7 +743,7 @@ endpoint property method.
|
|||
join|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -753,7 +754,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
join|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -764,7 +765,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
join|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -775,7 +776,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
join|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -786,7 +787,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
join|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -797,7 +798,7 @@ Select the last point.
|
|||
join|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -808,7 +809,7 @@ Create a node that logs all data it receives.
|
|||
join|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -819,7 +820,7 @@ Select the maximum point.
|
|||
join|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -830,7 +831,7 @@ Compute the mean of the data.
|
|||
join|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -844,7 +845,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
join|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -855,7 +856,7 @@ Select the minimum point.
|
|||
join|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -866,7 +867,7 @@ Compute the mode of the data.
|
|||
join|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -878,7 +879,7 @@ No points are emitted until the window is full.
|
|||
join|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -889,7 +890,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
join|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -902,7 +903,7 @@ One point will be emitted every count or duration specified.
|
|||
join|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -913,7 +914,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
join|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -924,7 +925,7 @@ Create a node that can load data from external sources.
|
|||
join|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -935,7 +936,7 @@ Compute the difference between `min` and `max` points.
|
|||
join|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -946,7 +947,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
join|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -957,7 +958,7 @@ Create a node that tracks duration in a given state.
|
|||
join|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -970,7 +971,7 @@ This means the interval time is independent of the times of the data points the
|
|||
join|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -981,7 +982,7 @@ Compute the standard deviation.
|
|||
join|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -992,7 +993,7 @@ Compute the sum of all values.
|
|||
join|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -1003,7 +1004,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
join|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -1014,7 +1015,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
join|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -1024,7 +1025,7 @@ Create a new node that converts batch data to stream data.
|
|||
join|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -1035,7 +1036,7 @@ Perform the union of this node and all other given nodes.
|
|||
join|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -1046,7 +1047,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
join|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -1059,4 +1060,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
join|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: K8sAutoscaleNode
|
|||
description: >
|
||||
K8sAutoscaleNode triggers autoscale events for a resource on a Kubernetes cluster and outputs points for the triggered events.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: K8sAutoscaleNode
|
||||
identifier: k8s_autoscale_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/k8s_autoscale_node/
|
||||
---
|
||||
|
||||
The `k8sAutoscale` node triggers autoscale events for a resource on a Kubernetes cluster.
|
||||
|
|
@ -355,7 +356,7 @@ Create an alert node, which can trigger alerts.
|
|||
k8sAutoscale|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -368,7 +369,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
k8sAutoscale|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -379,7 +380,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
k8sAutoscale|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -389,7 +390,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
k8sAutoscale|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -400,7 +401,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
k8sAutoscale|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -411,7 +412,7 @@ Count the number of points.
|
|||
k8sAutoscale|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -423,7 +424,7 @@ A point is emitted for every point collected.
|
|||
k8sAutoscale|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -469,7 +470,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -506,7 +507,7 @@ Example:
|
|||
k8sAutoscale|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -517,7 +518,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
k8sAutoscale|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -528,7 +529,7 @@ Create a node that can delete tags or fields.
|
|||
k8sAutoscale|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -539,7 +540,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
k8sAutoscale|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -550,7 +551,7 @@ Compute the difference between points independent of elapsed time.
|
|||
k8sAutoscale|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -561,7 +562,7 @@ Produce batch of only the distinct points.
|
|||
k8sAutoscale|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -572,7 +573,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
k8sAutoscale|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -583,7 +584,7 @@ Compute the elapsed time between points.
|
|||
k8sAutoscale|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -596,7 +597,7 @@ The results are available to later expressions.
|
|||
k8sAutoscale|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -607,7 +608,7 @@ Select the first point.
|
|||
k8sAutoscale|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -618,7 +619,7 @@ Flatten points with similar times into a single point.
|
|||
k8sAutoscale|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -638,7 +639,7 @@ Example:
|
|||
k8sAutoscale|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -649,7 +650,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
k8sAutoscale|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -661,7 +662,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
k8sAutoscale|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -676,7 +677,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
k8sAutoscale|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -689,7 +690,7 @@ endpoint property method.
|
|||
k8sAutoscale|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -700,7 +701,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
k8sAutoscale|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -711,7 +712,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
k8sAutoscale|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -722,7 +723,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
k8sAutoscale|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -733,7 +734,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
k8sAutoscale|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -744,7 +745,7 @@ Select the last point.
|
|||
k8sAutoscale|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -755,7 +756,7 @@ Create a node that logs all data it receives.
|
|||
k8sAutoscale|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -766,7 +767,7 @@ Compute the mean of the data.
|
|||
k8sAutoscale|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -780,7 +781,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
k8sAutoscale|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -791,7 +792,7 @@ Compute the mode of the data.
|
|||
k8sAutoscale|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -803,7 +804,7 @@ No points are emitted until the window is full.
|
|||
k8sAutoscale|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -814,7 +815,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
k8sAutoscale|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -827,7 +828,7 @@ One point will be emitted every count or duration specified.
|
|||
k8sAutoscale|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -838,7 +839,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
k8sAutoscale|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -849,7 +850,7 @@ Create a node that can load data from external sources.
|
|||
k8sAutoscale|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -860,7 +861,7 @@ Compute the difference between `min` and `max` points.
|
|||
k8sAutoscale|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -871,7 +872,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
k8sAutoscale|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -882,7 +883,7 @@ Create a node that tracks duration in a given state.
|
|||
k8sAutoscale|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -895,7 +896,7 @@ This means the interval time is independent of the times of the data points the
|
|||
k8sAutoscale|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -906,7 +907,7 @@ Compute the standard deviation.
|
|||
k8sAutoscale|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -917,7 +918,7 @@ Compute the sum of all values.
|
|||
k8sAutoscale|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -928,7 +929,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
k8sAutoscale|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -939,7 +940,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
k8sAutoscale|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -949,7 +950,7 @@ Create a new node that converts batch data to stream data.
|
|||
k8sAutoscale|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -960,7 +961,7 @@ Perform the union of this node and all other given nodes.
|
|||
k8sAutoscale|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -971,7 +972,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
k8sAutoscale|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -984,4 +985,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
k8sAutoscale|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -2,17 +2,18 @@
|
|||
title: KapacitorLoopbackNode
|
||||
description: KapacitorLoopbackNode writes data back into the Kapacitor stream.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: KapacitorLoopback
|
||||
identifier: kapacitor_loopback_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/kapacitor_loopback_node/
|
||||
---
|
||||
|
||||
The `kapacitorLoopback` node writes data back into the Kapacitor stream.
|
||||
To write data to a remote Kapacitor instance use the [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/).
|
||||
To write data to a remote Kapacitor instance use the [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/).
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -188,7 +189,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -225,7 +226,7 @@ Example:
|
|||
kapacitorLoopback|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -238,4 +239,4 @@ This means the interval time is independent of the times of the data points the
|
|||
kapacitorLoopback|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
|
@ -2,13 +2,14 @@
|
|||
title: LogNode
|
||||
description: LogNode logs all data that passes through the node.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: LogNode
|
||||
identifier: log_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/log_node/
|
||||
---
|
||||
|
||||
The `log` node logs all data that passes through it.
|
||||
|
|
@ -151,7 +152,7 @@ Create an alert node, which can trigger alerts.
|
|||
log|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -164,7 +165,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
log|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -175,7 +176,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
log|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -185,7 +186,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
log|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -196,7 +197,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
log|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -207,7 +208,7 @@ Count the number of points.
|
|||
log|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -219,7 +220,7 @@ A point is emitted for every point collected.
|
|||
log|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -265,7 +266,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -302,7 +303,7 @@ Example:
|
|||
log|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -313,7 +314,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
log|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -324,7 +325,7 @@ Create a node that can delete tags or fields.
|
|||
log|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -335,7 +336,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
log|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -346,7 +347,7 @@ Compute the difference between points independent of elapsed time.
|
|||
log|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -357,7 +358,7 @@ Produce batch of only the distinct points.
|
|||
log|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -368,7 +369,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
log|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -379,7 +380,7 @@ Compute the elapsed time between points.
|
|||
log|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -392,7 +393,7 @@ The results are available to later expressions.
|
|||
log|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -403,7 +404,7 @@ Select the first point.
|
|||
log|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -414,7 +415,7 @@ Flatten points with similar times into a single point.
|
|||
log|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -434,7 +435,7 @@ Example:
|
|||
log|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -445,7 +446,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
log|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -457,7 +458,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
log|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -472,7 +473,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
log|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -485,7 +486,7 @@ endpoint property method.
|
|||
log|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -496,7 +497,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
log|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -507,7 +508,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
log|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -518,7 +519,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
log|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -529,7 +530,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
log|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -540,7 +541,7 @@ Select the last point.
|
|||
log|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -551,7 +552,7 @@ Create a node that logs all data it receives.
|
|||
log|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -562,7 +563,7 @@ Select the maximum point.
|
|||
log|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -573,7 +574,7 @@ Compute the mean of the data.
|
|||
log|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -587,7 +588,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
log|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -598,7 +599,7 @@ Select the minimum point.
|
|||
log|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -609,7 +610,7 @@ Compute the mode of the data.
|
|||
log|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -621,7 +622,7 @@ No points are emitted until the window is full.
|
|||
log|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -632,7 +633,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
log|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -645,7 +646,7 @@ One point will be emitted every count or duration specified.
|
|||
log|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -656,7 +657,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
log|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -667,7 +668,7 @@ Create a node that can load data from external sources.
|
|||
log|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -678,7 +679,7 @@ Compute the difference between `min` and `max` points.
|
|||
log|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -689,7 +690,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
log|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -700,7 +701,7 @@ Create a node that tracks duration in a given state.
|
|||
log|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -713,7 +714,7 @@ This means the interval time is independent of the times of the data points the
|
|||
log|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -724,7 +725,7 @@ Compute the standard deviation.
|
|||
log|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -735,7 +736,7 @@ Compute the sum of all values.
|
|||
log|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -746,7 +747,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
log|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -757,7 +758,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
log|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -767,7 +768,7 @@ Create a new node that converts batch data to stream data.
|
|||
log|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -778,7 +779,7 @@ Perform the union of this node and all other given nodes.
|
|||
log|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -789,7 +790,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
log|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -802,4 +803,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
log|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -1,13 +1,16 @@
|
|||
---
|
||||
title: NoOpNode
|
||||
dnote: Auto generated by tickdoc
|
||||
|
||||
description: >
|
||||
The `noOp` node does not perform any operation.
|
||||
note: Auto generated by tickdoc
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: NoOpNode
|
||||
identifier: no_op_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/no_op_node/
|
||||
---
|
||||
|
||||
The `noOp` node does not perform any operation.
|
||||
|
|
@ -15,9 +18,9 @@ The `noOp` node does not perform any operation.
|
|||
> Do not use this node in a TICKscript. There should be no need for it.
|
||||
|
||||
If a node does not have any children, then its emitted count remains zero.
|
||||
Using a [NoOpNode](/kapacitor/v1/nodes/no_op_node/) is a work around so that statistics are accurately reported
|
||||
Using a [NoOpNode](/kapacitor/v1/reference/nodes/no_op_node/) is a work around so that statistics are accurately reported
|
||||
for nodes with no real children.
|
||||
A [NoOpNode](/kapacitor/v1/nodes/no_op_node/) is automatically appended to any node that is a source for a [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
A [NoOpNode](/kapacitor/v1/reference/nodes/no_op_node/) is automatically appended to any node that is a source for a [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
and does not have any children.
|
||||
|
||||
|
||||
|
|
@ -122,7 +125,7 @@ Create an alert node, which can trigger alerts.
|
|||
noOp|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -135,7 +138,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
noOp|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -146,7 +149,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
noOp|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -156,7 +159,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
noOp|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -167,7 +170,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
noOp|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -178,7 +181,7 @@ Count the number of points.
|
|||
noOp|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -190,7 +193,7 @@ A point is emitted for every point collected.
|
|||
noOp|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -236,7 +239,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -273,7 +276,7 @@ Example:
|
|||
noOp|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -284,7 +287,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
noOp|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -295,7 +298,7 @@ Create a node that can delete tags or fields.
|
|||
noOp|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -306,7 +309,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
noOp|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -317,7 +320,7 @@ Compute the difference between points independent of elapsed time.
|
|||
noOp|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -328,7 +331,7 @@ Produce batch of only the distinct points.
|
|||
noOp|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -339,7 +342,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
noOp|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -350,7 +353,7 @@ Compute the elapsed time between points.
|
|||
noOp|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -363,7 +366,7 @@ The results are available to later expressions.
|
|||
noOp|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -374,7 +377,7 @@ Select the first point.
|
|||
noOp|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -385,7 +388,7 @@ Flatten points with similar times into a single point.
|
|||
noOp|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -405,7 +408,7 @@ Example:
|
|||
noOp|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -416,7 +419,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
noOp|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -428,7 +431,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
noOp|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -443,7 +446,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
noOp|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -456,7 +459,7 @@ endpoint property method.
|
|||
noOp|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -467,7 +470,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
noOp|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -478,7 +481,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
noOp|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -489,7 +492,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
noOp|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -500,7 +503,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
noOp|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -511,7 +514,7 @@ Select the last point.
|
|||
noOp|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -522,7 +525,7 @@ Create a node that logs all data it receives.
|
|||
noOp|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -533,7 +536,7 @@ Select the maximum point.
|
|||
noOp|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -544,7 +547,7 @@ Compute the mean of the data.
|
|||
noOp|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -558,7 +561,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
noOp|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -569,7 +572,7 @@ Select the minimum point.
|
|||
noOp|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -580,7 +583,7 @@ Compute the mode of the data.
|
|||
noOp|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -592,7 +595,7 @@ No points are emitted until the window is full.
|
|||
noOp|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -603,7 +606,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
noOp|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -616,7 +619,7 @@ One point will be emitted every count or duration specified.
|
|||
noOp|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -627,7 +630,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
noOp|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -638,7 +641,7 @@ Create a node that can load data from external sources.
|
|||
noOp|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -649,7 +652,7 @@ Compute the difference between `min` and `max` points.
|
|||
noOp|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -660,7 +663,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
noOp|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -671,7 +674,7 @@ Create a node that tracks duration in a given state.
|
|||
noOp|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -684,7 +687,7 @@ This means the interval time is independent of the times of the data points the
|
|||
noOp|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -695,7 +698,7 @@ Compute the standard deviation.
|
|||
noOp|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -706,7 +709,7 @@ Compute the sum of all values.
|
|||
noOp|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -717,7 +720,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
noOp|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -728,7 +731,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
noOp|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -738,7 +741,7 @@ Create a new node that converts batch data to stream data.
|
|||
noOp|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -749,7 +752,7 @@ Perform the union of this node and all other given nodes.
|
|||
noOp|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -760,7 +763,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
noOp|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -773,4 +776,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
noOp|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -4,10 +4,12 @@ description: >
|
|||
QueryFluxNode defines a source and a schedule for processing batch data.
|
||||
The data is queried from an InfluxDB bucket and then passed into the data pipeline.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: QueryFluxNode
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/query_flux_node/
|
||||
---
|
||||
|
||||
The `queryFlux` node defines a source and a schedule for processing batch data.
|
||||
|
|
@ -116,8 +118,8 @@ Property methods are marked using the `.` operator.
|
|||
|
||||
### Align
|
||||
|
||||
Align start and stop times for queries with even boundaries of the [QueryFluxNode.Every](/kapacitor/v1/nodes/query_node/#every) property.
|
||||
Does not apply if using the [QueryFluxNode.Cron](/kapacitor/v1/nodes/query_node/#cron) property.
|
||||
Align start and stop times for queries with even boundaries of the [QueryFluxNode.Every](/kapacitor/v1/reference/nodes/query_node/#every) property.
|
||||
Does not apply if using the [QueryFluxNode.Cron](/kapacitor/v1/reference/nodes/query_node/#cron) property.
|
||||
|
||||
|
||||
```js
|
||||
|
|
@ -222,7 +224,7 @@ Create an alert node, which can trigger alerts.
|
|||
queryFlux|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -235,7 +237,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
queryFlux|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -246,7 +248,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
queryFlux|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -256,7 +258,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
queryFlux|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -267,7 +269,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
queryFlux|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -278,7 +280,7 @@ Count the number of points.
|
|||
queryFlux|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -290,7 +292,7 @@ A point is emitted for every point collected.
|
|||
queryFlux|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -336,7 +338,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -373,7 +375,7 @@ Example:
|
|||
queryFlux|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -384,7 +386,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
queryFlux|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -395,7 +397,7 @@ Create a node that can delete tags or fields.
|
|||
queryFlux|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -406,7 +408,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
queryFlux|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -417,7 +419,7 @@ Compute the difference between points independent of elapsed time.
|
|||
queryFlux|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -428,7 +430,7 @@ Produce batch of only the distinct points.
|
|||
queryFlux|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -439,7 +441,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
queryFlux|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -450,7 +452,7 @@ Compute the elapsed time between points.
|
|||
queryFlux|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -463,7 +465,7 @@ The results are available to later expressions.
|
|||
queryFlux|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -474,7 +476,7 @@ Select the first point.
|
|||
queryFlux|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -485,7 +487,7 @@ Flatten points with similar times into a single point.
|
|||
queryFlux|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -496,7 +498,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
queryFlux|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -508,7 +510,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
queryFlux|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -523,7 +525,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
queryFlux|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -536,7 +538,7 @@ endpoint property method.
|
|||
queryFlux|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -547,7 +549,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
queryFlux|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -558,7 +560,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
queryFlux|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -569,7 +571,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
queryFlux|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -580,7 +582,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
queryFlux|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -591,7 +593,7 @@ Select the last point.
|
|||
queryFlux|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -602,7 +604,7 @@ Create a node that logs all data it receives.
|
|||
queryFlux|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -613,7 +615,7 @@ Select the maximum point.
|
|||
queryFlux|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -624,7 +626,7 @@ Compute the mean of the data.
|
|||
queryFlux|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -638,7 +640,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
queryFlux|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -649,7 +651,7 @@ Select the minimum point.
|
|||
queryFlux|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -660,7 +662,7 @@ Compute the mode of the data.
|
|||
queryFlux|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -672,7 +674,7 @@ No points are emitted until the window is full.
|
|||
queryFlux|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -683,7 +685,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
queryFlux|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -696,7 +698,7 @@ One point will be emitted every count or duration specified.
|
|||
queryFlux|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -707,7 +709,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
queryFlux|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -718,7 +720,7 @@ Create a node that can load data from external sources.
|
|||
queryFlux|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -729,7 +731,7 @@ Compute the difference between `min` and `max` points.
|
|||
queryFlux|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -740,7 +742,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
queryFlux|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -751,7 +753,7 @@ Create a node that tracks duration in a given state.
|
|||
queryFlux|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -764,7 +766,7 @@ This means the interval time is independent of the times of the data points the
|
|||
queryFlux|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -775,7 +777,7 @@ Compute the standard deviation.
|
|||
queryFlux|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -786,7 +788,7 @@ Compute the sum of all values.
|
|||
queryFlux|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -797,7 +799,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
queryFlux|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -808,7 +810,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
queryFlux|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -818,7 +820,7 @@ Create a new node that converts batch data to stream data.
|
|||
queryFlux|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -829,7 +831,7 @@ Perform the union of this node and all other given nodes.
|
|||
queryFlux|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -840,7 +842,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
queryFlux|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -853,4 +855,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
queryFlux|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: QueryNode
|
|||
description: >
|
||||
QueryNode defines a source and a schedule for processing batch data. The data is queried from an InfluxDB database and then passed into the data pipeline.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: QueryNode
|
||||
identifier: query_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/query_node/
|
||||
---
|
||||
|
||||
The `query` node defines a source and a schedule for processing batch data. Data is queried from InfluxDB, computed by the `query` node, and then passed into the data pipeline.
|
||||
|
|
@ -147,8 +148,8 @@ Property methods are marked using the `.` operator.
|
|||
|
||||
### Align
|
||||
|
||||
Align start and stop times for queries with even boundaries of the [QueryNode.Every](/kapacitor/v1/nodes/query_node/#every) property.
|
||||
Does not apply if using the [QueryNode.Cron](/kapacitor/v1/nodes/query_node/#cron) property.
|
||||
Align start and stop times for queries with even boundaries of the [QueryNode.Every](/kapacitor/v1/reference/nodes/query_node/#every) property.
|
||||
Does not apply if using the [QueryNode.Cron](/kapacitor/v1/reference/nodes/query_node/#cron) property.
|
||||
|
||||
|
||||
```js
|
||||
|
|
@ -258,10 +259,10 @@ Example:
|
|||
.offset(5s)
|
||||
```
|
||||
|
||||
It is recommended to use [QueryNode.Align](/kapacitor/v1/nodes/query_node/#align) and [QueryNode.Offset](/kapacitor/v1/nodes/query_node/#offset) in conjunction with
|
||||
It is recommended to use [QueryNode.Align](/kapacitor/v1/reference/nodes/query_node/#align) and [QueryNode.Offset](/kapacitor/v1/reference/nodes/query_node/#offset) in conjunction with
|
||||
group by time dimensions so that the time bounds match up with the group by intervals.
|
||||
To automatically align the group by intervals to the start of the query time,
|
||||
use [QueryNode.AlignGroup.](/kapacitor/v1/nodes/query_node/#aligngroup) This is useful in more complex situations, such as when
|
||||
use [QueryNode.AlignGroup.](/kapacitor/v1/reference/nodes/query_node/#aligngroup) This is useful in more complex situations, such as when
|
||||
the groupBy time period is longer than the query frequency.
|
||||
|
||||
Example:
|
||||
|
|
@ -277,15 +278,15 @@ Example:
|
|||
.alignGroup()
|
||||
```
|
||||
|
||||
For the above example, without [QueryNode.AlignGroup,](/kapacitor/v1/nodes/query_node/#aligngroup) every other query issued by Kapacitor
|
||||
For the above example, without [QueryNode.AlignGroup,](/kapacitor/v1/reference/nodes/query_node/#aligngroup) every other query issued by Kapacitor
|
||||
(at :30 past the minute) will align to :00 seconds instead of the desired :30 seconds,
|
||||
which would create 6 group by intervals instead of 5, the first and last of which
|
||||
would only have 30 seconds of data instead of a full minute.
|
||||
If the group by time offset (i.e. time(t, offset)) is used in conjunction with
|
||||
[QueryNode.AlignGroup,](/kapacitor/v1/nodes/query_node/#aligngroup) the alignment will occur first, and will be offset
|
||||
[QueryNode.AlignGroup,](/kapacitor/v1/reference/nodes/query_node/#aligngroup) the alignment will occur first, and will be offset
|
||||
the specified amount after.
|
||||
|
||||
NOTE: Since [QueryNode.Offset](/kapacitor/v1/nodes/query_node/#offset) is inherently a negative property the second "offset" argument to the "time" function is negative to match.
|
||||
NOTE: Since [QueryNode.Offset](/kapacitor/v1/reference/nodes/query_node/#offset) is inherently a negative property the second "offset" argument to the "time" function is negative to match.
|
||||
|
||||
|
||||
|
||||
|
|
@ -370,7 +371,7 @@ Create an alert node, which can trigger alerts.
|
|||
query|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -383,7 +384,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
query|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -394,7 +395,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
query|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -404,7 +405,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
query|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -415,7 +416,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
query|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -426,7 +427,7 @@ Count the number of points.
|
|||
query|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -438,7 +439,7 @@ A point is emitted for every point collected.
|
|||
query|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -484,7 +485,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -521,7 +522,7 @@ Example:
|
|||
query|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -532,7 +533,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
query|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -543,7 +544,7 @@ Create a node that can delete tags or fields.
|
|||
query|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -554,7 +555,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
query|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -565,7 +566,7 @@ Compute the difference between points independent of elapsed time.
|
|||
query|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -576,7 +577,7 @@ Produce batch of only the distinct points.
|
|||
query|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -587,7 +588,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
query|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -598,7 +599,7 @@ Compute the elapsed time between points.
|
|||
query|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -611,7 +612,7 @@ The results are available to later expressions.
|
|||
query|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -622,7 +623,7 @@ Select the first point.
|
|||
query|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -633,7 +634,7 @@ Flatten points with similar times into a single point.
|
|||
query|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -644,7 +645,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
query|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -656,7 +657,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
query|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -671,7 +672,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
query|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -684,7 +685,7 @@ endpoint property method.
|
|||
query|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -695,7 +696,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
query|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -706,7 +707,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
query|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -717,7 +718,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
query|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -728,7 +729,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
query|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -739,7 +740,7 @@ Select the last point.
|
|||
query|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -750,7 +751,7 @@ Create a node that logs all data it receives.
|
|||
query|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -761,7 +762,7 @@ Select the maximum point.
|
|||
query|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -772,7 +773,7 @@ Compute the mean of the data.
|
|||
query|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -786,7 +787,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
query|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -797,7 +798,7 @@ Select the minimum point.
|
|||
query|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -808,7 +809,7 @@ Compute the mode of the data.
|
|||
query|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -820,7 +821,7 @@ No points are emitted until the window is full.
|
|||
query|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -831,7 +832,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
query|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -844,7 +845,7 @@ One point will be emitted every count or duration specified.
|
|||
query|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -855,7 +856,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
query|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -866,7 +867,7 @@ Create a node that can load data from external sources.
|
|||
query|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -877,7 +878,7 @@ Compute the difference between `min` and `max` points.
|
|||
query|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -888,7 +889,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
query|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -899,7 +900,7 @@ Create a node that tracks duration in a given state.
|
|||
query|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -912,7 +913,7 @@ This means the interval time is independent of the times of the data points the
|
|||
query|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -923,7 +924,7 @@ Compute the standard deviation.
|
|||
query|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -934,7 +935,7 @@ Compute the sum of all values.
|
|||
query|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -945,7 +946,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
query|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -956,7 +957,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
query|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -966,7 +967,7 @@ Create a new node that converts batch data to stream data.
|
|||
query|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -977,7 +978,7 @@ Perform the union of this node and all other given nodes.
|
|||
query|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -988,7 +989,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
query|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -1001,4 +1002,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
query|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: SampleNode
|
|||
description: >
|
||||
SampleNode samples points or batches. One point will be emitted every count or duration specified.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: SampleNode
|
||||
identifier: sample_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/sample_node/
|
||||
---
|
||||
|
||||
The `sample` node samples points or batches.
|
||||
|
|
@ -33,7 +34,7 @@ stream
|
|||
```
|
||||
|
||||
Keep only samples that land on the 10s boundary.
|
||||
See [FromNode.Truncate,](/kapacitor/v1/nodes/from_node/#truncate) [QueryNode.GroupBy](/kapacitor/v1/nodes/query_node/#groupby) time or [WindowNode.Align](/kapacitor/v1/nodes/window_node/#align)
|
||||
See [FromNode.Truncate,](/kapacitor/v1/reference/nodes/from_node/#truncate) [QueryNode.GroupBy](/kapacitor/v1/reference/nodes/query_node/#groupby) time or [WindowNode.Align](/kapacitor/v1/reference/nodes/window_node/#align)
|
||||
for ensuring data is aligned with a boundary.
|
||||
|
||||
|
||||
|
|
@ -137,7 +138,7 @@ Create an alert node, which can trigger alerts.
|
|||
sample|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -150,7 +151,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
sample|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -161,7 +162,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
sample|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -171,7 +172,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
sample|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -182,7 +183,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
sample|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -193,7 +194,7 @@ Count the number of points.
|
|||
sample|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -205,7 +206,7 @@ A point is emitted for every point collected.
|
|||
sample|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -251,7 +252,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -288,7 +289,7 @@ Example:
|
|||
sample|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -299,7 +300,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
sample|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -310,7 +311,7 @@ Create a node that can delete tags or fields.
|
|||
sample|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -321,7 +322,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
sample|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -332,7 +333,7 @@ Compute the difference between points independent of elapsed time.
|
|||
sample|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -343,7 +344,7 @@ Produce batch of only the distinct points.
|
|||
sample|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -354,7 +355,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
sample|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -365,7 +366,7 @@ Compute the elapsed time between points.
|
|||
sample|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -378,7 +379,7 @@ The results are available to later expressions.
|
|||
sample|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -389,7 +390,7 @@ Select the first point.
|
|||
sample|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -400,7 +401,7 @@ Flatten points with similar times into a single point.
|
|||
sample|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -420,7 +421,7 @@ Example:
|
|||
sample|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -431,7 +432,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
sample|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -443,7 +444,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
sample|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -458,7 +459,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
sample|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -471,7 +472,7 @@ endpoint property method.
|
|||
sample|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -482,7 +483,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
sample|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -493,7 +494,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
sample|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -504,7 +505,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
sample|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -515,7 +516,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
sample|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -526,7 +527,7 @@ Select the last point.
|
|||
sample|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -537,7 +538,7 @@ Create a node that logs all data it receives.
|
|||
sample|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -548,7 +549,7 @@ Select the maximum point.
|
|||
sample|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -559,7 +560,7 @@ Compute the mean of the data.
|
|||
sample|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -573,7 +574,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
sample|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -584,7 +585,7 @@ Select the minimum point.
|
|||
sample|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -595,7 +596,7 @@ Compute the mode of the data.
|
|||
sample|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -607,7 +608,7 @@ No points are emitted until the window is full.
|
|||
sample|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -618,7 +619,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
sample|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -631,7 +632,7 @@ One point will be emitted every count or duration specified.
|
|||
sample|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -642,7 +643,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
sample|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -653,7 +654,7 @@ Create a node that can load data from external sources.
|
|||
sample|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -664,7 +665,7 @@ Compute the difference between `min` and `max` points.
|
|||
sample|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -675,7 +676,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
sample|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -686,7 +687,7 @@ Create a node that tracks duration in a given state.
|
|||
sample|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -699,7 +700,7 @@ This means the interval time is independent of the times of the data points the
|
|||
sample|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -710,7 +711,7 @@ Compute the standard deviation.
|
|||
sample|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -721,7 +722,7 @@ Compute the sum of all values.
|
|||
sample|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -732,7 +733,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
sample|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -743,7 +744,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
sample|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -753,7 +754,7 @@ Create a new node that converts batch data to stream data.
|
|||
sample|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -764,7 +765,7 @@ Perform the union of this node and all other given nodes.
|
|||
sample|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -775,7 +776,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
sample|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -788,4 +789,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
sample|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: ShiftNode
|
|||
description: >
|
||||
ShiftNode shifts points and batches in time. This is useful for comparing batches or points from different times.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: ShiftNode
|
||||
identifier: shift_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/shift_node/
|
||||
---
|
||||
|
||||
The `shift` node shifts points and batches in time.
|
||||
|
|
@ -136,7 +137,7 @@ Create an alert node, which can trigger alerts.
|
|||
shift|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -149,7 +150,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
shift|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -160,7 +161,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
shift|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -170,7 +171,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
shift|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -181,7 +182,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
shift|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -192,7 +193,7 @@ Count the number of points.
|
|||
shift|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -204,7 +205,7 @@ A point is emitted for every point collected.
|
|||
shift|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -250,7 +251,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -287,7 +288,7 @@ Example:
|
|||
shift|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -298,7 +299,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
shift|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -309,7 +310,7 @@ Create a node that can delete tags or fields.
|
|||
shift|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -320,7 +321,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
shift|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -331,7 +332,7 @@ Compute the difference between points independent of elapsed time.
|
|||
shift|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -342,7 +343,7 @@ Produce batch of only the distinct points.
|
|||
shift|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -353,7 +354,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
shift|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -364,7 +365,7 @@ Compute the elapsed time between points.
|
|||
shift|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -377,7 +378,7 @@ The results are available to later expressions.
|
|||
shift|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -388,7 +389,7 @@ Select the first point.
|
|||
shift|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -399,7 +400,7 @@ Flatten points with similar times into a single point.
|
|||
shift|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -419,7 +420,7 @@ Example:
|
|||
shift|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -430,7 +431,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
shift|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -442,7 +443,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
shift|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -457,7 +458,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
shift|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -470,7 +471,7 @@ endpoint property method.
|
|||
shift|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -481,7 +482,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
shift|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -492,7 +493,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
shift|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -503,7 +504,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
shift|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -514,7 +515,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
shift|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -525,7 +526,7 @@ Select the last point.
|
|||
shift|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -536,7 +537,7 @@ Create a node that logs all data it receives.
|
|||
shift|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -547,7 +548,7 @@ Select the maximum point.
|
|||
shift|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -558,7 +559,7 @@ Compute the mean of the data.
|
|||
shift|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -572,7 +573,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
shift|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -583,7 +584,7 @@ Select the minimum point.
|
|||
shift|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -594,7 +595,7 @@ Compute the mode of the data.
|
|||
shift|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -606,7 +607,7 @@ No points are emitted until the window is full.
|
|||
shift|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -617,7 +618,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
shift|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -630,7 +631,7 @@ One point will be emitted every count or duration specified.
|
|||
shift|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -641,7 +642,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
shift|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -652,7 +653,7 @@ Create a node that can load data from external sources.
|
|||
shift|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -663,7 +664,7 @@ Compute the difference between `min` and `max` points.
|
|||
shift|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -674,7 +675,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
shift|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -685,7 +686,7 @@ Create a node that tracks duration in a given state.
|
|||
shift|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -698,7 +699,7 @@ This means the interval time is independent of the times of the data points the
|
|||
shift|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -709,7 +710,7 @@ Compute the standard deviation.
|
|||
shift|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -720,7 +721,7 @@ Compute the sum of all values.
|
|||
shift|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -731,7 +732,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
shift|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -742,7 +743,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
shift|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -752,7 +753,7 @@ Create a new node that converts batch data to stream data.
|
|||
shift|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -763,7 +764,7 @@ Perform the union of this node and all other given nodes.
|
|||
shift|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -774,7 +775,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
shift|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -787,4 +788,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
shift|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: SideloadNode
|
|||
description: >
|
||||
SideloadNode adds fields and tags to points based on hierarchical data from various sources.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: SideloadNode
|
||||
identifier: sideload_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/sideload_node/
|
||||
---
|
||||
|
||||
The `sideload` node adds fields and tags to points based on hierarchical data from various sources.
|
||||
|
|
@ -233,7 +234,7 @@ Create an alert node, which can trigger alerts.
|
|||
sideload|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -246,7 +247,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
sideload|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -257,7 +258,7 @@ 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](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -267,7 +268,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
sideload|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -278,7 +279,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
sideload|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -289,7 +290,7 @@ Count the number of points.
|
|||
sideload|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -301,7 +302,7 @@ A point is emitted for every point collected.
|
|||
sideload|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -347,7 +348,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -384,7 +385,7 @@ Example:
|
|||
sideload|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -395,7 +396,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
sideload|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -406,7 +407,7 @@ Create a node that can delete tags or fields.
|
|||
sideload|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -417,7 +418,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
sideload|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -428,7 +429,7 @@ Compute the difference between points independent of elapsed time.
|
|||
sideload|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -439,7 +440,7 @@ Produce batch of only the distinct points.
|
|||
sideload|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -450,7 +451,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
sideload|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -461,7 +462,7 @@ Compute the elapsed time between points.
|
|||
sideload|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -474,7 +475,7 @@ The results are available to later expressions.
|
|||
sideload|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -485,7 +486,7 @@ Select the first point.
|
|||
sideload|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -496,7 +497,7 @@ Flatten points with similar times into a single point.
|
|||
sideload|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -516,7 +517,7 @@ Example:
|
|||
sideload|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -527,7 +528,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
sideload|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -539,7 +540,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
sideload|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -554,7 +555,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
sideload|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -567,7 +568,7 @@ endpoint property method.
|
|||
sideload|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -578,7 +579,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
sideload|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -589,7 +590,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
sideload|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -600,7 +601,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
sideload|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -611,7 +612,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
sideload|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -622,7 +623,7 @@ Select the last point.
|
|||
sideload|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -633,7 +634,7 @@ Create a node that logs all data it receives.
|
|||
sideload|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -644,7 +645,7 @@ Select the maximum point.
|
|||
sideload|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -655,7 +656,7 @@ Compute the mean of the data.
|
|||
sideload|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -669,7 +670,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
sideload|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -680,7 +681,7 @@ Select the minimum point.
|
|||
sideload|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -691,7 +692,7 @@ Compute the mode of the data.
|
|||
sideload|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -703,7 +704,7 @@ No points are emitted until the window is full.
|
|||
sideload|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -714,7 +715,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
sideload|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -727,7 +728,7 @@ One point will be emitted every count or duration specified.
|
|||
sideload|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -738,7 +739,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
sideload|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -749,7 +750,7 @@ Create a node that can load data from external sources.
|
|||
sideload|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -760,7 +761,7 @@ Compute the difference between `min` and `max` points.
|
|||
sideload|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -771,7 +772,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
sideload|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -782,7 +783,7 @@ Create a node that tracks duration in a given state.
|
|||
sideload|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -795,7 +796,7 @@ This means the interval time is independent of the times of the data points the
|
|||
sideload|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -806,7 +807,7 @@ Compute the standard deviation.
|
|||
sideload|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -817,7 +818,7 @@ Compute the sum of all values.
|
|||
sideload|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -828,7 +829,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
sideload|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -839,7 +840,7 @@ 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](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -849,7 +850,7 @@ Create a new node that converts batch data to stream data.
|
|||
sideload|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -860,7 +861,7 @@ Perform the union of this node and all other given nodes.
|
|||
sideload|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -871,7 +872,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
sideload|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -884,4 +885,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
sideload|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: StateCountNode
|
|||
description: >
|
||||
StateCountNode computes the number of consecutive points in a given state (defined using a lambda expression).
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: StateCountNode
|
||||
identifier: state_count_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/state_count_node/
|
||||
---
|
||||
|
||||
The `stateCount` node computes the number of consecutive points in a given state.
|
||||
|
|
@ -155,7 +156,7 @@ Create an alert node, which can trigger alerts.
|
|||
stateCount|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -168,7 +169,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
stateCount|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -179,7 +180,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
stateCount|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -189,7 +190,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
stateCount|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -200,7 +201,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
stateCount|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -211,7 +212,7 @@ Count the number of points.
|
|||
stateCount|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -223,7 +224,7 @@ A point is emitted for every point collected.
|
|||
stateCount|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -269,7 +270,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -306,7 +307,7 @@ Example:
|
|||
stateCount|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -317,7 +318,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
stateCount|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -328,7 +329,7 @@ Create a node that can delete tags or fields.
|
|||
stateCount|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -339,7 +340,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
stateCount|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -350,7 +351,7 @@ Compute the difference between points independent of elapsed time.
|
|||
stateCount|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -361,7 +362,7 @@ Produce batch of only the distinct points.
|
|||
stateCount|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -372,7 +373,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
stateCount|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -383,7 +384,7 @@ Compute the elapsed time between points.
|
|||
stateCount|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -396,7 +397,7 @@ The results are available to later expressions.
|
|||
stateCount|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -407,7 +408,7 @@ Select the first point.
|
|||
stateCount|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -418,7 +419,7 @@ Flatten points with similar times into a single point.
|
|||
stateCount|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -438,7 +439,7 @@ Example:
|
|||
stateCount|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -449,7 +450,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
stateCount|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -461,7 +462,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
stateCount|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -476,7 +477,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
stateCount|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -489,7 +490,7 @@ endpoint property method.
|
|||
stateCount|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -500,7 +501,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
stateCount|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -511,7 +512,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
stateCount|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -522,7 +523,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
stateCount|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -533,7 +534,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
stateCount|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -544,7 +545,7 @@ Select the last point.
|
|||
stateCount|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -555,7 +556,7 @@ Create a node that logs all data it receives.
|
|||
stateCount|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -566,7 +567,7 @@ Select the maximum point.
|
|||
stateCount|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -577,7 +578,7 @@ Compute the mean of the data.
|
|||
stateCount|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -591,7 +592,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
stateCount|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -602,7 +603,7 @@ Select the minimum point.
|
|||
stateCount|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -613,7 +614,7 @@ Compute the mode of the data.
|
|||
stateCount|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -625,7 +626,7 @@ No points are emitted until the window is full.
|
|||
stateCount|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -636,7 +637,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
stateCount|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -649,7 +650,7 @@ One point will be emitted every count or duration specified.
|
|||
stateCount|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -660,7 +661,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
stateCount|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -671,7 +672,7 @@ Create a node that can load data from external sources.
|
|||
stateCount|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -682,7 +683,7 @@ Compute the difference between `min` and `max` points.
|
|||
stateCount|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -693,7 +694,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
stateCount|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -704,7 +705,7 @@ Create a node that tracks duration in a given state.
|
|||
stateCount|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -717,7 +718,7 @@ This means the interval time is independent of the times of the data points the
|
|||
stateCount|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -728,7 +729,7 @@ Compute the standard deviation.
|
|||
stateCount|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -739,7 +740,7 @@ Compute the sum of all values.
|
|||
stateCount|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -750,7 +751,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
stateCount|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -761,7 +762,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
stateCount|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -771,7 +772,7 @@ Create a new node that converts batch data to stream data.
|
|||
stateCount|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -782,7 +783,7 @@ Perform the union of this node and all other given nodes.
|
|||
stateCount|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -793,7 +794,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
stateCount|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -806,4 +807,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
stateCount|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: StateDurationNode
|
|||
description: >
|
||||
StateDurationNode computes the duration of a given state (defined using a lambda expression).
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: StateDurationNode
|
||||
identifier: state_duration_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/state_duration_node/
|
||||
---
|
||||
|
||||
The `stateDuration` node computes the duration of a given state.
|
||||
|
|
@ -177,7 +178,7 @@ Create an alert node, which can trigger alerts.
|
|||
stateDuration|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -190,7 +191,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
stateDuration|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -201,7 +202,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
stateDuration|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -211,7 +212,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
stateDuration|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -222,7 +223,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
stateDuration|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -233,7 +234,7 @@ Count the number of points.
|
|||
stateDuration|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -245,7 +246,7 @@ A point is emitted for every point collected.
|
|||
stateDuration|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -291,7 +292,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -328,7 +329,7 @@ Example:
|
|||
stateDuration|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -339,7 +340,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
stateDuration|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -350,7 +351,7 @@ Create a node that can delete tags or fields.
|
|||
stateDuration|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -361,7 +362,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
stateDuration|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -372,7 +373,7 @@ Compute the difference between points independent of elapsed time.
|
|||
stateDuration|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -383,7 +384,7 @@ Produce batch of only the distinct points.
|
|||
stateDuration|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -394,7 +395,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
stateDuration|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -405,7 +406,7 @@ Compute the elapsed time between points.
|
|||
stateDuration|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -418,7 +419,7 @@ The results are available to later expressions.
|
|||
stateDuration|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -429,7 +430,7 @@ Select the first point.
|
|||
stateDuration|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -440,7 +441,7 @@ Flatten points with similar times into a single point.
|
|||
stateDuration|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -460,7 +461,7 @@ Example:
|
|||
stateDuration|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -471,7 +472,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
stateDuration|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -483,7 +484,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
stateDuration|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -498,7 +499,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
stateDuration|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -511,7 +512,7 @@ endpoint property method.
|
|||
stateDuration|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -522,7 +523,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
stateDuration|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -533,7 +534,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
stateDuration|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -544,7 +545,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
stateDuration|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -555,7 +556,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
stateDuration|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -566,7 +567,7 @@ Select the last point.
|
|||
stateDuration|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -577,7 +578,7 @@ Create a node that logs all data it receives.
|
|||
stateDuration|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -588,7 +589,7 @@ Select the maximum point.
|
|||
stateDuration|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -599,7 +600,7 @@ Compute the mean of the data.
|
|||
stateDuration|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -613,7 +614,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
stateDuration|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -624,7 +625,7 @@ Select the minimum point.
|
|||
stateDuration|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -635,7 +636,7 @@ Compute the mode of the data.
|
|||
stateDuration|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -647,7 +648,7 @@ No points are emitted until the window is full.
|
|||
stateDuration|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -658,7 +659,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
stateDuration|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -671,7 +672,7 @@ One point will be emitted every count or duration specified.
|
|||
stateDuration|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -682,7 +683,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
stateDuration|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -693,7 +694,7 @@ Create a node that can load data from external sources.
|
|||
stateDuration|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -704,7 +705,7 @@ Compute the difference between `min` and `max` points.
|
|||
stateDuration|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -715,7 +716,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
stateDuration|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -726,7 +727,7 @@ Create a node that tracks duration in a given state.
|
|||
stateDuration|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -739,7 +740,7 @@ This means the interval time is independent of the times of the data points the
|
|||
stateDuration|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -750,7 +751,7 @@ Compute the standard deviation.
|
|||
stateDuration|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -761,7 +762,7 @@ Compute the sum of all values.
|
|||
stateDuration|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -772,7 +773,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
stateDuration|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -783,7 +784,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
stateDuration|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -793,7 +794,7 @@ Create a new node that converts batch data to stream data.
|
|||
stateDuration|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -804,7 +805,7 @@ Perform the union of this node and all other given nodes.
|
|||
stateDuration|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -815,7 +816,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
stateDuration|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -828,4 +829,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
stateDuration|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,20 +3,21 @@ title: StatsNode
|
|||
description: >
|
||||
StreamNode emits internal statistics about another node at a given interval.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: StatsNode
|
||||
identifier: stats_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/stats_node/
|
||||
---
|
||||
|
||||
The `stats` node emits internal statistics about the 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](/kapacitor/v1/nodes/stats_node/) is a root node in the task pipeline.
|
||||
As a result the [StatsNode](/kapacitor/v1/reference/nodes/stats_node/) is a root node in the task pipeline.
|
||||
|
||||
|
||||
The currently available internal statistics:
|
||||
|
|
@ -163,7 +164,7 @@ Create an alert node, which can trigger alerts.
|
|||
stats|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -176,7 +177,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
stats|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -187,7 +188,7 @@ 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](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -197,7 +198,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
stats|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -208,7 +209,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
stats|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -219,7 +220,7 @@ Count the number of points.
|
|||
stats|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -231,7 +232,7 @@ A point is emitted for every point collected.
|
|||
stats|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -277,7 +278,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -314,7 +315,7 @@ Example:
|
|||
stats|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -325,7 +326,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
stats|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -336,7 +337,7 @@ Create a node that can delete tags or fields.
|
|||
stats|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -347,7 +348,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
stats|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -358,7 +359,7 @@ Compute the difference between points independent of elapsed time.
|
|||
stats|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -369,7 +370,7 @@ Produce batch of only the distinct points.
|
|||
stats|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -380,7 +381,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
stats|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -391,7 +392,7 @@ Compute the elapsed time between points.
|
|||
stats|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -404,7 +405,7 @@ The results are available to later expressions.
|
|||
stats|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -415,7 +416,7 @@ Select the first point.
|
|||
stats|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -426,7 +427,7 @@ Flatten points with similar times into a single point.
|
|||
stats|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -446,7 +447,7 @@ Example:
|
|||
stats|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -457,7 +458,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
stats|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -469,7 +470,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
stats|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -484,7 +485,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
stats|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -497,7 +498,7 @@ endpoint property method.
|
|||
stats|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -508,7 +509,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
stats|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -519,7 +520,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
stats|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -530,7 +531,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
stats|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -541,7 +542,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
stats|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -552,7 +553,7 @@ Select the last point.
|
|||
stats|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -563,7 +564,7 @@ Create a node that logs all data it receives.
|
|||
stats|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -574,7 +575,7 @@ Select the maximum point.
|
|||
stats|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -585,7 +586,7 @@ Compute the mean of the data.
|
|||
stats|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -599,7 +600,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
stats|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -610,7 +611,7 @@ Select the minimum point.
|
|||
stats|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -621,7 +622,7 @@ Compute the mode of the data.
|
|||
stats|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -633,7 +634,7 @@ No points are emitted until the window is full.
|
|||
stats|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -644,7 +645,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
stats|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -657,7 +658,7 @@ One point will be emitted every count or duration specified.
|
|||
stats|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -668,7 +669,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
stats|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -679,7 +680,7 @@ Create a node that can load data from external sources.
|
|||
stats|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -690,7 +691,7 @@ Compute the difference between `min` and `max` points.
|
|||
stats|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -701,7 +702,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
stats|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -712,7 +713,7 @@ Create a node that tracks duration in a given state.
|
|||
stats|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -725,7 +726,7 @@ This means the interval time is independent of the times of the data points the
|
|||
stats|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -736,7 +737,7 @@ Compute the standard deviation.
|
|||
stats|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -747,7 +748,7 @@ Compute the sum of all values.
|
|||
stats|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -758,7 +759,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
stats|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -769,7 +770,7 @@ 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](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -779,7 +780,7 @@ Create a new node that converts batch data to stream data.
|
|||
stats|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -790,7 +791,7 @@ Perform the union of this node and all other given nodes.
|
|||
stats|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -801,7 +802,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
stats|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -814,4 +815,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
stats|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,20 +3,21 @@ title: StreamNode
|
|||
description: >
|
||||
StreamNode represents the source of data being streamed to Kapacitor through any of its inputs.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: StreamNode
|
||||
identifier: stream_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/stream_node/
|
||||
---
|
||||
|
||||
The `stream` node represents the source of data being
|
||||
streamed to Kapacitor via any of its inputs.
|
||||
The `stream` variable in stream tasks is an instance of
|
||||
a [StreamNode.](/kapacitor/v1/nodes/stream_node/)
|
||||
[StreamNode.From](/kapacitor/v1/nodes/stream_node/#from) is the method/property of this node.
|
||||
a [StreamNode.](/kapacitor/v1/reference/nodes/stream_node/)
|
||||
[StreamNode.From](/kapacitor/v1/reference/nodes/stream_node/#from) is the method/property of this node.
|
||||
|
||||
|
||||
### Constructor
|
||||
|
|
@ -105,7 +106,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -142,11 +143,11 @@ Example:
|
|||
stream|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### From
|
||||
|
||||
Creates a new [FromNode](/kapacitor/v1/nodes/from_node/) that can be further
|
||||
Creates a new [FromNode](/kapacitor/v1/reference/nodes/from_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.
|
||||
|
|
@ -179,7 +180,7 @@ Example:
|
|||
stream|from()
|
||||
```
|
||||
|
||||
Returns: [FromNode](/kapacitor/v1/nodes/from_node/)
|
||||
Returns: [FromNode](/kapacitor/v1/reference/nodes/from_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -192,4 +193,4 @@ This means the interval time is independent of the times of the data points the
|
|||
stream|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
|
@ -3,16 +3,17 @@ title: SwarmAutoscaleNode
|
|||
description: >
|
||||
SwarmAutoscaleNode triggers autoscale events for a service on a Docker Swarm mode cluster and outputs points for the triggered events.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: SwarmAutoscaleNode
|
||||
identifier: swarm_autoscale_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/swarm_autoscale_node/
|
||||
---
|
||||
|
||||
[SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/) triggers autoscale events for a service on a Docker Swarm mode cluster.
|
||||
[SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/) triggers autoscale events for a service on a Docker Swarm mode cluster.
|
||||
The node also outputs points for the triggered events.
|
||||
|
||||
Example:
|
||||
|
|
@ -301,7 +302,7 @@ Create an alert node, which can trigger alerts.
|
|||
swarmAutoscale|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -314,7 +315,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
swarmAutoscale|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -325,7 +326,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
swarmAutoscale|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -335,7 +336,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
swarmAutoscale|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -346,7 +347,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
swarmAutoscale|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -357,7 +358,7 @@ Count the number of points.
|
|||
swarmAutoscale|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -369,7 +370,7 @@ A point is emitted for every point collected.
|
|||
swarmAutoscale|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -415,7 +416,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -452,7 +453,7 @@ Example:
|
|||
swarmAutoscale|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -463,7 +464,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
swarmAutoscale|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -474,7 +475,7 @@ Create a node that can delete tags or fields.
|
|||
swarmAutoscale|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -485,7 +486,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
swarmAutoscale|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -496,7 +497,7 @@ Compute the difference between points independent of elapsed time.
|
|||
swarmAutoscale|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -507,7 +508,7 @@ Produce batch of only the distinct points.
|
|||
swarmAutoscale|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -518,7 +519,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
swarmAutoscale|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -529,7 +530,7 @@ Compute the elapsed time between points.
|
|||
swarmAutoscale|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -542,7 +543,7 @@ The results are available to later expressions.
|
|||
swarmAutoscale|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -553,7 +554,7 @@ Select the first point.
|
|||
swarmAutoscale|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -564,7 +565,7 @@ Flatten points with similar times into a single point.
|
|||
swarmAutoscale|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -584,7 +585,7 @@ Example:
|
|||
swarmAutoscale|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -595,7 +596,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
swarmAutoscale|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -607,7 +608,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
swarmAutoscale|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -622,7 +623,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
swarmAutoscale|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -635,7 +636,7 @@ endpoint property method.
|
|||
swarmAutoscale|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -646,7 +647,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
swarmAutoscale|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -657,7 +658,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
swarmAutoscale|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -668,7 +669,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
swarmAutoscale|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -679,7 +680,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
swarmAutoscale|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -690,7 +691,7 @@ Select the last point.
|
|||
swarmAutoscale|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -701,7 +702,7 @@ Create a node that logs all data it receives.
|
|||
swarmAutoscale|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -712,7 +713,7 @@ Compute the mean of the data.
|
|||
swarmAutoscale|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -726,7 +727,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
swarmAutoscale|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -737,7 +738,7 @@ Compute the mode of the data.
|
|||
swarmAutoscale|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -749,7 +750,7 @@ No points are emitted until the window is full.
|
|||
swarmAutoscale|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -760,7 +761,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
swarmAutoscale|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -773,7 +774,7 @@ One point will be emitted every count or duration specified.
|
|||
swarmAutoscale|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -784,7 +785,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
swarmAutoscale|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -795,7 +796,7 @@ Create a node that can load data from external sources.
|
|||
swarmAutoscale|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -806,7 +807,7 @@ Compute the difference between `min` and `max` points.
|
|||
swarmAutoscale|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -817,7 +818,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
swarmAutoscale|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -828,7 +829,7 @@ Create a node that tracks duration in a given state.
|
|||
swarmAutoscale|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -841,7 +842,7 @@ This means the interval time is independent of the times of the data points the
|
|||
swarmAutoscale|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -852,7 +853,7 @@ Compute the standard deviation.
|
|||
swarmAutoscale|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -863,7 +864,7 @@ Compute the sum of all values.
|
|||
swarmAutoscale|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -874,7 +875,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
swarmAutoscale|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -885,7 +886,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
swarmAutoscale|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -895,7 +896,7 @@ Create a new node that converts batch data to stream data.
|
|||
swarmAutoscale|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -906,7 +907,7 @@ Perform the union of this node and all other given nodes.
|
|||
swarmAutoscale|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -917,7 +918,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
swarmAutoscale|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -930,4 +931,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
swarmAutoscale|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -4,11 +4,13 @@ description: >
|
|||
TrickleNode converts `from` batch edges to stream edges.
|
||||
Children of `trickle` are treated as if they are in a stream.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: TrickleNode
|
||||
identifier: trickle_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/trickle_node/
|
||||
---
|
||||
|
||||
The `trickle` node converts `from` batch edges to stream edges.
|
||||
|
|
@ -124,7 +126,7 @@ Create an alert node, which can trigger alerts.
|
|||
trickle|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -137,7 +139,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
trickle|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -147,7 +149,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
trickle|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -157,7 +159,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
trickle|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -168,7 +170,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
trickle|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -179,7 +181,7 @@ Count the number of points.
|
|||
trickle|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -191,7 +193,7 @@ A point is emitted for every point collected.
|
|||
trickle|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -237,7 +239,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -274,7 +276,7 @@ Example:
|
|||
trickle|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -285,7 +287,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
trickle|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -296,7 +298,7 @@ Create a node that can delete tags or fields.
|
|||
trickle|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -307,7 +309,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
trickle|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -318,7 +320,7 @@ Compute the difference between points independent of elapsed time.
|
|||
trickle|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -329,7 +331,7 @@ Produce batch of only the distinct points.
|
|||
trickle|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -340,7 +342,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
trickle|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -351,7 +353,7 @@ Compute the elapsed time between points.
|
|||
trickle|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -364,7 +366,7 @@ The results are available to later expressions.
|
|||
trickle|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -375,7 +377,7 @@ Select the first point.
|
|||
trickle|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -386,7 +388,7 @@ Flatten points with similar times into a single point.
|
|||
trickle|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -406,7 +408,7 @@ Example:
|
|||
trickle|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -417,7 +419,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
trickle|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -429,7 +431,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
trickle|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -444,7 +446,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
trickle|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -457,7 +459,7 @@ endpoint property method.
|
|||
trickle|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -468,7 +470,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
trickle|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -479,7 +481,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
trickle|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -490,7 +492,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
trickle|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -501,7 +503,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
trickle|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -512,7 +514,7 @@ Select the last point.
|
|||
trickle|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -523,7 +525,7 @@ Create a node that logs all data it receives.
|
|||
trickle|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -534,7 +536,7 @@ Select the maximum point.
|
|||
trickle|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -545,7 +547,7 @@ Compute the mean of the data.
|
|||
trickle|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -559,7 +561,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
trickle|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -570,7 +572,7 @@ Select the minimum point.
|
|||
trickle|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -581,7 +583,7 @@ Compute the mode of the data.
|
|||
trickle|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -593,7 +595,7 @@ No points are emitted until the window is full.
|
|||
trickle|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -604,7 +606,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
trickle|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -617,7 +619,7 @@ One point will be emitted every count or duration specified.
|
|||
trickle|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -628,7 +630,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
trickle|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -639,7 +641,7 @@ Create a node that can load data from external sources.
|
|||
trickle|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -650,7 +652,7 @@ Compute the difference between `min` and `max` points.
|
|||
trickle|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -661,7 +663,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
trickle|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -672,7 +674,7 @@ Create a node that tracks duration in a given state.
|
|||
trickle|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -685,7 +687,7 @@ This means the interval time is independent of the times of the data points the
|
|||
trickle|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -696,7 +698,7 @@ Compute the standard deviation.
|
|||
trickle|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -707,7 +709,7 @@ Compute the sum of all values.
|
|||
trickle|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -718,7 +720,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
trickle|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -729,7 +731,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
trickle|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -740,7 +742,7 @@ Perform the union of this node and all other given nodes.
|
|||
trickle|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -751,7 +753,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
trickle|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -764,4 +766,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
trickle|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -2,13 +2,14 @@
|
|||
title: UDFNode
|
||||
description: UDFNode runs a user defined function (UDF) in a separate process.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: UDFNode
|
||||
identifier: u_d_f_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/u_d_f_node/
|
||||
---
|
||||
|
||||
The `udf` node can run a User Defined Function (UDF) in a separate process.
|
||||
|
|
@ -166,7 +167,7 @@ Create an alert node, which can trigger alerts.
|
|||
uDF|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -179,7 +180,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
uDF|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -190,7 +191,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
uDF|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -200,7 +201,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
uDF|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -211,7 +212,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
uDF|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -222,7 +223,7 @@ Count the number of points.
|
|||
uDF|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -234,7 +235,7 @@ A point is emitted for every point collected.
|
|||
uDF|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -280,7 +281,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -317,7 +318,7 @@ Example:
|
|||
uDF|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -328,7 +329,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
uDF|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -339,7 +340,7 @@ Create a node that can delete tags or fields.
|
|||
uDF|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -350,7 +351,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
uDF|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -361,7 +362,7 @@ Compute the difference between points independent of elapsed time.
|
|||
uDF|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -372,7 +373,7 @@ Produce batch of only the distinct points.
|
|||
uDF|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -383,7 +384,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
uDF|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -394,7 +395,7 @@ Compute the elapsed time between points.
|
|||
uDF|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -407,7 +408,7 @@ The results are available to later expressions.
|
|||
uDF|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -418,7 +419,7 @@ Select the first point.
|
|||
uDF|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -429,7 +430,7 @@ Flatten points with similar times into a single point.
|
|||
uDF|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -449,7 +450,7 @@ Example:
|
|||
uDF|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -460,7 +461,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
uDF|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -472,7 +473,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
uDF|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -487,7 +488,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
uDF|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -500,7 +501,7 @@ endpoint property method.
|
|||
uDF|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -511,7 +512,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
uDF|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -522,7 +523,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
uDF|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -533,7 +534,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
uDF|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -544,7 +545,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
uDF|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -555,7 +556,7 @@ Select the last point.
|
|||
uDF|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -566,7 +567,7 @@ Create a node that logs all data it receives.
|
|||
uDF|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -577,7 +578,7 @@ Select the maximum point.
|
|||
uDF|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -588,7 +589,7 @@ Compute the mean of the data.
|
|||
uDF|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -602,7 +603,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
uDF|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -613,7 +614,7 @@ Select the minimum point.
|
|||
uDF|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -624,7 +625,7 @@ Compute the mode of the data.
|
|||
uDF|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -636,7 +637,7 @@ No points are emitted until the window is full.
|
|||
uDF|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -647,7 +648,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
uDF|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -660,7 +661,7 @@ One point will be emitted every count or duration specified.
|
|||
uDF|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -671,7 +672,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
uDF|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -682,7 +683,7 @@ Create a node that can load data from external sources.
|
|||
uDF|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -693,7 +694,7 @@ Compute the difference between `min` and `max` points.
|
|||
uDF|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -704,7 +705,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
uDF|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -715,7 +716,7 @@ Create a node that tracks duration in a given state.
|
|||
uDF|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -728,7 +729,7 @@ This means the interval time is independent of the times of the data points the
|
|||
uDF|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -739,7 +740,7 @@ Compute the standard deviation.
|
|||
uDF|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -750,7 +751,7 @@ Compute the sum of all values.
|
|||
uDF|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -761,7 +762,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
uDF|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -772,7 +773,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
uDF|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -782,7 +783,7 @@ Create a new node that converts batch data to stream data.
|
|||
uDF|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -793,7 +794,7 @@ Perform the union of this node and all other given nodes.
|
|||
uDF|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -804,7 +805,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
uDF|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -817,4 +818,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
uDF|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
|
|
@ -3,13 +3,14 @@ title: UnionNode
|
|||
description: >
|
||||
UnionNode takes the union of all of its parents as a simple pass-through. Data points received from each parent are passed to children nodes without modification.
|
||||
note: Auto generated by tickdoc
|
||||
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
kapacitor_v1:
|
||||
name: UnionNode
|
||||
identifier: union_node
|
||||
weight: 100
|
||||
parent: nodes
|
||||
aliases:
|
||||
- /kapacitor/v1/nodes/union_node/
|
||||
---
|
||||
|
||||
The `union` node takes the union of all of its parents as a simple pass through.
|
||||
|
|
@ -150,7 +151,7 @@ Create an alert node, which can trigger alerts.
|
|||
union|alert()
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Barrier
|
||||
|
||||
|
|
@ -163,7 +164,7 @@ One BarrierMessage will be emitted every period duration.
|
|||
union|barrier()
|
||||
```
|
||||
|
||||
Returns: [BarrierNode](/kapacitor/v1/nodes/barrier_node/)
|
||||
Returns: [BarrierNode](/kapacitor/v1/reference/nodes/barrier_node/)
|
||||
|
||||
### Bottom
|
||||
|
||||
|
|
@ -174,7 +175,7 @@ Select the bottom `num` points for `field` and sort by any extra tags or fields.
|
|||
union|bottom(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### ChangeDetect
|
||||
|
||||
|
|
@ -184,7 +185,7 @@ Create a new node that only emits new points if different from the previous poin
|
|||
union|changeDetect(field string)
|
||||
```
|
||||
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/nodes/change_detect_node/)
|
||||
Returns: [ChangeDetectNode](/kapacitor/v1/reference/nodes/change_detect_node/)
|
||||
|
||||
### Combine
|
||||
|
||||
|
|
@ -195,7 +196,7 @@ Combine this node with itself. The data is combined on timestamp.
|
|||
union|combine(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [CombineNode](/kapacitor/v1/nodes/combine_node/)
|
||||
Returns: [CombineNode](/kapacitor/v1/reference/nodes/combine_node/)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -206,7 +207,7 @@ Count the number of points.
|
|||
union|count(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### CumulativeSum
|
||||
|
||||
|
|
@ -218,7 +219,7 @@ A point is emitted for every point collected.
|
|||
union|cumulativeSum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Deadman
|
||||
|
||||
|
|
@ -264,7 +265,7 @@ The above is equivalent to this example:
|
|||
|
||||
The `id` and `message` alert properties can be configured globally via the 'deadman' configuration section.
|
||||
|
||||
Since the [AlertNode](/kapacitor/v1/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Since the [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual.
|
||||
Example:
|
||||
|
||||
|
||||
|
|
@ -301,7 +302,7 @@ Example:
|
|||
union|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [AlertNode](/kapacitor/v1/nodes/alert_node/)
|
||||
Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/)
|
||||
|
||||
### Default
|
||||
|
||||
|
|
@ -312,7 +313,7 @@ Create a node that can set defaults for missing tags or fields.
|
|||
union|default()
|
||||
```
|
||||
|
||||
Returns: [DefaultNode](/kapacitor/v1/nodes/default_node/)
|
||||
Returns: [DefaultNode](/kapacitor/v1/reference/nodes/default_node/)
|
||||
|
||||
### Delete
|
||||
|
||||
|
|
@ -323,7 +324,7 @@ Create a node that can delete tags or fields.
|
|||
union|delete()
|
||||
```
|
||||
|
||||
Returns: [DeleteNode](/kapacitor/v1/nodes/delete_node/)
|
||||
Returns: [DeleteNode](/kapacitor/v1/reference/nodes/delete_node/)
|
||||
|
||||
### Derivative
|
||||
|
||||
|
|
@ -334,7 +335,7 @@ Create a new node that computes the derivative of adjacent points.
|
|||
union|derivative(field string)
|
||||
```
|
||||
|
||||
Returns: [DerivativeNode](/kapacitor/v1/nodes/derivative_node/)
|
||||
Returns: [DerivativeNode](/kapacitor/v1/reference/nodes/derivative_node/)
|
||||
|
||||
### Difference
|
||||
|
||||
|
|
@ -345,7 +346,7 @@ Compute the difference between points independent of elapsed time.
|
|||
union|difference(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Distinct
|
||||
|
||||
|
|
@ -356,7 +357,7 @@ Produce batch of only the distinct points.
|
|||
union|distinct(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Ec2Autoscale
|
||||
|
||||
|
|
@ -367,7 +368,7 @@ Create a node that can trigger autoscale events for a ec2 autoscalegroup.
|
|||
union|ec2Autoscale()
|
||||
```
|
||||
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/nodes/ec2_autoscale_node/)
|
||||
Returns: [Ec2AutoscaleNode](/kapacitor/v1/reference/nodes/ec2_autoscale_node/)
|
||||
|
||||
### Elapsed
|
||||
|
||||
|
|
@ -378,7 +379,7 @@ Compute the elapsed time between points.
|
|||
union|elapsed(field string, unit time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Eval
|
||||
|
||||
|
|
@ -391,7 +392,7 @@ The results are available to later expressions.
|
|||
union|eval(expressions ...ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [EvalNode](/kapacitor/v1/nodes/eval_node/)
|
||||
Returns: [EvalNode](/kapacitor/v1/reference/nodes/eval_node/)
|
||||
|
||||
### First
|
||||
|
||||
|
|
@ -402,7 +403,7 @@ Select the first point.
|
|||
union|first(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Flatten
|
||||
|
||||
|
|
@ -413,7 +414,7 @@ Flatten points with similar times into a single point.
|
|||
union|flatten()
|
||||
```
|
||||
|
||||
Returns: [FlattenNode](/kapacitor/v1/nodes/flatten_node/)
|
||||
Returns: [FlattenNode](/kapacitor/v1/reference/nodes/flatten_node/)
|
||||
|
||||
### GroupBy
|
||||
|
||||
|
|
@ -433,7 +434,7 @@ Example:
|
|||
union|groupBy(tag ...interface{})
|
||||
```
|
||||
|
||||
Returns: [GroupByNode](/kapacitor/v1/nodes/group_by_node/)
|
||||
Returns: [GroupByNode](/kapacitor/v1/reference/nodes/group_by_node/)
|
||||
|
||||
### HoltWinters
|
||||
|
||||
|
|
@ -444,7 +445,7 @@ Compute the Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) f
|
|||
union|holtWinters(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HoltWintersWithFit
|
||||
|
||||
|
|
@ -456,7 +457,7 @@ This method also outputs all the points used to fit the data in addition to the
|
|||
union|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### HttpOut
|
||||
|
||||
|
|
@ -471,7 +472,7 @@ For example, if the task endpoint is at `/kapacitor/v1/tasks/<task_id>` and endp
|
|||
union|httpOut(endpoint string)
|
||||
```
|
||||
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/nodes/http_out_node/)
|
||||
Returns: [HTTPOutNode](/kapacitor/v1/reference/nodes/http_out_node/)
|
||||
|
||||
### HttpPost
|
||||
|
||||
|
|
@ -484,7 +485,7 @@ endpoint property method.
|
|||
union|httpPost(url ...string)
|
||||
```
|
||||
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/nodes/http_post_node/)
|
||||
Returns: [HTTPPostNode](/kapacitor/v1/reference/nodes/http_post_node/)
|
||||
|
||||
### InfluxDBOut
|
||||
|
||||
|
|
@ -495,7 +496,7 @@ Create an influxdb output node that will store the incoming data into InfluxDB.
|
|||
union|influxDBOut()
|
||||
```
|
||||
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/nodes/influx_d_b_out_node/)
|
||||
Returns: [InfluxDBOutNode](/kapacitor/v1/reference/nodes/influx_d_b_out_node/)
|
||||
|
||||
### Join
|
||||
|
||||
|
|
@ -506,7 +507,7 @@ Join this node with other nodes. The data is joined on timestamp.
|
|||
union|join(others ...Node)
|
||||
```
|
||||
|
||||
Returns: [JoinNode](/kapacitor/v1/nodes/join_node/)
|
||||
Returns: [JoinNode](/kapacitor/v1/reference/nodes/join_node/)
|
||||
|
||||
### K8sAutoscale
|
||||
|
||||
|
|
@ -517,7 +518,7 @@ Create a node that can trigger autoscale events for a kubernetes cluster.
|
|||
union|k8sAutoscale()
|
||||
```
|
||||
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/nodes/k8s_autoscale_node/)
|
||||
Returns: [K8sAutoscaleNode](/kapacitor/v1/reference/nodes/k8s_autoscale_node/)
|
||||
|
||||
### KapacitorLoopback
|
||||
|
||||
|
|
@ -528,7 +529,7 @@ Create an kapacitor loopback node that will send data back into Kapacitor as a s
|
|||
union|kapacitorLoopback()
|
||||
```
|
||||
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/nodes/kapacitor_loopback_node/)
|
||||
Returns: [KapacitorLoopbackNode](/kapacitor/v1/reference/nodes/kapacitor_loopback_node/)
|
||||
|
||||
### Last
|
||||
|
||||
|
|
@ -539,7 +540,7 @@ Select the last point.
|
|||
union|last(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Log
|
||||
|
||||
|
|
@ -550,7 +551,7 @@ Create a node that logs all data it receives.
|
|||
union|log()
|
||||
```
|
||||
|
||||
Returns: [LogNode](/kapacitor/v1/nodes/log_node/)
|
||||
Returns: [LogNode](/kapacitor/v1/reference/nodes/log_node/)
|
||||
|
||||
### Max
|
||||
|
||||
|
|
@ -561,7 +562,7 @@ Select the maximum point.
|
|||
union|max(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mean
|
||||
|
||||
|
|
@ -572,7 +573,7 @@ Compute the mean of the data.
|
|||
union|mean(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Median
|
||||
|
||||
|
|
@ -586,7 +587,7 @@ If you want the median point, use `.percentile(field, 50.0)`.
|
|||
union|median(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Min
|
||||
|
||||
|
|
@ -597,7 +598,7 @@ Select the minimum point.
|
|||
union|min(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Mode
|
||||
|
||||
|
|
@ -608,7 +609,7 @@ Compute the mode of the data.
|
|||
union|mode(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### MovingAverage
|
||||
|
||||
|
|
@ -620,7 +621,7 @@ No points are emitted until the window is full.
|
|||
union|movingAverage(field string, window int64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Percentile
|
||||
|
||||
|
|
@ -631,7 +632,7 @@ Select a point at the given percentile. This is a selector function, no interpol
|
|||
union|percentile(field string, percentile float64)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sample
|
||||
|
||||
|
|
@ -644,7 +645,7 @@ One point will be emitted every count or duration specified.
|
|||
union|sample(rate interface{})
|
||||
```
|
||||
|
||||
Returns: [SampleNode](/kapacitor/v1/nodes/sample_node/)
|
||||
Returns: [SampleNode](/kapacitor/v1/reference/nodes/sample_node/)
|
||||
|
||||
### Shift
|
||||
|
||||
|
|
@ -655,7 +656,7 @@ Create a new node that shifts the incoming points or batches in time.
|
|||
union|shift(shift time.Duration)
|
||||
```
|
||||
|
||||
Returns: [ShiftNode](/kapacitor/v1/nodes/shift_node/)
|
||||
Returns: [ShiftNode](/kapacitor/v1/reference/nodes/shift_node/)
|
||||
|
||||
### Sideload
|
||||
|
||||
|
|
@ -666,7 +667,7 @@ Create a node that can load data from external sources.
|
|||
union|sideload()
|
||||
```
|
||||
|
||||
Returns: [SideloadNode](/kapacitor/v1/nodes/sideload_node/)
|
||||
Returns: [SideloadNode](/kapacitor/v1/reference/nodes/sideload_node/)
|
||||
|
||||
### Spread
|
||||
|
||||
|
|
@ -677,7 +678,7 @@ Compute the difference between `min` and `max` points.
|
|||
union|spread(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### StateCount
|
||||
|
||||
|
|
@ -688,7 +689,7 @@ Create a node that tracks number of consecutive points in a given state.
|
|||
union|stateCount(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateCountNode](/kapacitor/v1/nodes/state_count_node/)
|
||||
Returns: [StateCountNode](/kapacitor/v1/reference/nodes/state_count_node/)
|
||||
|
||||
### StateDuration
|
||||
|
||||
|
|
@ -699,7 +700,7 @@ Create a node that tracks duration in a given state.
|
|||
union|stateDuration(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [StateDurationNode](/kapacitor/v1/nodes/state_duration_node/)
|
||||
Returns: [StateDurationNode](/kapacitor/v1/reference/nodes/state_duration_node/)
|
||||
|
||||
### Stats
|
||||
|
||||
|
|
@ -712,7 +713,7 @@ This means the interval time is independent of the times of the data points the
|
|||
union|stats(interval time.Duration)
|
||||
```
|
||||
|
||||
Returns: [StatsNode](/kapacitor/v1/nodes/stats_node/)
|
||||
Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)
|
||||
|
||||
### Stddev
|
||||
|
||||
|
|
@ -723,7 +724,7 @@ Compute the standard deviation.
|
|||
union|stddev(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Sum
|
||||
|
||||
|
|
@ -734,7 +735,7 @@ Compute the sum of all values.
|
|||
union|sum(field string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### SwarmAutoscale
|
||||
|
||||
|
|
@ -745,7 +746,7 @@ Create a node that can trigger autoscale events for a Docker swarm cluster.
|
|||
union|swarmAutoscale()
|
||||
```
|
||||
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/nodes/swarm_autoscale_node/)
|
||||
Returns: [SwarmAutoscaleNode](/kapacitor/v1/reference/nodes/swarm_autoscale_node/)
|
||||
|
||||
### Top
|
||||
|
||||
|
|
@ -756,7 +757,7 @@ Select the top `num` points for `field` and sort by any extra tags or fields.
|
|||
union|top(num int64, field string, fieldsAndTags ...string)
|
||||
```
|
||||
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/nodes/influx_q_l_node/)
|
||||
Returns: [InfluxQLNode](/kapacitor/v1/reference/nodes/influx_q_l_node/)
|
||||
|
||||
### Trickle
|
||||
|
||||
|
|
@ -766,7 +767,7 @@ Create a new node that converts batch data to stream data.
|
|||
union|trickle()
|
||||
```
|
||||
|
||||
Returns: [TrickleNode](/kapacitor/v1/nodes/trickle_node/)
|
||||
Returns: [TrickleNode](/kapacitor/v1/reference/nodes/trickle_node/)
|
||||
|
||||
### Union
|
||||
|
||||
|
|
@ -777,7 +778,7 @@ Perform the union of this node and all other given nodes.
|
|||
union|union(node ...Node)
|
||||
```
|
||||
|
||||
Returns: [UnionNode](/kapacitor/v1/nodes/union_node/)
|
||||
Returns: [UnionNode](/kapacitor/v1/reference/nodes/union_node/)
|
||||
|
||||
### Where
|
||||
|
||||
|
|
@ -788,7 +789,7 @@ Create a new node that filters the data stream by a given expression.
|
|||
union|where(expression ast.LambdaNode)
|
||||
```
|
||||
|
||||
Returns: [WhereNode](/kapacitor/v1/nodes/where_node/)
|
||||
Returns: [WhereNode](/kapacitor/v1/reference/nodes/where_node/)
|
||||
|
||||
### Window
|
||||
|
||||
|
|
@ -801,4 +802,4 @@ NOTE: Window can only be applied to stream edges.
|
|||
union|window()
|
||||
```
|
||||
|
||||
Returns: [WindowNode](/kapacitor/v1/nodes/window_node/)
|
||||
Returns: [WindowNode](/kapacitor/v1/reference/nodes/window_node/)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue