Skip to content
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.

Sign up for GitHub

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

[BucketLevelMonitor] Multi-term agg support #964

Merged
merged 3 commits into from
Jul 11, 2023
Merged

[BucketLevelMonitor] Multi-term agg support #964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
335ed80
added handling of multi-term agg in bucketlevel monitors
petardz Jun 18, 2023
8140965
added handling of multi-term agg in bucketlevel monitors
petardz Jun 18, 2023
79a1a82
added more asserts
petardz Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions alerting/src/main/kotlin/org/opensearch/alerting/TriggerService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@ class TriggerService(val scriptService: ScriptService) {
val keyField = Aggregation.CommonFields.KEY.preferredName
val keyValuesList = mutableListOf<String>()
when {
bucket[keyField] is List<*> && bucket.containsKey(Aggregation.CommonFields.KEY_AS_STRING.preferredName) ->
keyValuesList.add(bucket[Aggregation.CommonFields.KEY_AS_STRING.preferredName] as String)
bucket[keyField] is String -> keyValuesList.add(bucket[keyField] as String)
// In the case where the key field is an Int
bucket[keyField] is Int -> keyValuesList.add(bucket[keyField].toString())
Expand Down
86 changes: 86 additions & 0 deletions alerting/src/test/kotlin/org/opensearch/alerting/MonitorRunnerServiceIT.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,10 @@ import org.opensearch.rest.RestStatus
import org.opensearch.script.Script
import org.opensearch.search.aggregations.bucket.composite.CompositeAggregationBuilder
import org.opensearch.search.aggregations.bucket.composite.TermsValuesSourceBuilder
import org.opensearch.search.aggregations.bucket.terms.MultiTermsAggregationBuilder
import org.opensearch.search.aggregations.bucket.terms.TermsAggregationBuilder
import org.opensearch.search.aggregations.metrics.CardinalityAggregationBuilder
import org.opensearch.search.aggregations.support.MultiTermsValuesSourceConfig
import org.opensearch.search.builder.SearchSourceBuilder
import java.net.URLEncoder
import java.time.Instant
Expand Down Expand Up @@ -1179,6 +1182,89 @@ class MonitorRunnerServiceIT : AlertingRestTestCase() {
assertEquals("Incorrect search result", 2, buckets.size)
}

fun `test execute bucket-level monitor returns search result with multi term agg`() {
val index = "test_index_1234"
indexDoc(
index,
"1",
"""{"user_id": "1",
"ip_addr": "12345678",
"user_agent": "chrome"
}
""".trimIndent()
)
indexDoc(
index,
"2",
"""{"user_id": "2",
"ip_addr": "12345678",
"user_agent": "chrome"
}
""".trimIndent()
)
indexDoc(
index,
"3",
"""{"user_id": "2",
"ip_addr": "3443534",
"user_agent": "chrome"
}
""".trimIndent()
)

val triggerScript = """
params.docCount > 0
""".trimIndent()

var trigger = randomBucketLevelTrigger()
trigger = trigger.copy(
bucketSelector = BucketSelectorExtAggregationBuilder(
name = trigger.id,
bucketsPathsMap = mapOf("_value" to "distinct_user_count", "docCount" to "_count"),
script = Script(triggerScript),
parentBucketPath = "hot",
filter = null
)
)

val m = randomBucketLevelMonitor(
triggers = listOf(trigger),
inputs = listOf(
SearchInput(
listOf(index),
SearchSourceBuilder().aggregation(
MultiTermsAggregationBuilder("hot")
.terms(
listOf(
MultiTermsValuesSourceConfig.Builder().setFieldName("ip_addr.keyword").build(),
MultiTermsValuesSourceConfig.Builder().setFieldName("user_agent.keyword").build()
)
)
.subAggregation(CardinalityAggregationBuilder("distinct_user_count").field("user_id.keyword"))
)
)
)
)
val monitor = createMonitor(m)
val response = executeMonitor(monitor.id, params = DRYRUN_MONITOR)
val output = entityAsMap(response)

assertEquals(monitor.name, output["monitor_name"])
@Suppress("UNCHECKED_CAST")
val searchResult = (output.objectMap("input_results")["results"] as List<Map<String, Any>>).first()
@Suppress("UNCHECKED_CAST")
val buckets = searchResult.stringMap("aggregations")?.stringMap("hot")?.get("buckets") as List<Map<String, Any>>
assertEquals("Incorrect search result", 2, buckets.size)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we check the result to ensure its getting the right values?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

val distinctUserCountAgg1 = buckets.find {
it.get("key_as_string") == "12345678|chrome"
}!!.get("distinct_user_count") as Map<String, Integer>
assertEquals(2, distinctUserCountAgg1.get("value"))
val distinctUserCountAgg2 = buckets.find {
it.get("key_as_string") == "3443534|chrome"
}!!.get("distinct_user_count") as Map<String, Integer>
assertEquals(1, distinctUserCountAgg2.get("value"))
}

fun `test bucket-level monitor alert creation and completion`() {
val testIndex = createTestIndex()
insertSampleTimeSerializedData(
Expand Down