c

uk.gov.hmrc.alertconfig.builder.custom

CustomElasticsearchAlert

case class CustomElasticsearchAlert(alertName: String, checkIntervalMinutes: CheckIntervalMinutes, kibanaDashboardUri: Option[String], integrations: Seq[String], luceneQuery: String, operator: EvaluationOperator, reducerFunction: ReducerFunction, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds, evaluationPeriodStartMinutesAgo: TimeRangeAsMinutes, evaluationPeriodEndMinutesAgo: TimeRangeAsMinutes = TimeRangeAsMinutes.ONE_MINUTE) 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

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 to transform multiple data points returned from query into a single value, to be compared against the specified threshold. Valid values include: COUNT, LAST, MAX, MEAN, MIN, SUM. Note: Using the LAST reducer could result in not all data points being considered during alert evaluation, depending on the frequency at which the alert runs. Example: An alert with a LAST reducer, that runs every 2 minutes, based on a metric that is written on a per minute basis, will only consider ~50% of the data points, potentially missing a legitimate breach of an alert threshold.

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

evaluationPeriodStartMinutesAgo

The start of the evaluation period. If you set to FIFTEEN_MINUTES, the alert check will evaluate data starting fifteen minutes ago up until evaluationPeriodEndMinutesAgo

evaluationPeriodEndMinutesAgo

The end of the evaluation period. If you set it to ONE MINUTE, the alert check will evaluate data starting from evaluationPeriodStartMinutesAgo until one minute ago. Less than one minute ago is not advised because these metrics may not yet be fully shipped.

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: CheckIntervalMinutes, kibanaDashboardUri: Option[String], integrations: Seq[String], luceneQuery: String, operator: EvaluationOperator, reducerFunction: ReducerFunction, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds, evaluationPeriodStartMinutesAgo: TimeRangeAsMinutes, evaluationPeriodEndMinutesAgo: TimeRangeAsMinutes = TimeRangeAsMinutes.ONE_MINUTE)

    alertName

    Name that the alert will be created with

    checkIntervalMinutes

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

    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 to transform multiple data points returned from query into a single value, to be compared against the specified threshold. Valid values include: COUNT, LAST, MAX, MEAN, MIN, SUM. Note: Using the LAST reducer could result in not all data points being considered during alert evaluation, depending on the frequency at which the alert runs. Example: An alert with a LAST reducer, that runs every 2 minutes, based on a metric that is written on a per minute basis, will only consider ~50% of the data points, potentially missing a legitimate breach of an alert threshold.

    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

    evaluationPeriodStartMinutesAgo

    The start of the evaluation period. If you set to FIFTEEN_MINUTES, the alert check will evaluate data starting fifteen minutes ago up until evaluationPeriodEndMinutesAgo

    evaluationPeriodEndMinutesAgo

    The end of the evaluation period. If you set it to ONE MINUTE, the alert check will evaluate data starting from evaluationPeriodStartMinutesAgo until one minute ago. Less than one minute ago is not advised because these metrics may not yet be fully shipped.

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. val evaluationPeriodEndMinutesAgo: TimeRangeAsMinutes
  10. val evaluationPeriodStartMinutesAgo: TimeRangeAsMinutes
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. val integrations: Seq[String]
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val kibanaDashboardUri: Option[String]
  15. val luceneQuery: String
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. val operator: EvaluationOperator
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val reducerFunction: ReducerFunction
  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