c

uk.gov.hmrc.alertconfig.builder.custom

CustomGraphiteMetricAlert

case class CustomGraphiteMetricAlert(alertName: String, alertPerInstance: Boolean = false, checkIntervalMinutes: Option[CheckIntervalMinutes] = None, dashboardPanelId: Option[Int], dashboardUri: Option[String], integrations: Seq[String], operator: EvaluationOperator, pendingPeriodMinutes: Option[Int] = None, query: String, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.FIFTEEN_MINUTES, reducerFunction: ReducerFunction, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds) extends CustomAlert with Product with Serializable

Graphite metric based alert.

alertName

Name that the alert will be created with

alertPerInstance

Whether to generate multiple alerts if the graphite metric query produces multiple result instances

checkIntervalMinutes

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

dashboardPanelId

Specific panel to deep link to that is specific to this alert

dashboardUri

Grafana 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

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

query

Graphite query you're running

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).

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

Linear Supertypes
Serializable, Product, Equals, CustomAlert, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CustomGraphiteMetricAlert
  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 CustomGraphiteMetricAlert(alertName: String, alertPerInstance: Boolean = false, checkIntervalMinutes: Option[CheckIntervalMinutes] = None, dashboardPanelId: Option[Int], dashboardUri: Option[String], integrations: Seq[String], operator: EvaluationOperator, pendingPeriodMinutes: Option[Int] = None, query: String, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.FIFTEEN_MINUTES, reducerFunction: ReducerFunction, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds)

    alertName

    Name that the alert will be created with

    alertPerInstance

    Whether to generate multiple alerts if the graphite metric query produces multiple result instances

    checkIntervalMinutes

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

    dashboardPanelId

    Specific panel to deep link to that is specific to this alert

    dashboardUri

    Grafana 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

    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

    query

    Graphite query you're running

    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).

    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

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. val alertPerInstance: Boolean
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val checkIntervalMinutes: Option[CheckIntervalMinutes]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. val dashboardPanelId: Option[Int]
  10. val dashboardUri: Option[String]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. val integrations: Seq[String]
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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 query: String
  22. val queryTimeRangeMinutes: TimeRangeAsMinutes
  23. val reducerFunction: ReducerFunction
  24. val runbookUrl: Option[String]
  25. val severity: CustomAlertSeverity.AlertSeverity
  26. val summary: String
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. val teamName: String
  29. val thresholds: EnvironmentThresholds
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. 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