PrometheusRule
monitoring.coreos.com / v1
apiVersion: monitoring.coreos.com/v1
kind: PrometheusRule
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object required
Specification of desired alerting rule definitions for Prometheus.
groups []object
Content of Prometheus rule file
interval
string
Interval determines how often rules in the group are evaluated.
pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
labels
object
Labels to add or overwrite before storing the result for its rules.
The labels defined at the rule level take precedence.
It requires Prometheus >= 3.0.0.
The field is ignored for Thanos Ruler.
limit
integer
Limit the number of alerts an alerting rule and series a recording
rule can produce.
Limit is supported starting with Prometheus >= 2.31 and Thanos Ruler >= 0.24.
name
string required
Name of the rule group.
minLength:
1
partial_response_strategy
string
PartialResponseStrategy is only used by ThanosRuler and will
be ignored by Prometheus instances.
More info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response
pattern:
^(?i)(abort|warn)?$
query_offset
string
Defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past.
It requires Prometheus >= v2.53.0.
It is not supported for ThanosRuler.
pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$rules []object
List of alerting and recording rules.
alert
string
Name of the alert. Must be a valid label value.
Only one of `record` and `alert` must be set.
annotations
object
Annotations to add to each alert.
Only valid for alerting rules.
expr
string | integer required
PromQL expression to evaluate.
for
string
Alerts are considered firing once they have been returned for this long.
pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
keep_firing_for
string
KeepFiringFor defines how long an alert will continue firing after the condition that triggered it has cleared.
pattern:
^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$minLength:
1
labels
object
Labels to add or overwrite.
record
string
Name of the time series to output to. Must be a valid metric name.
Only one of `record` and `alert` must be set.
No matches. Try .spec.groups for an exact path