Class: Google::Apis::MonitoringV3::PrometheusQueryLanguageCondition

Inherits:

Object

• Object
• Google::Apis::MonitoringV3::PrometheusQueryLanguageCondition

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/monitoring_v3/classes.rb,
lib/google/apis/monitoring_v3/representations.rb,
lib/google/apis/monitoring_v3/representations.rb

Overview

A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/ basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/ configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/ recording_rules/#rule).A Prometheus rule group is described here (https:// prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/ docs/prometheus/latest/configuration/recording_rules/#rule_group).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).

Instance Attribute Summary

• #alert_rule ⇒ String

  Optional.

• #duration ⇒ String

  Optional.

• #evaluation_interval ⇒ String

  Required.

• #labels ⇒ Hash<String,String>

  Optional.

• #query ⇒ String

  Required.

• #rule_group ⇒ String

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ PrometheusQueryLanguageCondition constructor

  A new instance of PrometheusQueryLanguageCondition.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ PrometheusQueryLanguageCondition

Returns a new instance of PrometheusQueryLanguageCondition.

# File 'lib/google/apis/monitoring_v3/classes.rb', line 3796

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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 (https://prometheus.io/docs/concepts/data_model/#metric- names-and-labels). Corresponds to the JSON property alertRule

Returns:

• (String)

# File 'lib/google/apis/monitoring_v3/classes.rb', line 3749

def alert_rule
  @alert_rule
end

#duration ⇒ String

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. The default value is zero. Must be zero or positive. Corresponds to the JSON property duration

Returns:

• (String)

# File 'lib/google/apis/monitoring_v3/classes.rb', line 3757

def duration
  @duration
end

#evaluation_interval ⇒ String

Required. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The 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. Corresponds to the JSON property evaluationInterval

Returns:

• (String)

# File 'lib/google/apis/monitoring_v3/classes.rb', line 3765

def evaluation_interval
  @evaluation_interval
end

#labels ⇒ Hash<String,String>

Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric- names-and-labels). Label values can be templatized by using variables (https:// cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including "name" and "value". "labels" may be empty. Corresponds to the JSON property labels

Returns:

• (Hash<String,String>)

# File 'lib/google/apis/monitoring_v3/classes.rb', line 3775

def labels
  @labels
end

#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. Corresponds to the JSON property query

Returns:

• (String)

# File 'lib/google/apis/monitoring_v3/classes.rb', line 3782

def query
  @query
end

#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 be a valid Prometheus label name (https://prometheus.io/docs/concepts/data_model/#metric- names-and-labels). Corresponds to the JSON property ruleGroup

Returns:

• (String)

# File 'lib/google/apis/monitoring_v3/classes.rb', line 3794

def rule_group
  @rule_group
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/monitoring_v3/classes.rb', line 3801

def update!(**args)
  @alert_rule = args[:alert_rule] if args.key?(:alert_rule)
  @duration = args[:duration] if args.key?(:duration)
  @evaluation_interval = args[:evaluation_interval] if args.key?(:evaluation_interval)
  @labels = args[:labels] if args.key?(:labels)
  @query = args[:query] if args.key?(:query)
  @rule_group = args[:rule_group] if args.key?(:rule_group)
end