Struct PrometheusQueryLanguageCondition

#[non_exhaustive]
pub struct PrometheusQueryLanguageCondition {
    pub query: String,
    pub duration: Option<Duration>,
    pub evaluation_interval: Option<Duration>,
    pub labels: HashMap<String, String>,
    pub rule_group: String,
    pub alert_rule: String,
    pub disable_metric_validation: bool,
}

A condition type that allows alerting policies to be defined using Prometheus Query Language (PromQL).

The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.

A Prometheus alerting rule is described here. The semantics of a Prometheus alerting rule is described here.

A Prometheus rule group is described here. The semantics of a Prometheus rule group is described here.

Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.

The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query: String

Required. The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.

duration: Option<Duration>

Optional. Alerts are considered firing once their PromQL expression was evaluated to be “true” for this long. Alerts whose PromQL expression was not evaluated to be “true” for long enough are considered pending. Must be a non-negative duration or missing. This field is optional. Its default value is zero.

evaluation_interval: Option<Duration>

Optional. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. This field is optional. Its default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.

labels: HashMap<String, String>

Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid. Label values can be templatized by using variables. The only available variable names are the names of the labels in the PromQL result, including “name” and “value”. “labels” may be empty.

rule_group: String

Optional. The rule group name of this alert in the corresponding Prometheus configuration file.

Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.

This field is optional. If this field is not empty, then it must contain a valid UTF-8 string. This field may not exceed 2048 Unicode characters in length.

alert_rule: String

Optional. The alerting rule name of this alert in the corresponding Prometheus configuration file.

Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future.

This field is optional. If this field is not empty, then it must be a valid Prometheus label name. This field may not exceed 2048 Unicode characters in length.

disable_metric_validation: bool

Optional. Whether to disable metric existence validation for this condition.

This allows alerting policies to be defined on metrics that do not yet exist, improving advanced customer workflows such as configuring alerting policies using Terraform.

Users with the monitoring.alertPolicyViewer role are able to see the name of the non-existent metric in the alerting policy condition.

Implementations

impl PrometheusQueryLanguageCondition

pub fn set_query<T: Into<String>>(self, v: T) -> Self

Sets the value of query.

pub fn set_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of duration.

pub fn set_evaluation_interval<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of evaluation_interval.

pub fn set_rule_group<T: Into<String>>(self, v: T) -> Self

Sets the value of rule_group.

pub fn set_alert_rule<T: Into<String>>(self, v: T) -> Self

Sets the value of alert_rule.

pub fn set_disable_metric_validation<T: Into<bool>>(self, v: T) -> Self

Sets the value of disable_metric_validation.

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Trait Implementations

impl Clone for PrometheusQueryLanguageCondition

fn clone(&self) -> PrometheusQueryLanguageCondition

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PrometheusQueryLanguageCondition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PrometheusQueryLanguageCondition

fn default() -> PrometheusQueryLanguageCondition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PrometheusQueryLanguageCondition

where PrometheusQueryLanguageCondition: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for PrometheusQueryLanguageCondition

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PrometheusQueryLanguageCondition

fn eq(&self, other: &PrometheusQueryLanguageCondition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PrometheusQueryLanguageCondition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PrometheusQueryLanguageCondition