c

uk.gov.hmrc.alertconfig.builder.custom

CustomElasticsearchAlert

case class CustomElasticsearchAlert(alertName: String, checkIntervalMinutes: Int, kibanaDashboardUri: Option[String], integrations: Seq[String], luceneQuery: String, operator: EvaluationOperator, reducerFunction: Option[ReducerFunction] = Some(ReducerFunction.LAST), runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds, timeRangeMinutes: TimeRangeAsMinutes) extends CustomAlert with Product with Serializable

CloudWatch metrics based alert.

alertName

Name that the alert will be created with

checkIntervalMinutes

Number of minutes between each check

kibanaDashboardUri

Kibana uri to link to. This should just be the uri path and not include the domain

integrations

Which PagerDuty integrations to direct this alert to n

luceneQuery

Query to make to Elasticsearch

operator

Whether to evaluate the metric as greater than or less than

reducerFunction

Function to use when manipulate data returned from query

runbookUrl

Runbook for when this alert fires

severity

The severity of this alert. E.g. Warning or Critical

summary

The description to populate in PagerDuty when the alert fires

teamName

All alerts are prefixed with the team name

thresholds

Trigger point for each environment

timeRangeMinutes

The number of minutes to look back in the search query e.g. 15 would mean 15m ago to now

Linear Supertypes
Serializable, Product, Equals, CustomAlert, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CustomElasticsearchAlert
  2. Serializable
  3. Product
  4. Equals
  5. CustomAlert
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CustomElasticsearchAlert(alertName: String, checkIntervalMinutes: Int, kibanaDashboardUri: Option[String], integrations: Seq[String], luceneQuery: String, operator: EvaluationOperator, reducerFunction: Option[ReducerFunction] = Some(ReducerFunction.LAST), runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds, timeRangeMinutes: TimeRangeAsMinutes)

    alertName

    Name that the alert will be created with

    checkIntervalMinutes

    Number of minutes between each check

    kibanaDashboardUri

    Kibana uri to link to. This should just be the uri path and not include the domain

    integrations

    Which PagerDuty integrations to direct this alert to n

    luceneQuery

    Query to make to Elasticsearch

    operator

    Whether to evaluate the metric as greater than or less than

    reducerFunction

    Function to use when manipulate data returned from query

    runbookUrl

    Runbook for when this alert fires

    severity

    The severity of this alert. E.g. Warning or Critical

    summary

    The description to populate in PagerDuty when the alert fires

    teamName

    All alerts are prefixed with the team name

    thresholds

    Trigger point for each environment

    timeRangeMinutes

    The number of minutes to look back in the search query e.g. 15 would mean 15m ago to now

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val alertName: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val checkIntervalMinutes: Int
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. val integrations: Seq[String]
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val kibanaDashboardUri: Option[String]
  13. val luceneQuery: String
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. val operator: EvaluationOperator
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. val reducerFunction: Option[ReducerFunction]
  20. val runbookUrl: Option[String]
  21. val severity: CustomAlertSeverity.AlertSeverity
  22. val summary: String
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. val teamName: String
  25. val thresholds: EnvironmentThresholds
  26. val timeRangeMinutes: TimeRangeAsMinutes
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CustomAlert

Inherited from AnyRef

Inherited from Any

Ungrouped