Doc文档

QueryFluxNode

queryFlux 节点定义了处理批量数据的源和计划。数据从 InfluxDB bucket 中查询,然后传递到数据管道中。

示例

以下示例每 20 秒查询一次 InfluxDB,并返回最近一分钟的数据。

batch
  |queryFlux('''
    from(bucket: "example-bucket")
    |> range(start: -1m)
    |> filter(fn: (r) =>
      r._measurement == "example-measurement" and
      r._field == "example-field"
    )
  ''')
    .period(1m)
    .every(20s)

构造函数

链式方法描述
queryFlux( queryStr string)要执行的 Flux 查询。

属性方法

设置器描述
align( )将开始和结束时间与 every 值对齐。如果使用 cron,则不适用。
cluster( value string)已配置的 InfluxDB 集群的名称。如果为空,将使用默认集群。
cron( value string)使用 cron 语法定义计划。与 every 属性互斥。
every( value time.Duration)查询 InfluxDB 的频率。与 cron 属性互斥。
offset( value time.Duration)从当前时间回溯查询的时间长度。
org( value string)InfluxDB 云端或 2.x 组织名称。
orgID( value string)InfluxDB 云端或 2.x 组织 ID。
period( value time.Duration)将从 InfluxDB 查询的时间段或长度。
quiet( )禁止来自此节点的所有错误日志记录事件。

链式方法

Alert, Barrier, Bottom, ChangeDetect, Combine, Count, CumulativeSum, Deadman, Default, Delete, Derivative, Difference, Distinct, Ec2Autoscale, Elapsed, Eval, First, Flatten, HoltWinters, HoltWintersWithFit, HttpOut, HttpPost, InfluxDBOut, Join, K8sAutoscale, KapacitorLoopback, Last, Log, Max, Mean, Median, Min, Mode, MovingAverage, Percentile, Sample, Shift, Sideload, Spread, StateCount, StateDuration, Stats, Stddev, Sum, SwarmAutoscale, Top, Trickle, Union, Where, Window


属性

属性方法修改调用节点的状态。它们不会向管道添加另一个节点,并且始终返回对调用节点的引用。属性方法使用 . 运算符标记。

对齐

将查询的开始和停止时间与 QueryFluxNode.Every 属性的偶数边界对齐。如果使用 QueryFluxNode.Cron 属性,则不适用。

queryFlux.align()

集群

已配置的 InfluxDB 集群的名称。如果为空,则使用默认集群。

queryFlux.cluster(value string)

Cron

使用 cron 语法定义计划。

具体的 cron 实现文档在此处:https://github.com/gorhill/cronexpr#implementation

Cron 属性与 Every 属性互斥。

queryFlux.cron(value string)

Every

查询 InfluxDB 的频率。Every 属性与 Cron 属性互斥。

queryFlux.every(value time.Duration)

偏移

从当前时间回溯查询的时间长度。

例如,如果 offset 为 2 小时,every 为 5 分钟,则 Kapacitor 将每 5 分钟查询 InfluxDB,获取 2 小时前的数据窗口。

这也适用于 Cron 计划。如果 cron 指定在每周日凌晨 1 点运行,并且 Offset 为 1 小时。那么在周日凌晨 1 点,将查询凌晨 12 点的数据。

queryFlux.offset(value time.Duration)

周期

从 InfluxDB 查询的时间段或长度。

queryFlux.period(value time.Duration)

Org

要查询的 InfluxDB 云端或 2.x 组织名称。如果为空,则使用默认的 org

queryFlux.org(value string)

OrgID

要查询的 InfluxDB 云端或 2.x 组织 ID。如果为空,则使用默认的 orgID

queryFlux.orgID(value string)

Quiet

禁止来自此节点的所有错误日志记录事件。

queryFlux.quiet()

链式方法

链式方法在管道中创建一个新节点,作为调用节点的子节点。它们不会修改调用节点。链式方法使用 | 运算符标记。

Alert

创建一个告警节点,可以触发告警。

queryFlux|alert()

返回: AlertNode

Barrier

创建一个新的 Barrier 节点,定期发出 BarrierMessage。

每个周期时长将发出一个 BarrierMessage。

queryFlux|barrier()

返回: BarrierNode

Bottom

选择 field 的底部 num 个点,并按任何额外的标签或字段排序。

queryFlux|bottom(num int64, field string, fieldsAndTags ...string)

返回: InfluxQLNode

ChangeDetect

创建一个新节点,仅当新点与前一个点不同时才发出新点。

queryFlux|changeDetect(field string)

返回: ChangeDetectNode

Combine

将此节点与其自身组合。数据按时间戳组合。

queryFlux|combine(expressions ...ast.LambdaNode)

返回: CombineNode

Count

计算点的数量。

queryFlux|count(field string)

返回: InfluxQLNode

CumulativeSum

计算接收到的每个点的累积和。为收集的每个点发出一个点。

queryFlux|cumulativeSum(field string)

返回: InfluxQLNode

Deadman

用于在低吞吐量(又名 deadman's switch)上创建告警的辅助函数。

  • 阈值:如果吞吐量降至低于 points/interval 的阈值,则触发告警。
  • 间隔:检查吞吐量的频率。
  • 表达式:可选的表达式列表,用于也进行评估。对于一天中的时间告警很有用。

示例

    var data = batch
        |queryFlux()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    data
        |deadman(100.0, 10s)
    //Do normal processing of data
    data...

以上等同于此示例

    var data = batch
        |queryFlux()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    data
        |stats(10s)
            .align()
        |derivative('emitted')
            .unit(10s)
            .nonNegative()
        |alert()
            .id('node \'stream0\' in task \'{{ .TaskName }}\'')
            .message('{{ .ID }} is {{ if eq .Level "OK" }}alive{{ else }}dead{{ end }}: {{ index .Fields "emitted" | printf "%0.3f" }} points/10s.')
            .crit(lambda: "emitted" <= 100.0)
    //Do normal processing of data
    data...

idmessage 告警属性可以通过 'deadman' 配置部分全局配置。

由于 AlertNode 是最后一部分,因此可以像往常一样进一步修改。示例

    var data = batch
        |queryFlux()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    data
        |deadman(100.0, 10s)
            .slack()
            .channel('#dead_tasks')
    //Do normal processing of data
    data...

您可以指定额外的 lambda 表达式,以进一步约束何时触发 deadman's switch。示例

    var data = batch
        |queryFlux()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    // Only trigger the alert if the time of day is between 8am-5pm.
    data
        |deadman(100.0, 10s, lambda: hour("time") >= 8 AND hour("time") <= 17)
    //Do normal processing of data
    data...
queryFlux|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)

返回: AlertNode

Default

创建一个可以为缺失的标签或字段设置默认值的节点。

queryFlux|default()

返回: DefaultNode

Delete

创建一个可以删除标签或字段的节点。

queryFlux|delete()

返回: DeleteNode

Derivative

创建一个新节点,计算相邻点的导数。

queryFlux|derivative(field string)

返回: DerivativeNode

Difference

计算点之间的差异,与经过的时间无关。

queryFlux|difference(field string)

返回: InfluxQLNode

Distinct

生成仅包含不同点的批次。

queryFlux|distinct(field string)

返回: InfluxQLNode

Ec2Autoscale

创建一个可以为 ec2 自动缩放组触发自动缩放事件的节点。

queryFlux|ec2Autoscale()

返回: Ec2AutoscaleNode

Elapsed

计算点之间经过的时间。

queryFlux|elapsed(field string, unit time.Duration)

返回: InfluxQLNode

Eval

创建一个 eval 节点,该节点将评估给定的转换函数到每个数据点。可以提供表达式列表,并将按给定的顺序进行评估。结果可用于后续表达式。

queryFlux|eval(expressions ...ast.LambdaNode)

返回: EvalNode

First

选择第一个点。

queryFlux|first(field string)

返回: InfluxQLNode

Flatten

将具有相似时间的点展平为单个点。

queryFlux|flatten()

返回: FlattenNode

HoltWinters

计算数据集的 Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) 预测。

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

返回: InfluxQLNode

HoltWintersWithFit

计算数据集的 Holt-Winters (/influxdb/v1/query_language/functions/#holt-winters) 预测。除了预测数据外,此方法还输出用于拟合数据的所有点。

queryFlux|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)

返回: InfluxQLNode

HttpOut

创建一个 HTTP 输出节点,该节点缓存其接收到的最新数据。缓存的数据在给定的端点可用。端点是正在运行的任务的 API 端点的相对路径。例如,如果任务端点位于 /kapacitor/v1/tasks/<task_id>,而端点为 top10,则可以从 /kapacitor/v1/tasks/<task_id>/top10 请求数据。

queryFlux|httpOut(endpoint string)

返回: HTTPOutNode

HttpPost

创建一个 HTTP Post 节点,该节点将接收到的数据 POST 到提供的 HTTP 端点。HttpPost 期望 0 或 1 个参数。如果提供 0 个参数,则必须指定一个端点属性方法。

queryFlux|httpPost(url ...string)

返回: HTTPPostNode

InfluxDBOut

创建一个 influxdb 输出节点,该节点将传入的数据存储到 InfluxDB 中。

queryFlux|influxDBOut()

返回: InfluxDBOutNode

Join

将此节点与其他节点连接。数据按时间戳连接。

queryFlux|join(others ...Node)

返回: JoinNode

K8sAutoscale

创建一个可以为 kubernetes 集群触发自动缩放事件的节点。

queryFlux|k8sAutoscale()

返回: K8sAutoscaleNode

KapacitorLoopback

创建一个 kapacitor loopback 节点,该节点会将数据作为流发送回 Kapacitor。

queryFlux|kapacitorLoopback()

返回: KapacitorLoopbackNode

Last

选择最后一个点。

queryFlux|last(field string)

返回: InfluxQLNode

日志

创建一个记录其接收到的所有数据的节点。

queryFlux|log()

返回: LogNode

Max

选择最大点。

queryFlux|max(field string)

返回: InfluxQLNode

Mean

计算数据的平均值。

queryFlux|mean(field string)

返回: InfluxQLNode

Median

计算数据的中位数。

注意: 此方法不是选择器。如果要获取中值点,请使用 .percentile(field, 50.0)

queryFlux|median(field string)

返回: InfluxQLNode

Min

选择最小点。

queryFlux|min(field string)

返回: InfluxQLNode

Mode

计算数据的众数。

queryFlux|mode(field string)

返回: InfluxQLNode

MovingAverage

计算最后窗口点的移动平均值。在窗口填满之前,不会发出任何点。

queryFlux|movingAverage(field string, window int64)

返回: InfluxQLNode

Percentile

选择给定百分位数的点。这是一个选择器函数,不执行点之间的插值。

queryFlux|percentile(field string, percentile float64)

返回: InfluxQLNode

Sample

创建一个新节点,对传入的点或批次进行采样。

将按指定的计数或持续时间发出一个点。

queryFlux|sample(rate interface{})

返回: SampleNode

Shift

创建一个新节点,该节点及时移动传入的点或批次。

queryFlux|shift(shift time.Duration)

返回: ShiftNode

Sideload

创建一个可以从外部源加载数据的节点。

queryFlux|sideload()

返回: SideloadNode

Spread

计算 minmax 点之间的差异。

queryFlux|spread(field string)

返回: InfluxQLNode

StateCount

创建一个节点,跟踪给定状态下连续点的数量。

queryFlux|stateCount(expression ast.LambdaNode)

返回: StateCountNode

StateDuration

创建一个节点,跟踪给定状态下的持续时间。

queryFlux|stateDuration(expression ast.LambdaNode)

返回: StateDurationNode

Stats

创建一个新的数据流,其中包含节点的内部统计信息。间隔表示基于实时发出统计信息的频率。这意味着间隔时间独立于源节点正在接收的数据点的时间。

queryFlux|stats(interval time.Duration)

返回: StatsNode

Stddev

计算标准差。

queryFlux|stddev(field string)

返回: InfluxQLNode

Sum

计算所有值的总和。

queryFlux|sum(field string)

返回: InfluxQLNode

SwarmAutoscale

创建一个可以为 Docker swarm 集群触发自动缩放事件的节点。

queryFlux|swarmAutoscale()

返回: SwarmAutoscaleNode

Top

选择 field 的顶部 num 个点,并按任何额外的标签或字段排序。

queryFlux|top(num int64, field string, fieldsAndTags ...string)

返回: InfluxQLNode

Trickle

创建一个新节点,将批量数据转换为流数据。

queryFlux|trickle()

返回: TrickleNode

Union

执行此节点和所有其他给定节点的并集。

queryFlux|union(node ...Node)

返回: UnionNode

Where

创建一个新节点,该节点通过给定的表达式过滤数据流。

queryFlux|where(expression ast.LambdaNode)

返回: WhereNode

Window

创建一个新节点,该节点按时间对流进行窗口化。

注意:Window 只能应用于流边缘。

queryFlux|window()

返回: WindowNode


此页是否对您有帮助?

感谢您的反馈!


Flux 的未来

Flux 即将进入维护模式。您可以继续像现在这样使用它,而无需对代码进行任何更改。

阅读更多

InfluxDB 3 开源版本现已公开发布 Alpha 版

InfluxDB 3 开源版本现已可用于 Alpha 测试,根据 MIT 或 Apache 2 许可获得许可。

我们正在发布两个产品作为 Alpha 版本的一部分。

InfluxDB 3 Core 是我们新的开源产品。它是用于时间序列和事件数据的最新数据引擎。InfluxDB 3 Enterprise 是一个商业版本,它建立在 Core 的基础上,增加了历史查询功能、读取副本、高可用性、可扩展性和细粒度的安全性。

有关如何开始使用的更多信息,请查看