case class CustomElasticsearchAlert(alertName: String, checkIntervalMinutes: Option[CheckIntervalMinutes] = None, kibanaDashboardUri: Option[String], integrations: Seq[String], luceneQuery: String, operator: EvaluationOperator, reducerFunction: ReducerFunction, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.FIFTEEN_MINUTES) 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
- 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).
- Alphabetic
- By Inheritance
- CustomElasticsearchAlert
- Serializable
- Product
- Equals
- CustomAlert
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CustomElasticsearchAlert(alertName: String, checkIntervalMinutes: Option[CheckIntervalMinutes] = None, kibanaDashboardUri: Option[String], integrations: Seq[String], luceneQuery: String, operator: EvaluationOperator, reducerFunction: ReducerFunction, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.FIFTEEN_MINUTES)
- 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
- 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).
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val alertName: String
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val checkIntervalMinutes: Option[CheckIntervalMinutes]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val integrations: Seq[String]
- Definition Classes
- CustomElasticsearchAlert → CustomAlert
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val kibanaDashboardUri: Option[String]
- val luceneQuery: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val operator: EvaluationOperator
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val queryTimeRangeMinutes: TimeRangeAsMinutes
- val reducerFunction: ReducerFunction
- val runbookUrl: Option[String]
- val severity: CustomAlertSeverity.AlertSeverity
- Definition Classes
- CustomElasticsearchAlert → CustomAlert
- val summary: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val teamName: String
- val thresholds: EnvironmentThresholds
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)