Get List of trigger types - TRIGGER_TYPE rest api

rupa · February 2, 2024, 2:17pm

Versions (relevant - OpenSearch/Dashboard/Server OS/Browser):
2.11.1

Describe the issue:

Need to add a REST API to get list of Trigger types

opensearch-project/common-utils/blob/195b17dce2425c81b710027a013dc66d02f06d05/src/main/kotlin/org/opensearch/commons/alerting/model/Trigger.kt#L12


      
          
          import org.opensearch.commons.alerting.model.action.Action
          import org.opensearch.commons.notifications.model.BaseModel
          import org.opensearch.core.common.io.stream.StreamInput
          import org.opensearch.core.xcontent.XContentParser
          import org.opensearch.core.xcontent.XContentParserUtils
          import java.io.IOException
          
          interface Trigger : BaseModel {
          
              enum class Type(val value: String) {
                  DOCUMENT_LEVEL_TRIGGER(DocumentLevelTrigger.DOCUMENT_LEVEL_TRIGGER_FIELD),
                  QUERY_LEVEL_TRIGGER(QueryLevelTrigger.QUERY_LEVEL_TRIGGER_FIELD),
                  BUCKET_LEVEL_TRIGGER(BucketLevelTrigger.BUCKET_LEVEL_TRIGGER_FIELD),
                  NOOP_TRIGGER(NoOpTrigger.NOOP_TRIGGER_FIELD),
                  CHAINED_ALERT_TRIGGER(ChainedAlertTrigger.CHAINED_ALERT_TRIGGER_FIELD);
          
                  override fun toString(): String {
                      return value
                  }
              }

I can see the existing REST API endpoints listed here

github.com

opensearch-project/alerting/blob/3c50f7d001bf645e842e95201c176cd6198e7996/alerting/src/main/kotlin/org/opensearch/alerting/AlertingPlugin.kt#L133


      
          internal class AlertingPlugin : PainlessExtension, ActionPlugin, ScriptPlugin, ReloadablePlugin, SearchPlugin, PercolatorPluginExt() {
          
              override fun getContextAllowlists(): Map<ScriptContext<*>, List<Allowlist>> {
                  val whitelist = AllowlistLoader.loadFromResourceFiles(javaClass, "org.opensearch.alerting.txt")
                  return mapOf(TriggerScript.CONTEXT to listOf(whitelist))
              }
          
              companion object {
                  @JvmField val OPEN_SEARCH_DASHBOARDS_USER_AGENT = "OpenSearch-Dashboards"
                  @JvmField val UI_METADATA_EXCLUDE = arrayOf("monitor.${Monitor.UI_METADATA_FIELD}")
                  @JvmField val MONITOR_BASE_URI = "/_plugins/_alerting/monitors"
                  @JvmField val WORKFLOW_BASE_URI = "/_plugins/_alerting/workflows"
                  @JvmField val DESTINATION_BASE_URI = "/_plugins/_alerting/destinations"
                  @JvmField val LEGACY_OPENDISTRO_MONITOR_BASE_URI = "/_opendistro/_alerting/monitors"
                  @JvmField val LEGACY_OPENDISTRO_DESTINATION_BASE_URI = "/_opendistro/_alerting/destinations"
                  @JvmField val EMAIL_ACCOUNT_BASE_URI = "$DESTINATION_BASE_URI/email_accounts"
                  @JvmField val EMAIL_GROUP_BASE_URI = "$DESTINATION_BASE_URI/email_groups"
                  @JvmField val LEGACY_OPENDISTRO_EMAIL_ACCOUNT_BASE_URI = "$LEGACY_OPENDISTRO_DESTINATION_BASE_URI/email_accounts"
                  @JvmField val LEGACY_OPENDISTRO_EMAIL_GROUP_BASE_URI = "$LEGACY_OPENDISTRO_DESTINATION_BASE_URI/email_groups"
                  @JvmField val FINDING_BASE_URI = "/_plugins/_alerting/findings"

gaobinlong · February 9, 2024, 7:30am

Could you open an issue here:Issues · opensearch-project/alerting · GitHub ?

rupa · February 9, 2024, 9:58am

Done, thank you

github.com/opensearch-project/alerting

Add rest api to get list of trigger types - TRIGGER_TYPE

opened 09:58AM - 09 Feb 24 UTC

rblcoder

enhancement untriaged

**Is your feature request related to a problem?** Currently we need to hard-cod…e list of trigger types in code and need to refer back here to see if any additional types are added **What solution would you like?** Need to get a list of trigger types returned from a rest api **What alternatives have you considered?** Hard-coding the trigger types in code **Do you have any additional context?** Trigger types can be found [here](https://github.com/opensearch-project/common-utils/blob/195b17dce2425c81b710027a013dc66d02f06d05/src/main/kotlin/org/opensearch/commons/alerting/model/Trigger.kt#L12)

Topic		Replies	Views
Unable to add or update trigger action - [illegal_state_exception] or [parsing_exception] Alerting	1	602	June 3, 2022
Access Nested Objects using Painless for Alerting to Create Trigger Condition Alerting	1	1061	December 15, 2022
Action Trigger in Anomaly Detection OpenSearch	2	125	November 13, 2023
Help ! Tigger parase error Alerting configure	3	246	September 25, 2023
Trigger Logic Apps from Opensearch-dashboard notifications Reporting Plugin	1	507	July 16, 2022

Get List of trigger types - TRIGGER_TYPE rest api

Related Topics