Component schema

CheckThresholds

object1 direct reference

Definition

Thresholds to use for the $__threshold variable in the expression field.

By default degraded and failed are absolute values. The optional baseline and changeGate sub-objects are detector configuration: the presence of one of them is the discriminator that changes how degraded and failed are interpreted.

Neither present: degraded and failed are absolute values compared against the expression's own value, as they always have been.
baseline present: degraded and failed are re-interpreted as z-score cutoffs — multiples of the watched entity's own typical spread away from its prediction — rather than as absolute values. Each configured cutoff must be greater than 0 and less than 1000000, the detector score cap.
changeGate present: degraded and failed stay absolute, but the check additionally requires the value to have become materially worse than it recently was before it fails.

At most one of baseline and changeGate may be set. A request setting both is rejected with a 400; the mutual exclusion is enforced by the server rather than by this schema, matching the existing treatment of metric versus servicesMetricQuery.

number

The threshold value that defines when the check is in a degraded state. The value will be interpolated into the expression field as $__threshold.

Interpreted as a z-score cutoff rather than an absolute value when baseline is set.

number

The threshold value that defines when the check is in a failed state. The value will be interpolated into the expression field as $__threshold.

Interpreted as a z-score cutoff rather than an absolute value when baseline is set.

CheckThresholdBaseline

Compare the check rule's observed quantity against its own past instead of against an absolute value. Setting this re-interprets degraded and failed as z-score cutoffs.

Mutually exclusive with changeGate.

CheckThresholdChangeGate

Require the observed quantity to have changed materially compared to a recent window before the absolute degraded / failed thresholds are allowed to fail the check. degraded and failed remain absolute values.

Mutually exclusive with baseline.

Used by 1

These schemas and endpoints reference this type directly.

SchemaPrometheusAlertRule

json

OpenAPI source1234567891011121314151617181920212223
{
  "description": "Thresholds to use for the `$__threshold` variable in the expression field.\n\nBy default `degraded` and `failed` are absolute values. The optional `baseline` and\n`changeGate` sub-objects are detector configuration: **the presence of one of them is the\ndiscriminator** that changes how `degraded` and `failed` are interpreted.\n\n- Neither present: `degraded` and `failed` are absolute values compared against the\n  expression's own value, as they always have been.\n- `baseline` present: `degraded` and `failed` are re-interpreted as z-score cutoffs —\n  multiples of the watched entity's own typical spread away from its prediction — rather\n  than as absolute values. Each configured cutoff must be greater than `0` and less than\n  `1000000`, the detector score cap.\n- `changeGate` present: `degraded` and `failed` stay absolute, but the check additionally\n  requires the value to have become materially worse than it recently was before it fails.\n\nAt most one of `baseline` and `changeGate` may be set. A request setting both is rejected\nwith a `400`; the mutual exclusion is enforced by the server rather than by this schema,\nmatching the existing treatment of `metric` versus `servicesMetricQuery`.\n",
  "properties": {
    "degraded": {
      "description": "The threshold value that defines when the check is in a degraded state. The value will be\ninterpolated into the expression field as `$__threshold`.\n\nInterpreted as a z-score cutoff rather than an absolute value when `baseline` is set.\n",
      "type": "number",
      "format": "double"
    },
    "failed": {
      "description": "The threshold value that defines when the check is in a failed state. The value will be\ninterpolated into the expression field as `$__threshold`.\n\nInterpreted as a z-score cutoff rather than an absolute value when `baseline` is set.\n",
      "type": "number",
      "format": "double"
    },
    "baseline": {
      "$ref": "#/components/schemas/CheckThresholdBaseline",
      "description": "Compare the check rule's observed quantity against its own past instead of against an\nabsolute value. Setting this re-interprets `degraded` and `failed` as z-score cutoffs.\n\nMutually exclusive with `changeGate`.\n"
    },
    "changeGate": {
      "$ref": "#/components/schemas/CheckThresholdChangeGate",
      "description": "Require the observed quantity to have changed materially compared to a recent window\nbefore the absolute `degraded` / `failed` thresholds are allowed to fail the check.\n`degraded` and `failed` remain absolute values.\n\nMutually exclusive with `baseline`.\n"
    }
  }
}