mirror of
https://github.com/twitter/the-algorithm.git
synced 2024-06-13 06:38:52 +02:00
ef4c5eb65e
Please note we have force-pushed a new initial commit in order to remove some publicly-available Twitter user information. Note that this process may be required in the future.
53 lines
1.8 KiB
Scala
53 lines
1.8 KiB
Scala
package com.twitter.product_mixer.core.functional_component.common.alert.predicate
|
|
|
|
/**
|
|
* [[Predicate]]s will trigger if the metric's value is past the
|
|
* `threshold` for `datapointsPastThreshold` or more datapoints
|
|
* in a given `duration`
|
|
*
|
|
* @see [[https://docbird.twitter.biz/mon/reference.html#predicate Predicate]]
|
|
*/
|
|
trait Predicate {
|
|
|
|
/** @see [[https://docbird.twitter.biz/mon/reference.html#predicate OPERATOR]] */
|
|
val operator: Operator
|
|
|
|
/** @see [[https://docbird.twitter.biz/mon/reference.html#predicate THRESHOLD]] */
|
|
val threshold: Double
|
|
|
|
/**
|
|
* The number of datapoints in a given duration beyond the threshold that will trigger an alert
|
|
* @see [[https://docbird.twitter.biz/mon/reference.html#predicate DATAPOINTS]]
|
|
*/
|
|
val datapointsPastThreshold: Int
|
|
|
|
/**
|
|
* @note if using a [[metricGranularity]] of [[Minutes]] then this must be >= 3
|
|
* @see [[https://docbird.twitter.biz/mon/reference.html#predicate DURATION]]
|
|
*/
|
|
val duration: Int
|
|
|
|
/**
|
|
* Specifies the metric granularity
|
|
* @see [[https://docbird.twitter.biz/mon/reference.html#predicate DURATION]]
|
|
*/
|
|
val metricGranularity: MetricGranularity
|
|
|
|
require(
|
|
datapointsPastThreshold > 0,
|
|
s"`datapointsPastThreshold` must be > 0 but got `datapointsPastThreshold` = $datapointsPastThreshold"
|
|
)
|
|
|
|
require(
|
|
datapointsPastThreshold <= duration,
|
|
s"`datapointsPastThreshold` must be <= than `duration.inMinutes` but got `datapointsPastThreshold` = $datapointsPastThreshold `duration` = $duration"
|
|
)
|
|
require(
|
|
metricGranularity != Minutes || duration >= 3,
|
|
s"Predicate durations must be at least 3 minutes but got $duration"
|
|
)
|
|
}
|
|
|
|
/** [[ThroughputPredicate]]s are predicates that can trigger when the throughput is too low or high */
|
|
trait ThroughputPredicate extends Predicate
|