Component schema

CheckThresholdChangeGate

object1 direct reference

Definition

Change gate configuration. Its presence on CheckThresholds leaves degraded and failed absolute, but additionally requires the observed quantity to be materially worse than it was over baselineWindow before the check fails. The check rule expression must provide the absolute threshold comparator through its parsed expression or a hand-written top-level comparison; otherwise the write is rejected.

ChangeGateComparisonrequired

How the change gate's value is compared against the observed quantity's recent level.

absolute_delta: The observed quantity must differ from its recent level by at least value, in the unit of the observed quantity itself and in the worsening direction defined by the rule's absolute threshold comparator.
relative_factor: The observed quantity must differ from its recent level by at least value times in the worsening direction defined by the rule's absolute threshold comparator.

"absolute_delta""relative_factor"

numberrequired

The minimum change required, interpreted according to comparison.

Durationrequired

The window the observed quantity's recent level is derived from.

number

Optional minimum windowed recent level required for the detector to evaluate. The unit is the observed quantity's unit, so suitable values depend on the selected signal.

Used by 1

These schemas and endpoints reference this type directly.

SchemaCheckThresholds

json

OpenAPI source1234567891011121314151617181920212223242526272829
{
  "description": "Change gate configuration. Its presence on `CheckThresholds` leaves `degraded` and `failed`\nabsolute, but additionally requires the observed quantity to be materially worse than it was\nover `baselineWindow` before the check fails. The check rule expression must provide the\nabsolute threshold comparator through its parsed expression or a hand-written top-level\ncomparison; otherwise the write is rejected.\n",
  "properties": {
    "comparison": {
      "$ref": "#/components/schemas/ChangeGateComparison"
    },
    "value": {
      "description": "The minimum change required, interpreted according to `comparison`.\n",
      "type": "number",
      "format": "double"
    },
    "baselineWindow": {
      "$ref": "#/components/schemas/Duration",
      "description": "The window the observed quantity's recent level is derived from.\n"
    },
    "volumeFloor": {
      "description": "Optional minimum windowed recent level required for the detector to evaluate. The unit\nis the observed quantity's unit, so suitable values depend on the selected signal.\n",
      "type": "number",
      "format": "double",
      "minimum": 0,
      "exclusiveMinimum": true
    }
  },
  "required": [
    "comparison",
    "value",
    "baselineWindow"
  ]
}