Component schema

SloObjective

object1 direct reference

Definition

An objective threshold for the SLO. Defines tolerance levels for the SLI metrics.

string

Human-readable name for this objective.

Comparison operator used to compare the SLI against the value (for thresholdMetric SLIs). Not currently supported — requests that set it are rejected with a 400.

"lte""gte""lt""gt"

number

Threshold value to compare against (for thresholdMetric SLIs). Not currently supported — requests that set it are rejected with a 400.

number

Budget target for this objective as a fraction [0.0, 1.0). Mutually exclusive with targetPercent; one of the two must be provided.

number

Budget target for this objective as a percentage [0.0, 100). Mutually exclusive with target; one of the two must be provided.

number

Target for the ratio of good time slices to total time slices (0.0, 1.0] (for Timeslices budgeting). Not currently supported — requests that set it are rejected with a 400.

Duration

Size of a time slice for evaluation (for Timeslices/RatioTimeslices budgeting). Not currently supported — requests that set it are rejected with a 400.

SloIndicator

Inline SLI for composite SLOs. Composite SLOs are not currently supported — requests that set a per-objective indicator are rejected with a 400. Use the SLO's top-level indicator.

string

Reference to an external SLI for composite SLOs. Composite SLOs are not currently supported — requests that set it are rejected with a 400.

number

Weight multiplier for composite SLOs. Composite SLOs are not currently supported — requests that set it are rejected with a 400.

Used by 1

These schemas and endpoints reference this type directly.

SchemaSloSpec

json

OpenAPI source123456789101112131415161718192021222324252627282930313233343536373839404142434445
{
  "description": "An objective threshold for the SLO. Defines tolerance levels for the SLI metrics.",
  "properties": {
    "displayName": {
      "description": "Human-readable name for this objective.",
      "type": "string"
    },
    "op": {
      "$ref": "#/components/schemas/SloComparisonOperator",
      "description": "Comparison operator used to compare the SLI against the value (for thresholdMetric SLIs). Not currently supported — requests that set it are rejected with a 400."
    },
    "value": {
      "description": "Threshold value to compare against (for thresholdMetric SLIs). Not currently supported — requests that set it are rejected with a 400.",
      "type": "number"
    },
    "target": {
      "description": "Budget target for this objective as a fraction [0.0, 1.0). Mutually exclusive with targetPercent; one of the two must be provided.",
      "type": "number"
    },
    "targetPercent": {
      "description": "Budget target for this objective as a percentage [0.0, 100). Mutually exclusive with target; one of the two must be provided.",
      "type": "number"
    },
    "timeSliceTarget": {
      "description": "Target for the ratio of good time slices to total time slices (0.0, 1.0] (for Timeslices budgeting). Not currently supported — requests that set it are rejected with a 400.",
      "type": "number"
    },
    "timeSliceWindow": {
      "$ref": "#/components/schemas/Duration",
      "description": "Size of a time slice for evaluation (for Timeslices/RatioTimeslices budgeting). Not currently supported — requests that set it are rejected with a 400."
    },
    "indicator": {
      "$ref": "#/components/schemas/SloIndicator",
      "description": "Inline SLI for composite SLOs. Composite SLOs are not currently supported — requests that set a per-objective indicator are rejected with a 400. Use the SLO's top-level indicator."
    },
    "indicatorRef": {
      "description": "Reference to an external SLI for composite SLOs. Composite SLOs are not currently supported — requests that set it are rejected with a 400.",
      "type": "string"
    },
    "compositeWeight": {
      "description": "Weight multiplier for composite SLOs. Composite SLOs are not currently supported — requests that set it are rejected with a 400.",
      "type": "number"
    }
  }
}