UpdateRecordingRule - Chronosphere Documentation

Authorizations

API-Token

string

header

required

Chronosphere API token

Path Parameters

slug

string

required

Body

application/json

create_if_missing

boolean

If true, the RecordingRule will be created if it does not already exist, identified by slug. If false, an error will be returned if the RecordingRule does not already exist.

dry_run

boolean

If true, validates the specified configuration without creating or updating the RecordingRule. If the specified configuration is valid, the endpoint returns a partial response without the RecordingRule. If the specified configuration is invalid, the endpoint returns an error.

recording_rule

object

The RecordingRule to update.

Show child attributes

recording_rule.name

string

required

The name of the RecordingRule. You can modify this value after the RecordingRule is created.

recording_rule.bucket_slug

string

The slug of the bucket the recording rule belongs to. Required if execution_group is not set. If both bucket_slug and execution_group are set, their values must match.

recording_rule.execution_group

string

The slug of the execution group in which the recording rule will be evaluated. Required if bucket_slug is not set. If both bucket_slug and execution_group are set, their values must match.

recording_rule.interval_secs

integer<int32>

Specifies how often to evaluate the recording rule.

recording_rule.label_policy

object

The label policy for the recording rule.

Show child attributes

recording_rule.label_policy.add

object

A list of labels to add or overwrite before storing the result.

Show child attributes

recording_rule.label_policy.add.{key}

string

recording_rule.metric_name

string

The name of the time series to use for the output of prometheus_expr. This value must be a valid metric name. If you don't set this value, the output of prometheus_expr is output to a time series with a name defined by the value of name.

recording_rule.prometheus_expr

string

The PromQL expression to evaluate at the time of each evaluation cycle. The result is output to a new time series with a name defined by the value of metric_name. If metric_name is unset, the result is output to a time series defined by the value of name.

recording_rule.slug

string

The unique identifier of the RecordingRule. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the RecordingRule is created.

Response

A successful response containing the updated RecordingRule.

recording_rule

object

Show child attributes

recording_rule.name

string

required

The name of the RecordingRule. You can modify this value after the RecordingRule is created.

recording_rule.bucket_slug

string

The slug of the bucket the recording rule belongs to. Required if execution_group is not set. If both bucket_slug and execution_group are set, their values must match.

recording_rule.created_at

string<date-time>

Timestamp of when the RecordingRule was created. Cannot be set by clients.

recording_rule.execution_group

string

The slug of the execution group in which the recording rule will be evaluated. Required if bucket_slug is not set. If both bucket_slug and execution_group are set, their values must match.

recording_rule.interval_secs

integer<int32>

Specifies how often to evaluate the recording rule.

recording_rule.label_policy

object

The label policy for the recording rule.

Show child attributes

recording_rule.label_policy.add

object

A list of labels to add or overwrite before storing the result.

Show child attributes

recording_rule.label_policy.add.{key}

string

recording_rule.metric_name

string

The name of the time series to use for the output of prometheus_expr. This value must be a valid metric name. If you don't set this value, the output of prometheus_expr is output to a time series with a name defined by the value of name.

recording_rule.prometheus_expr

string

The PromQL expression to evaluate at the time of each evaluation cycle. The result is output to a new time series with a name defined by the value of metric_name. If metric_name is unset, the result is output to a time series defined by the value of name.

recording_rule.slug

string

The unique identifier of the RecordingRule. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the RecordingRule is created.

recording_rule.updated_at

string<date-time>

Timestamp of when the RecordingRule was last updated. Cannot be set by clients.

Endpoints

Authorizations

Path Parameters

Body

Response