IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Normalize Aggregation Usage Serial Differencing Aggregation Usage »

› › ›

Percentiles Bucket Aggregation Usage

edit

Percentiles Bucket Aggregation Usage

edit

Fluent DSL example

edit

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)
        )
    )
)
.PercentilesBucket("commits_outlier", aaa => aaa
    .BucketsPath("projects_started_per_month>commits")
    .Percents(95, 99, 99.9)
)

Object Initializer syntax example

edit

new DateHistogramAggregation("projects_started_per_month")
{
    Field = "startedOn",
    Interval = DateInterval.Month,
    Aggregations = new SumAggregation("commits", "numberOfCommits")
}
&& new PercentilesBucketAggregation("commits_outlier", "projects_started_per_month>commits")
{
    Percents = new[] { 95, 99, 99.9 }
}

Example json output.

{
  "projects_started_per_month": {
    "date_histogram": {
      "field": "startedOn",
      "interval": "month"
    },
    "aggs": {
      "commits": {
        "sum": {
          "field": "numberOfCommits"
        }
      }
    }
  },
  "commits_outlier": {
    "percentiles_bucket": {
      "buckets_path": "projects_started_per_month>commits",
      "percents": [
        95.0,
        99.0,
        99.9
      ]
    }
  }
}

Handling Responses

edit

response.ShouldBeValid();

var projectsPerMonth = response.Aggregations.DateHistogram("projects_started_per_month");
projectsPerMonth.Should().NotBeNull();
projectsPerMonth.Buckets.Should().NotBeNull();
projectsPerMonth.Buckets.Count.Should().BeGreaterThan(0);

var commitsOutlier = response.Aggregations.PercentilesBucket("commits_outlier");
commitsOutlier.Should().NotBeNull();
commitsOutlier.Items.Should().NotBeNullOrEmpty();
foreach (var item in commitsOutlier.Items)
    item.Value.Should().BeGreaterThan(0);

« Normalize Aggregation Usage Serial Differencing Aggregation Usage »