-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor Monitor and Trigger to split into Query-Level and Bucket-Lev… (
#150) * Refactor Monitor and Trigger to split into Query-Level and Bucket-Level Monitors Signed-off-by: Mohammad Qureshi <[email protected]> * Require condition to not be null when parsing Bucket-Level Trigger Signed-off-by: Mohammad Qureshi <[email protected]>
- Loading branch information
Showing
38 changed files
with
1,579 additions
and
460 deletions.
There are no files selected for viewing
This file contains 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 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 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
152 changes: 152 additions & 0 deletions
152
alerting/src/main/kotlin/org/opensearch/alerting/model/BucketLevelTrigger.kt
This file contains 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,152 @@ | ||
| /* | ||
| * 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.model | ||
|
|
||
| import org.opensearch.alerting.aggregation.bucketselectorext.BucketSelectorExtAggregationBuilder | ||
| import org.opensearch.alerting.model.Trigger.Companion.ACTIONS_FIELD | ||
| import org.opensearch.alerting.model.Trigger.Companion.ID_FIELD | ||
| import org.opensearch.alerting.model.Trigger.Companion.NAME_FIELD | ||
| import org.opensearch.alerting.model.Trigger.Companion.SEVERITY_FIELD | ||
| import org.opensearch.alerting.model.action.Action | ||
| import org.opensearch.common.CheckedFunction | ||
| import org.opensearch.common.ParseField | ||
| import org.opensearch.common.UUIDs | ||
| import org.opensearch.common.io.stream.StreamInput | ||
| import org.opensearch.common.io.stream.StreamOutput | ||
| import org.opensearch.common.xcontent.NamedXContentRegistry | ||
| import org.opensearch.common.xcontent.ToXContent | ||
| import org.opensearch.common.xcontent.XContentBuilder | ||
| import org.opensearch.common.xcontent.XContentParser | ||
| import org.opensearch.common.xcontent.XContentParser.Token | ||
| import org.opensearch.common.xcontent.XContentParserUtils.ensureExpectedToken | ||
| import java.io.IOException | ||
|
|
||
| /** | ||
| * A multi-alert Trigger available with Bucket-Level Monitors that filters aggregation buckets via a pipeline | ||
| * aggregator. | ||
| */ | ||
| data class BucketLevelTrigger( | ||
| override val id: String = UUIDs.base64UUID(), | ||
| override val name: String, | ||
| override val severity: String, | ||
| val bucketSelector: BucketSelectorExtAggregationBuilder, | ||
| override val actions: List<Action> | ||
| ) : Trigger { | ||
|
|
||
| @Throws(IOException::class) | ||
| constructor(sin: StreamInput): this( | ||
| sin.readString(), // id | ||
| sin.readString(), // name | ||
| sin.readString(), // severity | ||
| BucketSelectorExtAggregationBuilder(sin), // condition | ||
| sin.readList(::Action) // actions | ||
| ) | ||
|
|
||
| override fun toXContent(builder: XContentBuilder, params: ToXContent.Params): XContentBuilder { | ||
| builder.startObject() | ||
| .startObject(BUCKET_LEVEL_TRIGGER_FIELD) | ||
| .field(ID_FIELD, id) | ||
| .field(NAME_FIELD, name) | ||
| .field(SEVERITY_FIELD, severity) | ||
| .startObject(CONDITION_FIELD) | ||
| bucketSelector.internalXContent(builder, params) | ||
| builder.endObject() | ||
| .field(ACTIONS_FIELD, actions.toTypedArray()) | ||
| .endObject() | ||
| .endObject() | ||
| return builder | ||
| } | ||
|
|
||
| override fun name(): String { | ||
| return BUCKET_LEVEL_TRIGGER_FIELD | ||
| } | ||
|
|
||
| @Throws(IOException::class) | ||
| override fun writeTo(out: StreamOutput) { | ||
| out.writeString(id) | ||
| out.writeString(name) | ||
| out.writeString(severity) | ||
| bucketSelector.writeTo(out) | ||
| out.writeCollection(actions) | ||
| } | ||
|
|
||
| fun asTemplateArg(): Map<String, Any> { | ||
| return mapOf( | ||
| ID_FIELD to id, | ||
| NAME_FIELD to name, | ||
| SEVERITY_FIELD to severity, | ||
| ACTIONS_FIELD to actions.map { it.asTemplateArg() }, | ||
| PARENT_BUCKET_PATH to getParentBucketPath() | ||
| ) | ||
| } | ||
|
|
||
| fun getParentBucketPath(): String { | ||
| return bucketSelector.parentBucketPath | ||
| } | ||
|
|
||
| companion object { | ||
| const val BUCKET_LEVEL_TRIGGER_FIELD = "bucket_level_trigger" | ||
| const val CONDITION_FIELD = "condition" | ||
| const val PARENT_BUCKET_PATH = "parentBucketPath" | ||
|
|
||
| val XCONTENT_REGISTRY = NamedXContentRegistry.Entry(Trigger::class.java, ParseField(BUCKET_LEVEL_TRIGGER_FIELD), | ||
| CheckedFunction { parseInner(it) }) | ||
|
|
||
| @JvmStatic | ||
| @Throws(IOException::class) | ||
| fun parseInner(xcp: XContentParser): BucketLevelTrigger { | ||
| var id = UUIDs.base64UUID() // assign a default triggerId if one is not specified | ||
| lateinit var name: String | ||
| lateinit var severity: String | ||
| val actions: MutableList<Action> = mutableListOf() | ||
| ensureExpectedToken(Token.START_OBJECT, xcp.currentToken(), xcp) | ||
| lateinit var bucketSelector: BucketSelectorExtAggregationBuilder | ||
|
|
||
| while (xcp.nextToken() != Token.END_OBJECT) { | ||
| val fieldName = xcp.currentName() | ||
|
|
||
| xcp.nextToken() | ||
| when (fieldName) { | ||
| ID_FIELD -> id = xcp.text() | ||
| NAME_FIELD -> name = xcp.text() | ||
| SEVERITY_FIELD -> severity = xcp.text() | ||
| CONDITION_FIELD -> { | ||
| // Using the trigger id as the name in the bucket selector since it is validated for uniqueness within Monitors. | ||
| // The contents of the trigger definition are round-tripped through parse and toXContent during Monitor creation | ||
| // ensuring that the id is available here in the version of the Monitor object that will be executed, even if the | ||
| // user submitted a custom trigger id after the condition definition. | ||
| bucketSelector = BucketSelectorExtAggregationBuilder.parse(id, xcp) | ||
| } | ||
| ACTIONS_FIELD -> { | ||
| ensureExpectedToken(Token.START_ARRAY, xcp.currentToken(), xcp) | ||
| while (xcp.nextToken() != Token.END_ARRAY) { | ||
| actions.add(Action.parse(xcp)) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return BucketLevelTrigger( | ||
| id = requireNotNull(id) { "Trigger id is null." }, | ||
| name = requireNotNull(name) { "Trigger name is null" }, | ||
| severity = requireNotNull(severity) { "Trigger severity is null" }, | ||
| bucketSelector = requireNotNull(bucketSelector) { "Trigger condition is null" }, | ||
| actions = requireNotNull(actions) { "Trigger actions are null" }) | ||
| } | ||
|
|
||
| @JvmStatic | ||
| @Throws(IOException::class) | ||
| fun readFrom(sin: StreamInput): BucketLevelTrigger { | ||
| return BucketLevelTrigger(sin) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.