-
Notifications
You must be signed in to change notification settings - Fork 124
Update InputService for Bucket-Level Alerting #152
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
92 changes: 92 additions & 0 deletions
92
alerting/src/main/kotlin/org/opensearch/alerting/util/AggregationQueryRewriter.kt
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,92 @@ | ||
| /* | ||
| * 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. | ||
| * | ||
| * Modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| package org.opensearch.alerting.util | ||
|
|
||
| import org.opensearch.alerting.model.BucketLevelTrigger | ||
| import org.opensearch.alerting.model.InputRunResults | ||
| import org.opensearch.alerting.model.Trigger | ||
| import org.opensearch.action.search.SearchResponse | ||
| import org.opensearch.search.aggregations.AggregationBuilder | ||
| import org.opensearch.search.aggregations.AggregatorFactories | ||
| import org.opensearch.search.aggregations.bucket.SingleBucketAggregation | ||
| import org.opensearch.search.aggregations.bucket.composite.CompositeAggregation | ||
| import org.opensearch.search.aggregations.bucket.composite.CompositeAggregationBuilder | ||
| import org.opensearch.search.aggregations.support.AggregationPath | ||
| import org.opensearch.search.builder.SearchSourceBuilder | ||
|
|
||
| class AggregationQueryRewriter { | ||
|
|
||
| companion object { | ||
| /** | ||
| * Add the bucket selector conditions for each trigger in input query. It also adds afterKeys from previous result | ||
| * for each trigger. | ||
| */ | ||
| fun rewriteQuery(query: SearchSourceBuilder, prevResult: InputRunResults?, triggers: List<Trigger>) { | ||
| triggers.forEach { trigger -> | ||
| if (trigger is BucketLevelTrigger) { | ||
| // add bucket selector pipeline aggregation for each trigger in query | ||
| query.aggregation(trigger.bucketSelector) | ||
| // if this request is processing the subsequent pages of input query result, then add after key | ||
| if (prevResult?.aggTriggersAfterKey?.get(trigger.id) != null) { | ||
| val parentBucketPath = AggregationPath.parse(trigger.bucketSelector.parentBucketPath) | ||
| var aggBuilders = (query.aggregations() as AggregatorFactories.Builder).aggregatorFactories | ||
| var factory: AggregationBuilder? = null | ||
| for (i in 0 until parentBucketPath.pathElements.size) { | ||
| factory = null | ||
| for (aggFactory in aggBuilders) { | ||
| if (aggFactory.name.equals(parentBucketPath.pathElements[i].name)) { | ||
| aggBuilders = aggFactory.subAggregations | ||
| factory = aggFactory | ||
| break | ||
| } | ||
| } | ||
| if (factory == null) { | ||
| throw IllegalArgumentException("ParentBucketPath: $parentBucketPath not found in input query results") | ||
| } | ||
| } | ||
| if (factory is CompositeAggregationBuilder) { | ||
| // if the afterKey from previous result is null, what does it signify? | ||
| // A) result set exhausted OR B) first page ? | ||
| val afterKey = prevResult.aggTriggersAfterKey[trigger.id] | ||
| factory.aggregateAfter(afterKey) | ||
| } else { | ||
| throw IllegalStateException("AfterKeys are not expected to be present in non CompositeAggregationBuilder") | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * For each trigger, returns the after keys if present in query result. | ||
| */ | ||
| fun getAfterKeysFromSearchResponse(searchResponse: SearchResponse, triggers: List<Trigger>): Map<String, Map<String, Any>?> { | ||
| val aggTriggerAfterKeys = mutableMapOf<String, Map<String, Any>?>() | ||
| triggers.forEach { trigger -> | ||
| if (trigger is BucketLevelTrigger) { | ||
| val parentBucketPath = AggregationPath.parse(trigger.bucketSelector.parentBucketPath) | ||
| var aggs = searchResponse.aggregations | ||
| // assuming all intermediate aggregations as SingleBucketAggregation | ||
| for (i in 0 until parentBucketPath.pathElements.size - 1) { | ||
| aggs = (aggs.asMap()[parentBucketPath.pathElements[i].name] as SingleBucketAggregation).aggregations | ||
| } | ||
| val lastAgg = aggs.asMap[parentBucketPath.pathElements.last().name] | ||
| // if leaf is CompositeAggregation, then fetch afterKey if present | ||
| if (lastAgg is CompositeAggregation) { | ||
| aggTriggerAfterKeys[trigger.id] = lastAgg.afterKey() | ||
| } | ||
| } | ||
| } | ||
| return aggTriggerAfterKeys | ||
| } | ||
| } | ||
| } |
156 changes: 156 additions & 0 deletions
156
alerting/src/test/kotlin/org/opensearch/alerting/util/AggregationQueryRewriterTests.kt
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,156 @@ | ||
| /* | ||
| * 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. | ||
| * | ||
| * Modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| package org.opensearch.alerting.util | ||
|
|
||
| import org.opensearch.alerting.model.InputRunResults | ||
| import org.opensearch.alerting.model.Trigger | ||
| import org.opensearch.alerting.randomBucketLevelTrigger | ||
| import org.opensearch.alerting.randomQueryLevelTrigger | ||
| import org.opensearch.action.search.SearchResponse | ||
| import org.opensearch.cluster.ClusterModule | ||
| import org.opensearch.common.CheckedFunction | ||
| import org.opensearch.common.ParseField | ||
| import org.opensearch.common.xcontent.NamedXContentRegistry | ||
| import org.opensearch.common.xcontent.XContentParser | ||
| import org.opensearch.common.xcontent.json.JsonXContent | ||
| import org.opensearch.search.aggregations.Aggregation | ||
| import org.opensearch.search.aggregations.AggregationBuilder | ||
| import org.opensearch.search.aggregations.bucket.composite.CompositeAggregationBuilder | ||
| import org.opensearch.search.aggregations.bucket.composite.ParsedComposite | ||
| import org.opensearch.search.aggregations.bucket.composite.TermsValuesSourceBuilder | ||
| import org.opensearch.search.aggregations.bucket.terms.TermsAggregationBuilder | ||
| import org.opensearch.search.builder.SearchSourceBuilder | ||
| import org.opensearch.test.OpenSearchTestCase | ||
| import org.junit.Assert | ||
| import java.io.IOException | ||
|
|
||
| class AggregationQueryRewriterTests : OpenSearchTestCase() { | ||
|
|
||
| fun `test RewriteQuery empty previous result`() { | ||
| val triggers: MutableList<Trigger> = mutableListOf() | ||
| for (i in 0 until 10) { | ||
| triggers.add(randomBucketLevelTrigger()) | ||
| } | ||
| val queryBuilder = SearchSourceBuilder() | ||
| val termAgg: AggregationBuilder = TermsAggregationBuilder("testPath").field("sports") | ||
| queryBuilder.aggregation(termAgg) | ||
| val prevResult = null | ||
| AggregationQueryRewriter.rewriteQuery(queryBuilder, prevResult, triggers) | ||
| Assert.assertEquals(queryBuilder.aggregations().pipelineAggregatorFactories.size, 10) | ||
| } | ||
|
|
||
| fun `skip test RewriteQuery with non-empty previous result`() { | ||
| val triggers: MutableList<Trigger> = mutableListOf() | ||
| for (i in 0 until 10) { | ||
| triggers.add(randomBucketLevelTrigger()) | ||
| } | ||
| val queryBuilder = SearchSourceBuilder() | ||
| val termAgg: AggregationBuilder = CompositeAggregationBuilder( | ||
| "testPath", | ||
| listOf(TermsValuesSourceBuilder("k1"), TermsValuesSourceBuilder("k2")) | ||
| ) | ||
| queryBuilder.aggregation(termAgg) | ||
| val aggTriggersAfterKey = mutableMapOf<String, Map<String, Any>?>() | ||
| for (trigger in triggers) { | ||
| aggTriggersAfterKey[trigger.id] = hashMapOf(Pair("k1", "v1"), Pair("k2", "v2")) | ||
| } | ||
| val prevResult = InputRunResults(emptyList(), null, aggTriggersAfterKey) | ||
| AggregationQueryRewriter.rewriteQuery(queryBuilder, prevResult, triggers) | ||
| Assert.assertEquals(queryBuilder.aggregations().pipelineAggregatorFactories.size, 10) | ||
| queryBuilder.aggregations().aggregatorFactories.forEach { | ||
| if (it.name.equals("testPath")) { | ||
| // val compAgg = it as CompositeAggregationBuilder | ||
| // TODO: This is calling forbidden API and causing build failures, need to find an alternative | ||
| // instead of trying to access private member variables | ||
| // val afterField = CompositeAggregationBuilder::class.java.getDeclaredField("after") | ||
| // afterField.isAccessible = true | ||
| // Assert.assertEquals(afterField.get(compAgg), hashMapOf(Pair("k1", "v1"), Pair("k2", "v2"))) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fun `test RewriteQuery with non aggregation trigger`() { | ||
| val triggers: MutableList<Trigger> = mutableListOf() | ||
| for (i in 0 until 10) { | ||
| triggers.add(randomQueryLevelTrigger()) | ||
| } | ||
| val queryBuilder = SearchSourceBuilder() | ||
| val termAgg: AggregationBuilder = TermsAggregationBuilder("testPath").field("sports") | ||
| queryBuilder.aggregation(termAgg) | ||
| val prevResult = null | ||
| AggregationQueryRewriter.rewriteQuery(queryBuilder, prevResult, triggers) | ||
| Assert.assertEquals(queryBuilder.aggregations().pipelineAggregatorFactories.size, 0) | ||
| } | ||
|
|
||
| fun `test after keys from search response`() { | ||
| val responseContent = """ | ||
| { | ||
| "took" : 97, | ||
| "timed_out" : false, | ||
| "_shards" : { | ||
| "total" : 3, | ||
| "successful" : 3, | ||
| "skipped" : 0, | ||
| "failed" : 0 | ||
| }, | ||
| "hits" : { | ||
| "total" : { | ||
| "value" : 20, | ||
| "relation" : "eq" | ||
| }, | ||
| "max_score" : null, | ||
| "hits" : [ ] | ||
| }, | ||
| "aggregations" : { | ||
| "composite#testPath" : { | ||
| "after_key" : { | ||
| "sport" : "Basketball" | ||
| }, | ||
| "buckets" : [ | ||
| { | ||
| "key" : { | ||
| "sport" : "Basketball" | ||
| }, | ||
| "doc_count" : 5 | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| """.trimIndent() | ||
|
|
||
| val aggTriggers: MutableList<Trigger> = mutableListOf(randomBucketLevelTrigger()) | ||
| val tradTriggers: MutableList<Trigger> = mutableListOf(randomQueryLevelTrigger()) | ||
|
|
||
| val searchResponse = SearchResponse.fromXContent(createParser(JsonXContent.jsonXContent, responseContent)) | ||
| val afterKeys = AggregationQueryRewriter.getAfterKeysFromSearchResponse(searchResponse, aggTriggers) | ||
| Assert.assertEquals(afterKeys[aggTriggers[0].id], hashMapOf(Pair("sport", "Basketball"))) | ||
|
|
||
| val afterKeys2 = AggregationQueryRewriter.getAfterKeysFromSearchResponse(searchResponse, tradTriggers) | ||
| Assert.assertEquals(afterKeys2.size, 0) | ||
| } | ||
|
|
||
| override fun xContentRegistry(): NamedXContentRegistry { | ||
| val entries = ClusterModule.getNamedXWriteables() | ||
| entries.add( | ||
| NamedXContentRegistry.Entry( | ||
| Aggregation::class.java, ParseField(CompositeAggregationBuilder.NAME), | ||
| CheckedFunction<XContentParser, ParsedComposite, IOException> { parser: XContentParser? -> | ||
| ParsedComposite.fromXContent( | ||
| parser, "testPath" | ||
| ) | ||
| } | ||
| ) | ||
| ) | ||
| return NamedXContentRegistry(entries) | ||
| } | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.