org.opensearch.search.aggregations.bucket.histogram.VariableWidthHistogramAggregationBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
Show all versions of opensearch Show documentation
OpenSearch subproject :server
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
package org.opensearch.search.aggregations.bucket.histogram;
import org.opensearch.common.settings.Settings;
import org.opensearch.core.ParseField;
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.core.xcontent.ObjectParser;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.index.query.QueryShardContext;
import org.opensearch.search.aggregations.AggregationBuilder;
import org.opensearch.search.aggregations.AggregatorFactories;
import org.opensearch.search.aggregations.AggregatorFactory;
import org.opensearch.search.aggregations.MultiBucketConsumerService;
import org.opensearch.search.aggregations.support.CoreValuesSourceType;
import org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder;
import org.opensearch.search.aggregations.support.ValuesSourceAggregatorFactory;
import org.opensearch.search.aggregations.support.ValuesSourceConfig;
import org.opensearch.search.aggregations.support.ValuesSourceRegistry;
import org.opensearch.search.aggregations.support.ValuesSourceType;
import java.io.IOException;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
/**
* Aggregation Builder for variable_width_histogram agg
*
* @opensearch.internal
*/
public class VariableWidthHistogramAggregationBuilder extends ValuesSourceAggregationBuilder {
public static final String NAME = "variable_width_histogram";
public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY =
new ValuesSourceRegistry.RegistryKey<>(NAME, VariableWidthHistogramAggregatorSupplier.class);
private static final ParseField NUM_BUCKETS_FIELD = new ParseField("buckets");
private static final ParseField INITIAL_BUFFER_FIELD = new ParseField("initial_buffer");
private static final ParseField SHARD_SIZE_FIELD = new ParseField("shard_size");
public static final ObjectParser PARSER = ObjectParser.fromBuilder(
NAME,
VariableWidthHistogramAggregationBuilder::new
);
static {
ValuesSourceAggregationBuilder.declareFields(PARSER, true, true, true);
PARSER.declareInt(VariableWidthHistogramAggregationBuilder::setNumBuckets, NUM_BUCKETS_FIELD);
PARSER.declareInt(VariableWidthHistogramAggregationBuilder::setShardSize, SHARD_SIZE_FIELD);
PARSER.declareInt(VariableWidthHistogramAggregationBuilder::setInitialBuffer, INITIAL_BUFFER_FIELD);
}
private int numBuckets = 10;
private int shardSize = -1;
private int initialBuffer = -1;
public static void registerAggregators(ValuesSourceRegistry.Builder builder) {
VariableWidthHistogramAggregatorFactory.registerAggregators(builder);
}
/** Create a new builder with the given name. */
public VariableWidthHistogramAggregationBuilder(String name) {
super(name);
}
/** Read in object data from a stream, for internal use only. */
public VariableWidthHistogramAggregationBuilder(StreamInput in) throws IOException {
super(in);
numBuckets = in.readVInt();
}
protected VariableWidthHistogramAggregationBuilder(
VariableWidthHistogramAggregationBuilder clone,
AggregatorFactories.Builder factoriesBuilder,
Map metaData
) {
super(clone, factoriesBuilder, metaData);
this.numBuckets = clone.numBuckets;
}
@Override
protected ValuesSourceType defaultValueSourceType() {
return CoreValuesSourceType.NUMERIC;
}
public VariableWidthHistogramAggregationBuilder setNumBuckets(int numBuckets) {
if (numBuckets <= 0) {
throw new IllegalArgumentException(NUM_BUCKETS_FIELD.getPreferredName() + " must be greater than [0] for [" + name + "]");
}
this.numBuckets = numBuckets;
return this;
}
public VariableWidthHistogramAggregationBuilder setShardSize(int shardSize) {
if (shardSize <= 1) {
// A shard size of 1 will cause divide by 0s and, even if it worked, would produce garbage results.
throw new IllegalArgumentException(SHARD_SIZE_FIELD.getPreferredName() + " must be greater than [1] for [" + name + "]");
}
this.shardSize = shardSize;
return this;
}
public VariableWidthHistogramAggregationBuilder setInitialBuffer(int initialBuffer) {
if (initialBuffer <= 0) {
throw new IllegalArgumentException(INITIAL_BUFFER_FIELD.getPreferredName() + " must be greater than [0] for [" + name + "]");
}
this.initialBuffer = initialBuffer;
return this;
}
public int getNumBuckets() {
return numBuckets;
}
public int getShardSize() {
if (shardSize == -1) {
return numBuckets * 50;
}
return shardSize;
}
public int getInitialBuffer() {
if (initialBuffer == -1) {
return Math.min(10 * getShardSize(), 50000);
}
return initialBuffer;
}
@Override
public BucketCardinality bucketCardinality() {
return BucketCardinality.MANY;
}
@Override
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map metaData) {
return new VariableWidthHistogramAggregationBuilder(this, factoriesBuilder, metaData);
}
@Override
protected void innerWriteTo(StreamOutput out) throws IOException {
out.writeVInt(numBuckets);
}
@Override
protected ValuesSourceAggregatorFactory innerBuild(
QueryShardContext queryShardContext,
ValuesSourceConfig config,
AggregatorFactory parent,
AggregatorFactories.Builder subFactoriesBuilder
) throws IOException {
Settings settings = queryShardContext.getIndexSettings().getNodeSettings();
int maxBuckets = MultiBucketConsumerService.MAX_BUCKET_SETTING.get(settings);
if (numBuckets > maxBuckets) {
throw new IllegalArgumentException(NUM_BUCKETS_FIELD.getPreferredName() + " must be less than " + maxBuckets);
}
int initialBuffer = getInitialBuffer();
int shardSize = getShardSize();
if (initialBuffer < numBuckets) {
// If numBuckets buckets are being returned, then at least that many must be stored in memory
throw new IllegalArgumentException(
String.format(
Locale.ROOT,
"%s must be at least %s but was [%s<%s] for [%s]",
INITIAL_BUFFER_FIELD.getPreferredName(),
NUM_BUCKETS_FIELD.getPreferredName(),
initialBuffer,
numBuckets,
name
)
);
}
int mergePhaseInit = VariableWidthHistogramAggregator.mergePhaseInitialBucketCount(shardSize);
if (mergePhaseInit < numBuckets) {
// If the initial buckets from the merge phase is super low we will consistently return too few buckets
throw new IllegalArgumentException(
"3/4 of "
+ SHARD_SIZE_FIELD.getPreferredName()
+ " must be at least "
+ NUM_BUCKETS_FIELD.getPreferredName()
+ " but was ["
+ mergePhaseInit
+ "<"
+ numBuckets
+ "] for ["
+ name
+ "]"
);
}
return new VariableWidthHistogramAggregatorFactory(
name,
config,
numBuckets,
shardSize,
initialBuffer,
queryShardContext,
parent,
subFactoriesBuilder,
metadata
);
}
@Override
protected XContentBuilder doXContentBody(XContentBuilder builder, Params params) throws IOException {
builder.field(NUM_BUCKETS_FIELD.getPreferredName(), numBuckets);
return builder;
}
@Override
public int hashCode() {
return Objects.hash(super.hashCode(), numBuckets, shardSize, initialBuffer);
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null || getClass() != obj.getClass()) return false;
if (super.equals(obj) == false) return false;
VariableWidthHistogramAggregationBuilder other = (VariableWidthHistogramAggregationBuilder) obj;
return Objects.equals(numBuckets, other.numBuckets)
&& Objects.equals(shardSize, other.shardSize)
&& Objects.equals(initialBuffer, other.initialBuffer);
}
@Override
public String getType() {
return NAME;
}
@Override
protected ValuesSourceRegistry.RegistryKey getRegistryKey() {
return REGISTRY_KEY;
}
}