removing action execution results from alertV2 and other cleanup

Author: toepkerd-zz

src/main/kotlin/org/opensearch/commons/alerting/model/AlertV2.kt

@@ -35,6 +35,7 @@ import org.opensearch.core.xcontent.XContentParser
 import org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken
 import java.io.IOException
 import java.time.Instant
+import org.opensearch.commons.alerting.util.nonOptionalTimeField
 
 data class AlertV2(
     val id: String = NO_ID,
@@ -47,10 +48,10 @@ data class AlertV2(
     val triggerId: String,
     val triggerName: String,
     val queryResults: Map<String, Any>,
+    val triggeredTime: Instant,
     val expirationTime: Instant?,
     val errorMessage: String? = null,
     val severity: String,
-    val actionExecutionResults: List<ActionExecutionResult>,
     val executionId: String? = null
 ) : Writeable, ToXContent {
     @Throws(IOException::class)
@@ -69,10 +70,10 @@ data class AlertV2(
         triggerId = sin.readString(),
         triggerName = sin.readString(),
         queryResults = sin.readMap()!!.toMap(),
+        triggeredTime = sin.readInstant(),
         expirationTime = sin.readOptionalInstant(),
         errorMessage = sin.readOptionalString(),
         severity = sin.readString(),
-        actionExecutionResults = sin.readList(::ActionExecutionResult),
         executionId = sin.readOptionalString()
     )
 
@@ -89,10 +90,10 @@ data class AlertV2(
         out.writeString(triggerId)
         out.writeString(triggerName)
         out.writeMap(queryResults)
+        out.writeInstant(triggeredTime)
         out.writeOptionalInstant(expirationTime)
         out.writeOptionalString(errorMessage)
         out.writeString(severity)
-        out.writeCollection(actionExecutionResults)
         out.writeOptionalString(executionId)
     }
 
@@ -110,7 +111,7 @@ data class AlertV2(
             .field(QUERY_RESULTS_FIELD, queryResults)
             .field(ERROR_MESSAGE_FIELD, errorMessage)
             .field(SEVERITY_FIELD, severity)
-            .field(ACTION_EXECUTION_RESULTS_FIELD, actionExecutionResults.toTypedArray())
+            .nonOptionalTimeField(TRIGGERED_TIME_FIELD, triggeredTime)
             .optionalTimeField(EXPIRATION_TIME_FIELD, expirationTime)
             .endObject()
 
@@ -133,6 +134,7 @@ data class AlertV2(
     }
 
     companion object {
+        const val TRIGGERED_TIME_FIELD = "triggered_time"
         const val EXPIRATION_TIME_FIELD = "expiration_time"
         const val QUERY_RESULTS_FIELD = "query_results"
 
@@ -149,6 +151,7 @@ data class AlertV2(
             lateinit var triggerName: String
             var queryResults: Map<String, Any> = mapOf()
             lateinit var severity: String
+            var triggeredTime: Instant? = null
             var expirationTime: Instant? = null
             var errorMessage: String? = null
             var executionId: String? = null
@@ -173,6 +176,7 @@ data class AlertV2(
                     TRIGGER_ID_FIELD -> triggerId = xcp.text()
                     TRIGGER_NAME_FIELD -> triggerName = xcp.text()
                     QUERY_RESULTS_FIELD -> queryResults = xcp.map()
+                    TRIGGERED_TIME_FIELD -> triggeredTime = xcp.instant()
                     EXPIRATION_TIME_FIELD -> expirationTime = xcp.instant()
                     ERROR_MESSAGE_FIELD -> errorMessage = xcp.textOrNull()
                     EXECUTION_ID_FIELD -> executionId = xcp.textOrNull()
@@ -197,10 +201,10 @@ data class AlertV2(
                 triggerId = requireNotNull(triggerId),
                 triggerName = requireNotNull(triggerName),
                 queryResults = requireNotNull(queryResults),
+                triggeredTime = requireNotNull(triggeredTime),
                 expirationTime = expirationTime,
                 errorMessage = errorMessage,
                 severity = severity,
-                actionExecutionResults = actionExecutionResults,
                 executionId = executionId
             )
         }

src/main/kotlin/org/opensearch/commons/alerting/model/MonitorV2RunResult.kt

@@ -60,10 +60,5 @@ interface MonitorV2RunResult<out TriggerV2Result : TriggerV2RunResult> : Writeab
                 }
             }
         }
-
-        @Suppress("UNCHECKED_CAST")
-        fun suppressWarning(map: MutableMap<String?, Any?>?): Map<String, TriggerV2RunResult> {
-            return map as Map<String, TriggerV2RunResult>
-        }
     }
 }

src/main/kotlin/org/opensearch/commons/alerting/model/PPLMonitor.kt

@@ -32,10 +32,10 @@ import java.time.Instant
 private val logger = LogManager.getLogger(PPLMonitor::class.java)
 
 // TODO: probably change this to be called PPLSQLMonitor. A PPL Monitor and SQL Monitor
-// TODO: would have the exact same functionality, except the choice of language
-// TODO: when calling PPL/SQL plugin's execute API would be different.
-// TODO: we dont need 2 different monitor types for that, just a simple if check
-// TODO: for query language at monitor execution time
+// would have the exact same functionality, except the choice of language
+// when calling PPL/SQL plugin's execute API would be different.
+// we dont need 2 different monitor types for that, just a simple if check
+// for query language at monitor execution time
 data class PPLMonitor(
     override val id: String = NO_ID,
     override val version: Long = NO_VERSION,

src/main/kotlin/org/opensearch/commons/alerting/model/PPLMonitorRunResult.kt

@@ -1,12 +1,10 @@
 package org.opensearch.commons.alerting.model
 
-import org.opensearch.commons.alerting.alerts.AlertError
 import org.opensearch.commons.alerting.model.MonitorV2RunResult.Companion.ERROR_FIELD
 import org.opensearch.commons.alerting.model.MonitorV2RunResult.Companion.MONITOR_NAME_FIELD
 import org.opensearch.commons.alerting.model.MonitorV2RunResult.Companion.PERIOD_END_FIELD
 import org.opensearch.commons.alerting.model.MonitorV2RunResult.Companion.PERIOD_START_FIELD
 import org.opensearch.commons.alerting.model.MonitorV2RunResult.Companion.TRIGGER_RESULTS_FIELD
-import org.opensearch.commons.alerting.model.MonitorV2RunResult.Companion.suppressWarning
 import org.opensearch.commons.alerting.util.nonOptionalTimeField
 import org.opensearch.core.common.io.stream.StreamInput
 import org.opensearch.core.common.io.stream.StreamOutput
@@ -31,8 +29,8 @@ data class PPLMonitorRunResult(
         sin.readException(), // error
         sin.readInstant(), // periodStart
         sin.readInstant(), // periodEnd
-        suppressWarning(sin.readMap()) as Map<String, PPLTriggerRunResult>, // triggerResults
-        sin.readMap() as Map<String, Map<String, Any?>> // pplQueryResults // TODO: if this works, delete suppressWarning call above
+        sin.readMap() as Map<String, PPLTriggerRunResult>, // triggerResults
+        sin.readMap() as Map<String, Map<String, Any?>> // pplQueryResults
     )
 
     override fun toXContent(builder: XContentBuilder, params: ToXContent.Params): XContentBuilder {
@@ -57,15 +55,6 @@ data class PPLMonitorRunResult(
         out.writeMap(pplQueryResults)
     }
 
-    // TODO: does this need any PPLMonitor specific logic, or can this just be deleted
-    override fun alertError(): AlertError? {
-        if (error != null) {
-            return AlertError(Instant.now(), "Failed running monitor:\n${error.userErrorMessage()}")
-        }
-
-        return null
-    }
-
     companion object {
         const val PPL_QUERY_RESULTS_FIELD = "ppl_query_results"
     }

src/main/kotlin/org/opensearch/commons/alerting/model/TriggerV2.kt

@@ -28,6 +28,7 @@ interface TriggerV2 : BaseModel {
 
     enum class Severity(val value: String) {
         INFO("info"),
+        ERROR("error"),
         LOW("low"),
         MEDIUM("medium"),
         HIGH("high"),