« 比率聚合 统计聚合 »
Elastic 文档 ›Elasticsearch 指南 [8.14] ›聚合 ›指标聚合

脚本化指标聚合

编辑

脚本化指标聚合编辑

一种使用脚本执行以提供指标输出的指标聚合。

使用脚本可能会导致搜索速度变慢。请参阅脚本、缓存和搜索速度。

示例

response = client.search(
  index: 'ledger',
  size: 0,
  body: {
    query: {
      match_all: {}
    },
    aggregations: {
      profit: {
        scripted_metric: {
          init_script: 'state.transactions = []',
          map_script: "state.transactions.add(doc.type.value == 'sale' ? doc.amount.value : -1 * doc.amount.value)",
          combine_script: 'double profit = 0; for (t in state.transactions) { profit += t } return profit',
          reduce_script: 'double profit = 0; for (a in states) { profit += a } return profit'
        }
      }
    }
  }
)
puts response
POST ledger/_search?size=0
{
  "query": {
    "match_all": {}
  },
  "aggs": {
    "profit": {
      "scripted_metric": {
        "init_script": "state.transactions = []", 
        "map_script": "state.transactions.add(doc.type.value == 'sale' ? doc.amount.value : -1 * doc.amount.value)",
        "combine_script": "double profit = 0; for (t in state.transactions) { profit += t } return profit",
        "reduce_script": "double profit = 0; for (a in states) { profit += a } return profit"
      }
    }
  }
}

init_script 是一个可选参数，所有其他脚本都是必需的。

上述聚合演示了如何使用脚本聚合来计算销售和成本交易的总利润。

上述聚合的响应

{
  "took": 218,
  ...
  "aggregations": {
    "profit": {
      "value": 240.0
    }
  }
}

上述示例也可以使用存储的脚本指定，如下所示

response = client.search(
  index: 'ledger',
  size: 0,
  body: {
    aggregations: {
      profit: {
        scripted_metric: {
          init_script: {
            id: 'my_init_script'
          },
          map_script: {
            id: 'my_map_script'
          },
          combine_script: {
            id: 'my_combine_script'
          },
          params: {
            field: 'amount'
          },
          reduce_script: {
            id: 'my_reduce_script'
          }
        }
      }
    }
  }
)
puts response
POST ledger/_search?size=0
{
  "aggs": {
    "profit": {
      "scripted_metric": {
        "init_script": {
          "id": "my_init_script"
        },
        "map_script": {
          "id": "my_map_script"
        },
        "combine_script": {
          "id": "my_combine_script"
        },
        "params": {
          "field": "amount"           
        },
        "reduce_script": {
          "id": "my_reduce_script"
        }
      }
    }
  }
}

init、map 和 combine 脚本的脚本参数必须在全局 params 对象中指定，以便它们可以在脚本之间共享。

有关指定脚本的更多详细信息，请参阅脚本文档。

允许的返回类型编辑

虽然任何有效的脚本对象都可以在单个脚本中使用，但脚本必须仅返回或存储以下类型在 state 对象中

  • 基本类型
  • 字符串
  • 映射（仅包含此处列出的类型的键和值）
  • 数组（仅包含此处列出的类型的元素）

脚本的作用域编辑

脚本化指标聚合在其执行的 4 个阶段使用脚本

init_script

在收集任何文档之前执行。允许聚合设置任何初始状态。

在上面的示例中，init_script 在 state 对象中创建了一个数组 transactions。

map_script

为每个收集的文档执行一次。这是一个必需的脚本。

在上面的示例中，map_script 检查 type 字段的值。如果值为 *sale*，则将 amount 字段的值添加到 transactions 数组中。如果 type 字段的值不是 *sale*，则将 amount 字段的负值添加到 transactions 中。

combine_script

文档收集完成后，在每个分片上执行一次。这是一个必需的脚本。允许聚合合并从每个分片返回的状态。

在上面的示例中，combine_script 迭代所有存储的交易，将值汇总在 profit 变量中，最后返回 profit。

reduce_script

所有分片都返回其结果后，在协调节点上执行一次。这是一个必需的脚本。该脚本可以访问变量 states，该变量是每个分片上 combine_script 结果的数组。

在上面的示例中，reduce_script 迭代每个分片返回的 profit，将这些值相加，然后返回最终合并的利润，该利润将在聚合的响应中返回。

工作示例编辑

想象一下，您将以下文档索引到具有 2 个分片的索引中

response = client.bulk(
  index: 'transactions',
  refresh: true,
  body: [
    {
      index: {
        _id: 1
      }
    },
    {
      type: 'sale',
      amount: 80
    },
    {
      index: {
        _id: 2
      }
    },
    {
      type: 'cost',
      amount: 10
    },
    {
      index: {
        _id: 3
      }
    },
    {
      type: 'cost',
      amount: 30
    },
    {
      index: {
        _id: 4
      }
    },
    {
      type: 'sale',
      amount: 130
    }
  ]
)
puts response
PUT /transactions/_bulk?refresh
{"index":{"_id":1}}
{"type": "sale","amount": 80}
{"index":{"_id":2}}
{"type": "cost","amount": 10}
{"index":{"_id":3}}
{"type": "cost","amount": 30}
{"index":{"_id":4}}
{"type": "sale","amount": 130}

假设文档 1 和 3 最终位于分片 A 上，文档 2 和 4 最终位于分片 B 上。以下是上述示例中每个阶段的聚合结果细分。

在 init_script 之前编辑

state 初始化为一个新的空对象。

"state" : {}

在 init_script 之后编辑

这在执行任何文档收集之前在每个分片上运行一次，因此我们在每个分片上都会有一个副本

分片 A 
"state" : {
    "transactions" : []
}
分片 B 
"state" : {
    "transactions" : []
}

在 map_script 之后编辑

每个分片收集其文档，并在收集到的每个文档上运行 map_script

分片 A 
"state" : {
    "transactions" : [ 80, -30 ]
}
分片 B 
"state" : {
    "transactions" : [ -10, 130 ]
}

在 combine_script 之后编辑

文档收集完成后，在每个分片上执行 combine_script，并将所有交易减少为每个分片的单个利润数字（通过将 transactions 数组中的值相加），该数字将传递回协调节点

分片 A
50
分片 B
120

在 reduce_script 之后编辑

reduce_script 接收一个 states 数组，该数组包含每个分片的 combine 脚本的结果

"states" : [
    50,
    120
]

它将分片的响应减少为最终的总利润数字（通过将值相加），并将其作为聚合的结果返回以生成响应

{
  ...

  "aggregations": {
    "profit": {
      "value": 170
    }
  }
}

其他参数编辑

params

可选。其内容将作为变量传递给 init_script、map_script 和 combine_script 的对象。这对于允许用户控制聚合的行为以及在脚本之间存储状态非常有用。如果未指定，则默认为提供

"params" : {}

空桶编辑

如果脚本化指标聚合的父桶未收集任何文档，则分片将返回一个空的聚合响应，其值为 null。在这种情况下，reduce_script 的 states 变量将包含 null 作为该分片的响应。reduce_script 因此应该预期并处理来自分片的 null 响应。

« 比率聚合 统计聚合 »