Add parsing methods for Percentiles aggregations #24183
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.elasticsearch.search.aggregations.metrics.percentiles.hdr; | ||
|
|
||
| import org.elasticsearch.common.xcontent.ObjectParser; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.search.aggregations.metrics.percentiles.ParsedPercentiles; | ||
| import org.elasticsearch.search.aggregations.metrics.percentiles.Percentiles; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| public class ParsedHDRPercentiles extends ParsedPercentiles implements Percentiles { | ||
|
|
||
| @Override | ||
| protected String getType() { | ||
| return InternalHDRPercentiles.NAME; | ||
| } | ||
|
|
||
| @Override | ||
| public double percentile(double percent) { | ||
| return getPercentile(percent); | ||
| } | ||
|
|
||
| @Override | ||
| public String percentileAsString(double percent) { | ||
| return getPercentileAsString(percent); | ||
| } | ||
|
|
||
| private static ObjectParser<ParsedHDRPercentiles, Void> PARSER = | ||
| new ObjectParser<>(ParsedHDRPercentiles.class.getSimpleName(), true, ParsedHDRPercentiles::new); | ||
| static { | ||
| ParsedPercentiles.declarePercentilesFields(PARSER); | ||
| } | ||
|
|
||
| public static ParsedHDRPercentiles fromXContent(XContentParser parser, String name) throws IOException { | ||
| ParsedHDRPercentiles aggregation = PARSER.parse(parser, null); | ||
| aggregation.setName(name); | ||
| return aggregation; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.elasticsearch.search.aggregations.metrics.percentiles.tdigest; | ||
|
|
||
| import org.elasticsearch.common.xcontent.ObjectParser; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.search.aggregations.metrics.percentiles.ParsedPercentiles; | ||
| import org.elasticsearch.search.aggregations.metrics.percentiles.Percentiles; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| public class ParsedTDigestPercentiles extends ParsedPercentiles implements Percentiles { | ||
|
|
||
| @Override | ||
| protected String getType() { | ||
| return InternalTDigestPercentiles.NAME; | ||
| } | ||
|
|
||
| @Override | ||
| public double percentile(double percent) { | ||
| return getPercentile(percent); | ||
| } | ||
|
|
||
| @Override | ||
| public String percentileAsString(double percent) { | ||
| return getPercentileAsString(percent); | ||
| } | ||
|
|
||
| private static ObjectParser<ParsedTDigestPercentiles, Void> PARSER = | ||
| new ObjectParser<>(ParsedTDigestPercentiles.class.getSimpleName(), true, ParsedTDigestPercentiles::new); | ||
| static { | ||
| ParsedPercentiles.declarePercentilesFields(PARSER); | ||
| } | ||
|
|
||
| public static ParsedTDigestPercentiles fromXContent(XContentParser parser, String name) throws IOException { | ||
| ParsedTDigestPercentiles aggregation = PARSER.parse(parser, null); | ||
| aggregation.setName(name); | ||
| return aggregation; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.elasticsearch.search.aggregations.metrics.percentiles; | ||
|
|
||
| import com.carrotsearch.randomizedtesting.annotations.Repeat; | ||
| import org.elasticsearch.common.xcontent.XContentType; | ||
| import org.elasticsearch.search.DocValueFormat; | ||
| import org.elasticsearch.search.aggregations.InternalAggregation; | ||
| import org.elasticsearch.search.aggregations.InternalAggregationTestCase; | ||
| import org.elasticsearch.search.aggregations.pipeline.PipelineAggregator; | ||
| import org.junit.Before; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Iterator; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| public abstract class AbstractPercentilesTestCase<T extends InternalAggregation & Iterable<Percentile>> | ||
| extends InternalAggregationTestCase<T> { | ||
|
|
||
| private double[] percents; | ||
| private boolean keyed; | ||
| private DocValueFormat docValueFormat; | ||
|
|
||
| @Before | ||
| public void init() { | ||
| percents = randomPercents(); | ||
| keyed = randomBoolean(); | ||
| docValueFormat = randomNumericDocValueFormat(); | ||
| } | ||
|
|
||
| @Override | ||
| protected T createTestInstance(String name, List<PipelineAggregator> pipelineAggregators, Map<String, Object> metaData) { | ||
| int numValues = randomInt(100); | ||
| double[] values = new double[numValues]; | ||
| for (int i = 0; i < numValues; ++i) { | ||
| values[i] = randomDouble(); | ||
| } | ||
| return createTestInstance(name, pipelineAggregators, metaData, keyed, docValueFormat, percents, values); | ||
|
Member
There was a problem hiding this comment. I'd prefer percents/keyed/docValueFormat to be declared and instantiated here if there is no other reason I am missing atm. |
||
| } | ||
|
|
||
| protected abstract T createTestInstance(String name, List<PipelineAggregator> pipelineAggregators, Map<String, Object> metaData, | ||
| boolean keyed, DocValueFormat format, double[] percents, double[] values); | ||
|
|
||
| protected abstract Class<? extends ParsedPercentiles> implementationClass(); | ||
|
|
||
| @Repeat(iterations = 1000) | ||
| public void testPercentilesIterators() throws IOException { | ||
| final T aggregation = createTestInstance(); | ||
| final Iterable<Percentile> parsedAggregation = parse(aggregation, randomFrom(XContentType.values()), randomBoolean(), false); | ||
|
|
||
| Iterator<Percentile> it = aggregation.iterator(); | ||
| Iterator<Percentile> parsedIt = parsedAggregation.iterator(); | ||
| while (it.hasNext()) { | ||
| assertEquals(it.next(), parsedIt.next()); | ||
| } | ||
| } | ||
|
|
||
| private static double[] randomPercents() { | ||
| List<Double> randomCdfValues = randomSubsetOf(randomIntBetween(1, 7), 0.01d, 0.05d, 0.25d, 0.50d, 0.75d, 0.95d, 0.99d); | ||
| double[] percents = new double[randomCdfValues.size()]; | ||
| for (int i = 0; i < randomCdfValues.size(); i++) { | ||
| percents[i] = randomCdfValues.get(i); | ||
| } | ||
| return percents; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason these three fields need to be test instance members be randomized in the init() method? Otherwise I would prfer making them local in createTestIntstance().
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When reducing percentiles aggregations it is important that all reduced aggregations have the same set of percentiles otherwise the reduce phase will just fail. Before adding the parsing method, the test used a fixed 0.5 percent but I think it's better to have one or more randomized percentiles.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And I find it more rationale that all aggregations have the same
formatandkeyedtoo, because it shouldn't be different from one or the other during the aggregation reducing phase.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, that makes sense. I didn't think about the reducing tests.