IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Moving Average Ewma Aggregation Usage
editMoving Average Ewma Aggregation Usage
editFluent DSL example
edita => a
.DateHistogram("projects_started_per_month", dh => dh
.Field(p => p.StartedOn)
.Interval(DateInterval.Month)
.MinimumDocumentCount(0)
.Aggregations(aa => aa
.Sum("commits", sm => sm
.Field(p => p.NumberOfCommits)
)
.MovingAverage("commits_moving_avg", mv => mv
.BucketsPath("commits")
.Model(m => m
.Ewma(e => e
.Alpha(0.3f)
)
)
)
)
)
Object Initializer syntax example
editnew DateHistogramAggregation("projects_started_per_month")
{
Field = "startedOn",
Interval = DateInterval.Month,
MinimumDocumentCount = 0,
Aggregations =
new SumAggregation("commits", "numberOfCommits")
&& new MovingAverageAggregation("commits_moving_avg", "commits")
{
Model = new EwmaModel
{
Alpha = 0.3f,
}
}
}
Example json output.
{
"projects_started_per_month": {
"date_histogram": {
"field": "startedOn",
"interval": "month",
"min_doc_count": 0
},
"aggs": {
"commits": {
"sum": {
"field": "numberOfCommits"
}
},
"commits_moving_avg": {
"moving_avg": {
"buckets_path": "commits",
"model": "ewma",
"settings": {
"alpha": 0.3
}
}
}
}
}
}
Handling Responses
editresponse.ShouldBeValid();
var projectsPerMonth = response.Aggregations.DateHistogram("projects_started_per_month");
projectsPerMonth.Should().NotBeNull();
projectsPerMonth.Buckets.Should().NotBeNull();
projectsPerMonth.Buckets.Count.Should().BeGreaterThan(0);
// average not calculated for the first bucket
foreach (var item in projectsPerMonth.Buckets.Skip(1))
{
var movingAvg = item.MovingAverage("commits_moving_avg");
movingAvg.Should().NotBeNull();
movingAvg.Value.Should().BeGreaterThan(0);
}