prometheusRule [monitoring.coreos.com/v1]

groups

array

Content of prometheus rule file

groups[]

object

RuleGroup is a list of sequentially evaluated recording and alerting rules.

interval

string

Interval determines how often rules in the group are evaluated.

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

Name of the rule group.

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

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.

rules

array

List of alerting and recording rules.

rules[]

object

Rule describes an alerting or recording rule See prometheus documentation: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) or [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) rule

alert

string

Name of the alert. Must be a valid label value. Only one of record and alert must be set.

annotations

object (string)

Annotations to add to each alert. Only valid for alerting rules.

expr

integer-or-string

PromQL expression to evaluate.

for

string

Alerts are considered firing once they have been returned for this long.

keep_firing_for

string

KeepFiringFor defines how long an alert will continue firing after the condition that triggered it has cleared.

labels

object (string)

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.

200 - OK

prometheusRuleList schema

401 - Unauthorized

Empty

200 - OK

Status schema

401 - Unauthorized

Empty

200 - OK

prometheusRuleList schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

prometheusRule schema

200 - OK

prometheusRule schema

201 - Created

prometheusRule schema

202 - Accepted

prometheusRule schema

401 - Unauthorized

Empty

name

string

name of the prometheusRule

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

200 - OK

prometheusRule schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

200 - OK

prometheusRule schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

prometheusRule schema

200 - OK

prometheusRule schema

201 - Created

prometheusRule schema

401 - Unauthorized

Empty