WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Moving Average Holt Winters Aggregation Usage Moving Average Simple Aggregation Usage »

› › ›

Moving Average Linear Aggregation Usage

edit

Moving Average Linear Aggregation Usage

edit

Fluent DSL example

edit

s => s
.Size(0)
.Aggregations(a => a
    .DateHistogram("projects_started_per_month", dh => dh
        .Field(p => p.StartedOn)
        .Interval(DateInterval.Month)
        .Aggregations(aa => aa
            .Sum("commits", sm => sm
                .Field(p => p.NumberOfCommits)
            )
            .MovingAverage("commits_moving_avg", mv => mv
                .BucketsPath("commits")
                .GapPolicy(GapPolicy.InsertZeros)
                .Model(m => m
                    .Linear()
                )
            )
        )
    )
)

Object Initializer syntax example

edit

new SearchRequest<Project>()
{
    Size = 0,
    Aggregations = new DateHistogramAggregation("projects_started_per_month")
    {
        Field = "startedOn",
        Interval = DateInterval.Month,
        Aggregations =
            new SumAggregation("commits", "numberOfCommits") &&
            new MovingAverageAggregation("commits_moving_avg", "commits")
            {
                GapPolicy = GapPolicy.InsertZeros,
                Model = new LinearModel()
            }
    }
}

Example json output.

{
  "size": 0,
  "aggs": {
    "projects_started_per_month": {
      "date_histogram": {
        "field": "startedOn",
        "interval": "month"
      },
      "aggs": {
        "commits": {
          "sum": {
            "field": "numberOfCommits"
          }
        },
        "commits_moving_avg": {
          "moving_avg": {
            "buckets_path": "commits",
            "gap_policy": "insert_zeros",
            "model": "linear",
            "settings": {}
          }
        }
      }
    }
  }
}

Handling Responses

edit

response.ShouldBeValid();

var projectsPerMonth = response.Aggs.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);
}

« Moving Average Holt Winters Aggregation Usage Moving Average Simple Aggregation Usage »