Component schema

SloRatioMetric

object1 direct reference

Definition

Ratio-based SLI metric. Provide either good+total, bad+total, or raw with rawType.

boolean

True if the metric is a monotonically increasing counter, false if it is a single number that can arbitrarily go up or down. Ignored when using raw.

SloMetricSourceWrapper

The numerator representing good events. Either good or bad must be provided when using total.

SloMetricSourceWrapper

The numerator representing bad events. Either good or bad must be provided when using total.

SloMetricSourceWrapper

The denominator representing total events. Used with either good or bad.

SloMetricSourceWrapper

A precomputed ratio stored as a metric. Cannot be used together with good/bad/total.

SloRawType

Required with raw. Indicates how the stored ratio was calculated:

success: good/total
failure: bad/total

"success""failure"

Used by 1

These schemas and endpoints reference this type directly.

SchemaSloIndicatorSpec

json

OpenAPI source12345678910111213141516171819202122232425262728
{
  "description": "Ratio-based SLI metric. Provide either good+total, bad+total, or raw with rawType.",
  "properties": {
    "counter": {
      "description": "True if the metric is a monotonically increasing counter, false if it is a single number that can arbitrarily go up or down. Ignored when using raw.",
      "type": "boolean"
    },
    "good": {
      "$ref": "#/components/schemas/SloMetricSourceWrapper",
      "description": "The numerator representing good events. Either good or bad must be provided when using total."
    },
    "bad": {
      "$ref": "#/components/schemas/SloMetricSourceWrapper",
      "description": "The numerator representing bad events. Either good or bad must be provided when using total."
    },
    "total": {
      "$ref": "#/components/schemas/SloMetricSourceWrapper",
      "description": "The denominator representing total events. Used with either good or bad."
    },
    "raw": {
      "$ref": "#/components/schemas/SloMetricSourceWrapper",
      "description": "A precomputed ratio stored as a metric. Cannot be used together with good/bad/total."
    },
    "rawType": {
      "$ref": "#/components/schemas/SloRawType"
    }
  }
}