Chapter 9. PrometheusRule [monitoring.coreos.com/v1]
- Description
- PrometheusRule defines recording and alerting rules for a Prometheus instance
- Type
-
object
- Required
-
spec
-
9.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| Specification of desired alerting rule definitions for Prometheus. |
9.1.1. .spec
- Description
- Specification of desired alerting rule definitions for Prometheus.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| Content of Prometheus rule file |
|
| RuleGroup is a list of sequentially evaluated recording and alerting rules. |
9.1.2. .spec.groups
- Description
- Content of Prometheus rule file
- Type
-
array
9.1.3. .spec.groups[]
- Description
- RuleGroup is a list of sequentially evaluated recording and alerting rules.
- Type
-
object
- Required
-
name
-
Property | Type | Description |
---|---|---|
|
| Interval determines how often rules in the group are evaluated. |
|
| 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 of the rule group. |
|
| 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 |
|
| List of alerting and recording rules. |
|
| 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 |
9.1.4. .spec.groups[].rules
- Description
- List of alerting and recording rules.
- Type
-
array
9.1.5. .spec.groups[].rules[]
- Description
- 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
- Type
-
object
- Required
-
expr
-
Property | Type | Description |
---|---|---|
|
|
Name of the alert. Must be a valid label value. Only one of |
|
| Annotations to add to each alert. Only valid for alerting rules. |
|
| PromQL expression to evaluate. |
|
| Alerts are considered firing once they have been returned for this long. |
|
| KeepFiringFor defines how long an alert will continue firing after the condition that triggered it has cleared. |
|
| Labels to add or overwrite. |
|
|
Name of the time series to output to. Must be a valid metric name. Only one of |
9.2. API endpoints
The following API endpoints are available:
/apis/monitoring.coreos.com/v1/prometheusrules
-
GET
: list objects of kind PrometheusRule
-
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules
-
DELETE
: delete collection of PrometheusRule -
GET
: list objects of kind PrometheusRule -
POST
: create a PrometheusRule
-
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name}
-
DELETE
: delete a PrometheusRule -
GET
: read the specified PrometheusRule -
PATCH
: partially update the specified PrometheusRule -
PUT
: replace the specified PrometheusRule
-
9.2.1. /apis/monitoring.coreos.com/v1/prometheusrules
- HTTP method
-
GET
- Description
- list objects of kind PrometheusRule
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
9.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules
- HTTP method
-
DELETE
- Description
- delete collection of PrometheusRule
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- list objects of kind PrometheusRule
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
POST
- Description
- create a PrometheusRule
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
9.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the PrometheusRule |
- HTTP method
-
DELETE
- Description
- delete a PrometheusRule
Parameter | Type | Description |
---|---|---|
|
| 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 |
HTTP code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- read the specified PrometheusRule
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update the specified PrometheusRule
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace the specified PrometheusRule
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |