IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Moving Percentiles Aggregation Usage Percentiles Bucket Aggregation Usage »
Elastic Docs ›Elasticsearch .NET Clients [7.17] ›Aggregations ›Pipeline Aggregations

Normalize Aggregation Usage

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Normalize Aggregation Usage

edit

A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value. Values that cannot be normalized, will be skipped using the skip gap policy.

Valid for Elasticsearch 7.9.0+ with at least basic license level

Fluent DSL example

edit
a => a
.DateHistogram("projects_started_per_month", dh => dh
    .Field(p => p.StartedOn)
    .CalendarInterval(DateInterval.Month)
    .Aggregations(aa => aa
        .Sum("commits", sm => sm
            .Field(p => p.NumberOfCommits)
        )
        .Normalize("percent_of_commits", aaa => aaa
            .BucketsPath("commits")
            .Method(NormalizeMethod.PercentOfSum)
            .Format("00.00%")
        )
    )
)

Object Initializer syntax example

edit
new DateHistogramAggregation("projects_started_per_month")
{
    Field = "startedOn",
    CalendarInterval = DateInterval.Month,
    Aggregations = new SumAggregation("commits", "numberOfCommits") &&
        new NormalizeAggregation("percent_of_commits", "commits")
        {
            Method = NormalizeMethod.PercentOfSum,
            Format = "00.00%"
        }
}

Example json output.

{
  "projects_started_per_month": {
    "date_histogram": {
      "field": "startedOn",
      "calendar_interval": "month"
    },
    "aggs": {
      "commits": {
        "sum": {
          "field": "numberOfCommits"
        }
      },
      "percent_of_commits": {
        "normalize": {
          "buckets_path": "commits",
          "method": "percent_of_sum",
          "format": "00.00%"
        }
      }
    }
  }
}

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);

foreach (var bucket in projectsPerMonth.Buckets)
{
    var normalize = bucket.Normalize("percent_of_commits");
    normalize.Value.Should().BeGreaterOrEqualTo(0);
    normalize.ValueAsString.Should().NotBeNullOrEmpty();
}
« Moving Percentiles Aggregation Usage Percentiles Bucket Aggregation Usage »