自動インターバル日付ヒストグラム（Auto-interval date histogram）

自動間隔日付ヒストグラム集約

各バケットの幅として使用する間隔を提供する代わりに、必要なバケットの数を示すターゲット数が提供され、そのターゲットを最もよく達成するためにバケットの間隔が自動的に選択される、日付ヒストグラムに似たマルチバケット集約です。返されるバケットの数は常にこのターゲット数以下になります。

バケットフィールドはオプションであり、指定されていない場合はデフォルトで10バケットになります。

ターゲットとして10バケットを要求します。

Python

resp = client.search(
   index="sales",
   size="0",
   aggs={
   "sales_over_time": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 10
   }
   }
   },
)
print(resp)

Ruby

response = client.search(
  index: 'sales',
  size: 0,
  body: {
   aggregations: {
   sales_over_time: {
   auto_date_histogram: {
   field: 'date',
   buckets: 10
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "sales",
  size: 0,
  aggs: {
   sales_over_time: {
   auto_date_histogram: {
   field: "date",
   buckets: 10,
   },
   },
  },
});
console.log(response);

コンソール

POST /sales/_search?size=0
{
  "aggs": {
   "sales_over_time": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 10
   }
   }
  }
}

キー

内部的に、日付はエポックからのミリ秒で表される64ビットの数として表現されます。これらのタイムスタンプはバケットkeyとして返されます。key_as_stringは、formatパラメータで指定された形式を使用してフォーマットされた日付文字列に変換された同じタイムスタンプです：

#### Python
``````python
resp = client.search(
   index="sales",
   size="0",
   aggs={
   "sales_over_time": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 5,
   "format": "yyyy-MM-dd"
   }
   }
   },
)
print(resp)
`

Ruby

response = client.search(
  index: 'sales',
  size: 0,
  body: {
   aggregations: {
   sales_over_time: {
   auto_date_histogram: {
   field: 'date',
   buckets: 5,
   format: 'yyyy-MM-dd'
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "sales",
  size: 0,
  aggs: {
   sales_over_time: {
   auto_date_histogram: {
   field: "date",
   buckets: 5,
   format: "yyyy-MM-dd",
   },
   },
  },
});
console.log(response);

コンソール

POST /sales/_search?size=0
{
  "aggs": {
   "sales_over_time": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 5,
   "format": "yyyy-MM-dd"
   }
   }
  }
}

応答：

コンソール-結果

{
  ...
  "aggregations": {
   "sales_over_time": {
   "buckets": [
   {
   "key_as_string": "2015-01-01",
   "key": 1420070400000,
   "doc_count": 3
   },
   {
   "key_as_string": "2015-02-01",
   "key": 1422748800000,
   "doc_count": 2
   },
   {
   "key_as_string": "2015-03-01",
   "key": 1425168000000,
   "doc_count": 2
   }
   ],
   "interval": "1M"
   }
  }
}

間隔

返されるバケットの間隔は、集約によって収集されたデータに基づいて選択され、返されるバケットの数は要求された数以下になります。返される可能な間隔は：

最悪の場合、日次バケットの数が要求されたバケットの数に対して多すぎる場合、返されるバケットの数は要求されたバケットの数の1/7になります。

タイムゾーン

日付時刻はElasticsearchにUTCで保存されます。デフォルトでは、すべてのバケット化と丸めもUTCで行われます。time_zoneパラメータを使用して、バケット化に異なるタイムゾーンを使用することを示すことができます。

タイムゾーンは、ISO 8601 UTCオフセット（例：+01:00または-08:00）として指定するか、America/Los_AngelesのようなTZデータベースで使用される識別子として指定できます。

次の例を考えてみてください：

Python

resp = client.index(
   index="my-index-000001",
   id="1",
   refresh=True,
   document={
   "date": "2015-10-01T00:30:00Z"
   },
)
print(resp)
resp1 = client.index(
   index="my-index-000001",
   id="2",
   refresh=True,
   document={
   "date": "2015-10-01T01:30:00Z"
   },
)
print(resp1)
resp2 = client.index(
   index="my-index-000001",
   id="3",
   refresh=True,
   document={
   "date": "2015-10-01T02:30:00Z"
   },
)
print(resp2)
resp3 = client.search(
   index="my-index-000001",
   size="0",
   aggs={
   "by_day": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 3
   }
   }
   },
)
print(resp3)

Ruby

response = client.index(
  index: 'my-index-000001',
  id: 1,
  refresh: true,
  body: {
   date: '2015-10-01T00:30:00Z'
  }
)
puts response
response = client.index(
  index: 'my-index-000001',
  id: 2,
  refresh: true,
  body: {
   date: '2015-10-01T01:30:00Z'
  }
)
puts response
response = client.index(
  index: 'my-index-000001',
  id: 3,
  refresh: true,
  body: {
   date: '2015-10-01T02:30:00Z'
  }
)
puts response
response = client.search(
  index: 'my-index-000001',
  size: 0,
  body: {
   aggregations: {
   by_day: {
   auto_date_histogram: {
   field: 'date',
   buckets: 3
   }
   }
   }
  }
)
puts response

Js

const response = await client.index({
  index: "my-index-000001",
  id: 1,
  refresh: "true",
  document: {
   date: "2015-10-01T00:30:00Z",
  },
});
console.log(response);
const response1 = await client.index({
  index: "my-index-000001",
  id: 2,
  refresh: "true",
  document: {
   date: "2015-10-01T01:30:00Z",
  },
});
console.log(response1);
const response2 = await client.index({
  index: "my-index-000001",
  id: 3,
  refresh: "true",
  document: {
   date: "2015-10-01T02:30:00Z",
  },
});
console.log(response2);
const response3 = await client.search({
  index: "my-index-000001",
  size: 0,
  aggs: {
   by_day: {
   auto_date_histogram: {
   field: "date",
   buckets: 3,
   },
   },
  },
});
console.log(response3);

コンソール

PUT my-index-000001/_doc/1?refresh
{
  "date": "2015-10-01T00:30:00Z"
}
PUT my-index-000001/_doc/2?refresh
{
  "date": "2015-10-01T01:30:00Z"
}
PUT my-index-000001/_doc/3?refresh
{
  "date": "2015-10-01T02:30:00Z"
}
GET my-index-000001/_search?size=0
{
  "aggs": {
   "by_day": {
   "auto_date_histogram": {
   "field":     "date",
   "buckets" : 3
   }
   }
  }
}

UTCが指定されていない場合は使用され、2015年10月1日の真夜中UTCから始まる3つの1時間バケットが返されます：

コンソール-結果

{
  ...
  "aggregations": {
   "by_day": {
   "buckets": [
   {
   "key_as_string": "2015-10-01T00:00:00.000Z",
   "key": 1443657600000,
   "doc_count": 1
   },
   {
   "key_as_string": "2015-10-01T01:00:00.000Z",
   "key": 1443661200000,
   "doc_count": 1
   },
   {
   "key_as_string": "2015-10-01T02:00:00.000Z",
   "key": 1443664800000,
   "doc_count": 1
   }
   ],
   "interval": "1h"
   }
  }
}

#### Python
``````python
resp = client.search(
   index="my-index-000001",
   size="0",
   aggs={
   "by_day": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 3,
   "time_zone": "-01:00"
   }
   }
   },
)
print(resp)
`

Ruby

response = client.search(
  index: 'my-index-000001',
  size: 0,
  body: {
   aggregations: {
   by_day: {
   auto_date_histogram: {
   field: 'date',
   buckets: 3,
   time_zone: '-01:00'
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "my-index-000001",
  size: 0,
  aggs: {
   by_day: {
   auto_date_histogram: {
   field: "date",
   buckets: 3,
   time_zone: "-01:00",
   },
   },
  },
});
console.log(response);

コンソール

GET my-index-000001/_search?size=0
{
  "aggs": {
   "by_day": {
   "auto_date_histogram": {
   "field":     "date",
   "buckets" : 3,
   "time_zone": "-01:00"
   }
   }
  }
}

現在、3つの1時間バケットが返されますが、最初のバケットは2015年9月30日の午後11時から始まります。これは指定されたタイムゾーンのバケットのローカル時間です。

コンソール-結果

{
  ...
  "aggregations": {
   "by_day": {
   "buckets": [
   {
   "key_as_string": "2015-09-30T23:00:00.000-01:00",
   "key": 1443657600000,
   "doc_count": 1
   },
   {
   "key_as_string": "2015-10-01T00:00:00.000-01:00",
   "key": 1443661200000,
   "doc_count": 1
   },
   {
   "key_as_string": "2015-10-01T01:00:00.000-01:00",
   "key": 1443664800000,
   "doc_count": 1
   }
   ],
   "interval": "1h"
   }
  }
}

DST（夏時間）変更に従うタイムゾーンを使用する場合、これらの変更が発生する瞬間に近いバケットは、隣接するバケットとはわずかに異なるサイズになる可能性があります。たとえば、CETタイムゾーンでのDST開始を考えてみてください：2016年3月27日午前2時に、時計は1時間進められ、午前3時のローカル時間になります。集約の結果が日次バケットであった場合、その日のバケットは通常の24時間ではなく、23時間のデータしか保持しません。他のバケットと同様に、12時間のような短い間隔でも同じことが言えます。ここでは、DSTシフトが発生する3月27日の朝に11時間のバケットしかありません。

最小間隔パラメータ

`````minimum_interval`````の受け入れられる単位は：  
-  年  
-  月  
-  日  
-  時間  
-  分  
-  秒
#### Python
``````python
resp = client.search(
   index="sales",
   size="0",
   aggs={
   "sale_date": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 10,
   "minimum_interval": "minute"
   }
   }
   },
)
print(resp)
`

Ruby

response = client.search(
  index: 'sales',
  size: 0,
  body: {
   aggregations: {
   sale_date: {
   auto_date_histogram: {
   field: 'date',
   buckets: 10,
   minimum_interval: 'minute'
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "sales",
  size: 0,
  aggs: {
   sale_date: {
   auto_date_histogram: {
   field: "date",
   buckets: 10,
   minimum_interval: "minute",
   },
   },
  },
});
console.log(response);

コンソール

POST /sales/_search?size=0
{
  "aggs": {
   "sale_date": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 10,
   "minimum_interval": "minute"
   }
   }
  }
}

欠損値

#### Python
``````python
resp = client.search(
   index="sales",
   size="0",
   aggs={
   "sale_date": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 10,
   "missing": "2000/01/01"
   }
   }
   },
)
print(resp)
`

Ruby

response = client.search(
  index: 'sales',
  size: 0,
  body: {
   aggregations: {
   sale_date: {
   auto_date_histogram: {
   field: 'date',
   buckets: 10,
   missing: '2000/01/01'
   }
   }
   }
  }
)
puts response

Js

const response = await client.search({
  index: "sales",
  size: 0,
  aggs: {
   sale_date: {
   auto_date_histogram: {
   field: "date",
   buckets: 10,
   missing: "2000/01/01",
   },
   },
  },
});
console.log(response);

コンソール

POST /sales/_search?size=0
{
  "aggs": {
   "sale_date": {
   "auto_date_histogram": {
   "field": "date",
   "buckets": 10,
   "missing": "2000/01/01"
   }
   }
  }
}