c

uk.gov.hmrc.alertconfig.builder.custom

CustomElasticsearchPercentageAlert

case class CustomElasticsearchPercentageAlert(alertName: String, checkIntervalMinutes: CheckIntervalMinutes = CheckIntervalMinutes.TWO_MINUTES, integrations: Seq[String], kibanaDashboardUri: Option[String], luceneQuerySubset: String, luceneQueryTotal: String, operator: EvaluationOperator = EvaluationOperator.GREATER_THAN, pendingPeriodMinutes: Option[Int] = None, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.FIFTEEN_MINUTES, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds) 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. See CheckIntervalMinutes for supported values

integrations

Which PagerDuty integrations to direct this alert to n

kibanaDashboardUri

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

operator

Whether to evaluate the metric as greater than or less than

pendingPeriodMinutes

Amount of time in minutes that a threshold needs to be breached before the alert fires

queryTimeRangeMinutes

The sample period to check data for. If you set it to FIVE_MINUTES, the alert check will evaluate data starting from 6 minutes ago until one minute ago (so that only fully shipped metrics are evaluated).

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

Linear Supertypes
Serializable, Product, Equals, CustomAlert, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CustomElasticsearchPercentageAlert
  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 CustomElasticsearchPercentageAlert(alertName: String, checkIntervalMinutes: CheckIntervalMinutes = CheckIntervalMinutes.TWO_MINUTES, integrations: Seq[String], kibanaDashboardUri: Option[String], luceneQuerySubset: String, luceneQueryTotal: String, operator: EvaluationOperator = EvaluationOperator.GREATER_THAN, pendingPeriodMinutes: Option[Int] = None, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.FIFTEEN_MINUTES, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds)

    alertName

    Name that the alert will be created with

    checkIntervalMinutes

    Number of minutes between each check. See CheckIntervalMinutes for supported values

    integrations

    Which PagerDuty integrations to direct this alert to n

    kibanaDashboardUri

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

    operator

    Whether to evaluate the metric as greater than or less than

    pendingPeriodMinutes

    Amount of time in minutes that a threshold needs to be breached before the alert fires

    queryTimeRangeMinutes

    The sample period to check data for. If you set it to FIVE_MINUTES, the alert check will evaluate data starting from 6 minutes ago until one minute ago (so that only fully shipped metrics are evaluated).

    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

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: CheckIntervalMinutes
  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 luceneQuerySubset: String
  14. val luceneQueryTotal: String
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. val operator: EvaluationOperator
  19. val pendingPeriodMinutes: Option[Int]
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val queryTimeRangeMinutes: TimeRangeAsMinutes
  22. val runbookUrl: Option[String]
  23. val severity: CustomAlertSeverity.AlertSeverity
  24. val summary: String
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. val teamName: String
  27. val thresholds: EnvironmentThresholds
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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