|
@@ -3,7 +3,7 @@
|
|
|
|
|
|
experimental[]
|
|
|
|
|
|
-A parent pipeline aggregation which calculates the derivative of a specified metric in a parent histogram (or date_histogram)
|
|
|
+A parent pipeline aggregation which calculates the derivative of a specified metric in a parent histogram (or date_histogram)
|
|
|
aggregation. The specified metric must be numeric and the enclosing histogram must have `min_doc_count` set to `0` (default
|
|
|
for `histogram` aggregations).
|
|
|
|
|
@@ -13,10 +13,8 @@ A `derivative` aggregation looks like this in isolation:
|
|
|
|
|
|
[source,js]
|
|
|
--------------------------------------------------
|
|
|
-{
|
|
|
- "derivative": {
|
|
|
- "buckets_path": "the_sum"
|
|
|
- }
|
|
|
+"derivative": {
|
|
|
+ "buckets_path": "the_sum"
|
|
|
}
|
|
|
--------------------------------------------------
|
|
|
|
|
@@ -37,7 +35,9 @@ The following snippet calculates the derivative of the total monthly `sales`:
|
|
|
|
|
|
[source,js]
|
|
|
--------------------------------------------------
|
|
|
+POST /sales/_search
|
|
|
{
|
|
|
+ "size": 0,
|
|
|
"aggs" : {
|
|
|
"sales_per_month" : {
|
|
|
"date_histogram" : {
|
|
@@ -60,6 +60,8 @@ The following snippet calculates the derivative of the total monthly `sales`:
|
|
|
}
|
|
|
}
|
|
|
--------------------------------------------------
|
|
|
+// CONSOLE
|
|
|
+// TEST[setup:sales]
|
|
|
|
|
|
<1> `buckets_path` instructs this derivative aggregation to use the output of the `sales` aggregation for the derivative
|
|
|
|
|
@@ -68,6 +70,10 @@ And the following may be the response:
|
|
|
[source,js]
|
|
|
--------------------------------------------------
|
|
|
{
|
|
|
+ "took": 11,
|
|
|
+ "timed_out": false,
|
|
|
+ "_shards": ...,
|
|
|
+ "hits": ...,
|
|
|
"aggregations": {
|
|
|
"sales_per_month": {
|
|
|
"buckets": [
|
|
@@ -76,7 +82,7 @@ And the following may be the response:
|
|
|
"key": 1420070400000,
|
|
|
"doc_count": 3,
|
|
|
"sales": {
|
|
|
- "value": 550
|
|
|
+ "value": 550.0
|
|
|
} <1>
|
|
|
},
|
|
|
{
|
|
@@ -84,10 +90,10 @@ And the following may be the response:
|
|
|
"key": 1422748800000,
|
|
|
"doc_count": 2,
|
|
|
"sales": {
|
|
|
- "value": 60
|
|
|
+ "value": 60.0
|
|
|
},
|
|
|
"sales_deriv": {
|
|
|
- "value": -490 <2>
|
|
|
+ "value": -490.0 <2>
|
|
|
}
|
|
|
},
|
|
|
{
|
|
@@ -95,10 +101,10 @@ And the following may be the response:
|
|
|
"key": 1425168000000,
|
|
|
"doc_count": 2, <3>
|
|
|
"sales": {
|
|
|
- "value": 375
|
|
|
+ "value": 375.0
|
|
|
},
|
|
|
"sales_deriv": {
|
|
|
- "value": 315
|
|
|
+ "value": 315.0
|
|
|
}
|
|
|
}
|
|
|
]
|
|
@@ -106,21 +112,26 @@ And the following may be the response:
|
|
|
}
|
|
|
}
|
|
|
--------------------------------------------------
|
|
|
+// TESTRESPONSE[s/"took": 11/"took": $body.took/]
|
|
|
+// TESTRESPONSE[s/"_shards": \.\.\./"_shards": $body._shards/]
|
|
|
+// TESTRESPONSE[s/"hits": \.\.\./"hits": $body.hits/]
|
|
|
|
|
|
<1> No derivative for the first bucket since we need at least 2 data points to calculate the derivative
|
|
|
-<2> Derivative value units are implicitly defined by the `sales` aggregation and the parent histogram so in this case the units
|
|
|
+<2> Derivative value units are implicitly defined by the `sales` aggregation and the parent histogram so in this case the units
|
|
|
would be $/month assuming the `price` field has units of $.
|
|
|
<3> The number of documents in the bucket are represented by the `doc_count` f
|
|
|
|
|
|
==== Second Order Derivative
|
|
|
|
|
|
-A second order derivative can be calculated by chaining the derivative pipeline aggregation onto the result of another derivative
|
|
|
-pipeline aggregation as in the following example which will calculate both the first and the second order derivative of the total
|
|
|
+A second order derivative can be calculated by chaining the derivative pipeline aggregation onto the result of another derivative
|
|
|
+pipeline aggregation as in the following example which will calculate both the first and the second order derivative of the total
|
|
|
monthly sales:
|
|
|
|
|
|
[source,js]
|
|
|
--------------------------------------------------
|
|
|
+POST /sales/_search
|
|
|
{
|
|
|
+ "size": 0,
|
|
|
"aggs" : {
|
|
|
"sales_per_month" : {
|
|
|
"date_histogram" : {
|
|
@@ -148,6 +159,8 @@ monthly sales:
|
|
|
}
|
|
|
}
|
|
|
--------------------------------------------------
|
|
|
+// CONSOLE
|
|
|
+// TEST[setup:sales]
|
|
|
|
|
|
<1> `buckets_path` for the second derivative points to the name of the first derivative
|
|
|
|
|
@@ -156,6 +169,10 @@ And the following may be the response:
|
|
|
[source,js]
|
|
|
--------------------------------------------------
|
|
|
{
|
|
|
+ "took": 50,
|
|
|
+ "timed_out": false,
|
|
|
+ "_shards": ...,
|
|
|
+ "hits": ...,
|
|
|
"aggregations": {
|
|
|
"sales_per_month": {
|
|
|
"buckets": [
|
|
@@ -164,7 +181,7 @@ And the following may be the response:
|
|
|
"key": 1420070400000,
|
|
|
"doc_count": 3,
|
|
|
"sales": {
|
|
|
- "value": 550
|
|
|
+ "value": 550.0
|
|
|
} <1>
|
|
|
},
|
|
|
{
|
|
@@ -172,10 +189,10 @@ And the following may be the response:
|
|
|
"key": 1422748800000,
|
|
|
"doc_count": 2,
|
|
|
"sales": {
|
|
|
- "value": 60
|
|
|
+ "value": 60.0
|
|
|
},
|
|
|
"sales_deriv": {
|
|
|
- "value": -490
|
|
|
+ "value": -490.0
|
|
|
} <1>
|
|
|
},
|
|
|
{
|
|
@@ -183,13 +200,13 @@ And the following may be the response:
|
|
|
"key": 1425168000000,
|
|
|
"doc_count": 2,
|
|
|
"sales": {
|
|
|
- "value": 375
|
|
|
+ "value": 375.0
|
|
|
},
|
|
|
"sales_deriv": {
|
|
|
- "value": 315
|
|
|
+ "value": 315.0
|
|
|
},
|
|
|
"sales_2nd_deriv": {
|
|
|
- "value": 805
|
|
|
+ "value": 805.0
|
|
|
}
|
|
|
}
|
|
|
]
|
|
@@ -197,18 +214,24 @@ And the following may be the response:
|
|
|
}
|
|
|
}
|
|
|
--------------------------------------------------
|
|
|
-<1> No second derivative for the first two buckets since we need at least 2 data points from the first derivative to calculate the
|
|
|
+// TESTRESPONSE[s/"took": 50/"took": $body.took/]
|
|
|
+// TESTRESPONSE[s/"_shards": \.\.\./"_shards": $body._shards/]
|
|
|
+// TESTRESPONSE[s/"hits": \.\.\./"hits": $body.hits/]
|
|
|
+
|
|
|
+<1> No second derivative for the first two buckets since we need at least 2 data points from the first derivative to calculate the
|
|
|
second derivative
|
|
|
|
|
|
==== Units
|
|
|
|
|
|
-The derivative aggregation allows the units of the derivative values to be specified. This returns an extra field in the response
|
|
|
-`normalized_value` which reports the derivative value in the desired x-axis units. In the below example we calculate the derivative
|
|
|
+The derivative aggregation allows the units of the derivative values to be specified. This returns an extra field in the response
|
|
|
+`normalized_value` which reports the derivative value in the desired x-axis units. In the below example we calculate the derivative
|
|
|
of the total sales per month but ask for the derivative of the sales as in the units of sales per day:
|
|
|
|
|
|
[source,js]
|
|
|
--------------------------------------------------
|
|
|
+POST /sales/_search
|
|
|
{
|
|
|
+ "size": 0,
|
|
|
"aggs" : {
|
|
|
"sales_per_month" : {
|
|
|
"date_histogram" : {
|
|
@@ -232,7 +255,8 @@ of the total sales per month but ask for the derivative of the sales as in the u
|
|
|
}
|
|
|
}
|
|
|
--------------------------------------------------
|
|
|
-
|
|
|
+// CONSOLE
|
|
|
+// TEST[setup:sales]
|
|
|
<1> `unit` specifies what unit to use for the x-axis of the derivative calculation
|
|
|
|
|
|
And the following may be the response:
|
|
@@ -240,6 +264,10 @@ And the following may be the response:
|
|
|
[source,js]
|
|
|
--------------------------------------------------
|
|
|
{
|
|
|
+ "took": 50,
|
|
|
+ "timed_out": false,
|
|
|
+ "_shards": ...,
|
|
|
+ "hits": ...,
|
|
|
"aggregations": {
|
|
|
"sales_per_month": {
|
|
|
"buckets": [
|
|
@@ -248,7 +276,7 @@ And the following may be the response:
|
|
|
"key": 1420070400000,
|
|
|
"doc_count": 3,
|
|
|
"sales": {
|
|
|
- "value": 550
|
|
|
+ "value": 550.0
|
|
|
} <1>
|
|
|
},
|
|
|
{
|
|
@@ -256,11 +284,11 @@ And the following may be the response:
|
|
|
"key": 1422748800000,
|
|
|
"doc_count": 2,
|
|
|
"sales": {
|
|
|
- "value": 60
|
|
|
+ "value": 60.0
|
|
|
},
|
|
|
"sales_deriv": {
|
|
|
- "value": -490, <1>
|
|
|
- "normalized_value": -17.5 <2>
|
|
|
+ "value": -490.0, <1>
|
|
|
+ "normalized_value": -15.806451612903226 <2>
|
|
|
}
|
|
|
},
|
|
|
{
|
|
@@ -268,11 +296,11 @@ And the following may be the response:
|
|
|
"key": 1425168000000,
|
|
|
"doc_count": 2,
|
|
|
"sales": {
|
|
|
- "value": 375
|
|
|
+ "value": 375.0
|
|
|
},
|
|
|
"sales_deriv": {
|
|
|
- "value": 315,
|
|
|
- "normalized_value": 10.16129032258065
|
|
|
+ "value": 315.0,
|
|
|
+ "normalized_value": 11.25
|
|
|
}
|
|
|
}
|
|
|
]
|
|
@@ -280,5 +308,8 @@ And the following may be the response:
|
|
|
}
|
|
|
}
|
|
|
--------------------------------------------------
|
|
|
+// TESTRESPONSE[s/"took": 50/"took": $body.took/]
|
|
|
+// TESTRESPONSE[s/"_shards": \.\.\./"_shards": $body._shards/]
|
|
|
+// TESTRESPONSE[s/"hits": \.\.\./"hits": $body.hits/]
|
|
|
<1> `value` is reported in the original units of 'per month'
|
|
|
<2> `normalized_value` is reported in the desired units of 'per day'
|