パイプライン集計 - 導関数（Derivative） - 《Elasticsearchガイドv8.15》日本語

導関数の集約
構文
- Js
一次導関数
二次導関数
単位

導関数の集約

親ヒストグラム（または日付ヒストグラム）集約内の指定されたメトリックの導関数を計算する親パイプライン集約です。指定されたメトリックは数値でなければならず、囲むヒストグラムは min_doc_count を 0 に設定する必要があります（histogram 集約のデフォルト）。

構文

単独での derivative 集約は次のようになります：

Js

"derivative": {
  "buckets_path": "the_sum"
}

表 59. derivative パラメータ

パラメータ名	説明	必須	デフォルト値
`buckets_path`	導関数を求めるバケットへのパス（詳細については `buckets_path` 構文を参照）	必須
`gap_policy`	データにギャップが見つかった場合に適用するポリシー（詳細についてはデータのギャップの処理を参照）	オプション	`skip`
`format`	出力値のための DecimalFormat パターン。指定された場合、フォーマットされた値は集約の `value_as_string` プロパティに返されます	オプション	`null`

一次導関数

次のスニペットは、総月間 sales の導関数を計算します：

Python

resp = client.search(
   index="sales",
   size=0,
   aggs={
   "sales_per_month": {
   "date_histogram": {
   "field": "date",
   "calendar_interval": "month"
   },
   "aggs": {
   "sales": {
   "sum": {
   "field": "price"
   }
   },
   "sales_deriv": {
   "derivative": {
   "buckets_path": "sales"
   }
   }
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  index: 'sales',
  body: {
   size: 0,
   aggregations: {
   sales_per_month: {
   date_histogram: {
   field: 'date',
   calendar_interval: 'month'
   },
   aggregations: {
   sales: {
   sum: {
   field: 'price'
   }
   },
   sales_deriv: {
   derivative: {
   buckets_path: 'sales'
   }
   }
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "sales",
  size: 0,
  aggs: {
   sales_per_month: {
   date_histogram: {
   field: "date",
   calendar_interval: "month",
   },
   aggs: {
   sales: {
   sum: {
   field: "price",
   },
   },
   sales_deriv: {
   derivative: {
   buckets_path: "sales",
   },
   },
   },
   },
  },
});
console.log(response);

コンソール

POST /sales/_search
{
  "size": 0,
  "aggs": {
   "sales_per_month": {
   "date_histogram": {
   "field": "date",
   "calendar_interval": "month"
   },
   "aggs": {
   "sales": {
   "sum": {
   "field": "price"
   }
   },
   "sales_deriv": {
   "derivative": {
   "buckets_path": "sales"
   }
   }
   }
   }
  }
}


	`buckets_path` はこの導関数集約に `sales` 集約の出力を導関数として使用するよう指示します

次のような応答があるかもしれません：

コンソール-結果

{
   "took": 11,
   "timed_out": false,
   "_shards": ...,
   "hits": ...,
   "aggregations": {
   "sales_per_month": {
   "buckets": [
   {
   "key_as_string": "2015/01/01 00:00:00",
   "key": 1420070400000,
   "doc_count": 3,
   "sales": {
   "value": 550.0
   }
   },
   {
   "key_as_string": "2015/02/01 00:00:00",
   "key": 1422748800000,
   "doc_count": 2,
   "sales": {
   "value": 60.0
   },
   "sales_deriv": {
   "value": -490.0
   }
   },
   {
   "key_as_string": "2015/03/01 00:00:00",
   "key": 1425168000000,
   "doc_count": 2,
   "sales": {
   "value": 375.0
   },
   "sales_deriv": {
   "value": 315.0
   }
   }
   ]
   }
   }
}


	最初のバケットには導関数がありません。導関数を計算するには少なくとも2つのデータポイントが必要です
	導関数値の単位は `sales` 集約と親ヒストグラムによって暗黙的に定義されるため、この場合の単位は $/月であり、`price` フィールドの単位は $ です。
	バケット内のドキュメントの数は `doc_count` によって表されます

二次導関数

二次導関数は、別の導関数パイプライン集約の結果に導関数パイプライン集約をチェーンすることによって計算できます。以下の例では、総月間売上の一次および二次導関数の両方を計算します：

Python

resp = client.search(
   index="sales",
   size=0,
   aggs={
   "sales_per_month": {
   "date_histogram": {
   "field": "date",
   "calendar_interval": "month"
   },
   "aggs": {
   "sales": {
   "sum": {
   "field": "price"
   }
   },
   "sales_deriv": {
   "derivative": {
   "buckets_path": "sales"
   }
   },
   "sales_2nd_deriv": {
   "derivative": {
   "buckets_path": "sales_deriv"
   }
   }
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  index: 'sales',
  body: {
   size: 0,
   aggregations: {
   sales_per_month: {
   date_histogram: {
   field: 'date',
   calendar_interval: 'month'
   },
   aggregations: {
   sales: {
   sum: {
   field: 'price'
   }
   },
   sales_deriv: {
   derivative: {
   buckets_path: 'sales'
   }
   },
   "sales_2nd_deriv": {
   derivative: {
   buckets_path: 'sales_deriv'
   }
   }
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "sales",
  size: 0,
  aggs: {
   sales_per_month: {
   date_histogram: {
   field: "date",
   calendar_interval: "month",
   },
   aggs: {
   sales: {
   sum: {
   field: "price",
   },
   },
   sales_deriv: {
   derivative: {
   buckets_path: "sales",
   },
   },
   sales_2nd_deriv: {
   derivative: {
   buckets_path: "sales_deriv",
   },
   },
   },
   },
  },
});
console.log(response);

コンソール

POST /sales/_search
{
  "size": 0,
  "aggs": {
   "sales_per_month": {
   "date_histogram": {
   "field": "date",
   "calendar_interval": "month"
   },
   "aggs": {
   "sales": {
   "sum": {
   "field": "price"
   }
   },
   "sales_deriv": {
   "derivative": {
   "buckets_path": "sales"
   }
   },
   "sales_2nd_deriv": {
   "derivative": {
   "buckets_path": "sales_deriv"
   }
   }
   }
   }
  }
}


	二次導関数の `buckets_path` は一次導関数の名前を指します

次のような応答があるかもしれません：

コンソール-結果

{
   "took": 50,
   "timed_out": false,
   "_shards": ...,
   "hits": ...,
   "aggregations": {
   "sales_per_month": {
   "buckets": [
   {
   "key_as_string": "2015/01/01 00:00:00",
   "key": 1420070400000,
   "doc_count": 3,
   "sales": {
   "value": 550.0
   }
   },
   {
   "key_as_string": "2015/02/01 00:00:00",
   "key": 1422748800000,
   "doc_count": 2,
   "sales": {
   "value": 60.0
   },
   "sales_deriv": {
   "value": -490.0
   }
   },
   {
   "key_as_string": "2015/03/01 00:00:00",
   "key": 1425168000000,
   "doc_count": 2,
   "sales": {
   "value": 375.0
   },
   "sales_deriv": {
   "value": 315.0
   },
   "sales_2nd_deriv": {
   "value": 805.0
   }
   }
   ]
   }
   }
}


	最初の2つのバケットには二次導関数がありません。二次導関数を計算するには、一次導関数から少なくとも2つのデータポイントが必要です

単位

導関数集約では、導関数値の単位を指定できます。これにより、応答に normalized_value という追加フィールドが返され、希望する x 軸単位での導関数値が報告されます。以下の例では、月間総売上の導関数を計算しますが、売上の単位を日ごとの単位で求めます：

Python

resp = client.search(
   index="sales",
   size=0,
   aggs={
   "sales_per_month": {
   "date_histogram": {
   "field": "date",
   "calendar_interval": "month"
   },
   "aggs": {
   "sales": {
   "sum": {
   "field": "price"
   }
   },
   "sales_deriv": {
   "derivative": {
   "buckets_path": "sales",
   "unit": "day"
   }
   }
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  index: 'sales',
  body: {
   size: 0,
   aggregations: {
   sales_per_month: {
   date_histogram: {
   field: 'date',
   calendar_interval: 'month'
   },
   aggregations: {
   sales: {
   sum: {
   field: 'price'
   }
   },
   sales_deriv: {
   derivative: {
   buckets_path: 'sales',
   unit: 'day'
   }
   }
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "sales",
  size: 0,
  aggs: {
   sales_per_month: {
   date_histogram: {
   field: "date",
   calendar_interval: "month",
   },
   aggs: {
   sales: {
   sum: {
   field: "price",
   },
   },
   sales_deriv: {
   derivative: {
   buckets_path: "sales",
   unit: "day",
   },
   },
   },
   },
  },
});
console.log(response);

コンソール

POST /sales/_search
{
  "size": 0,
  "aggs": {
   "sales_per_month": {
   "date_histogram": {
   "field": "date",
   "calendar_interval": "month"
   },
   "aggs": {
   "sales": {
   "sum": {
   "field": "price"
   }
   },
   "sales_deriv": {
   "derivative": {
   "buckets_path": "sales",
   "unit": "day"
   }
   }
   }
   }
  }
}


	`unit` は導関数計算の x 軸に使用する単位を指定します

次のような応答があるかもしれません：

コンソール-結果

{
   "took": 50,
   "timed_out": false,
   "_shards": ...,
   "hits": ...,
   "aggregations": {
   "sales_per_month": {
   "buckets": [
   {
   "key_as_string": "2015/01/01 00:00:00",
   "key": 1420070400000,
   "doc_count": 3,
   "sales": {
   "value": 550.0
   }
   },
   {
   "key_as_string": "2015/02/01 00:00:00",
   "key": 1422748800000,
   "doc_count": 2,
   "sales": {
   "value": 60.0
   },
   "sales_deriv": {
   "value": -490.0,
   "normalized_value": -15.806451612903226
   }
   },
   {
   "key_as_string": "2015/03/01 00:00:00",
   "key": 1425168000000,
   "doc_count": 2,
   "sales": {
   "value": 375.0
   },
   "sales_deriv": {
   "value": 315.0,
   "normalized_value": 11.25
   }
   }
   ]
   }
   }
}


	`value` は元の単位である月あたりで報告されます
	`normalized_value` は希望する単位である日あたりで報告されます