probeMonitoring

get_slo_burn_rate

Answers the question, “How much of the error budget remained at the time of the measurement?”

Activity as code

Below are the details and signature of the activity Python module.

Typeprobe
Modulechaosgcp.monitoring.probes
Nameget_slo_burn_rate
Returnlist

Usage

JSON

{
  "name": "get-slo-burn-rate",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgcp.monitoring.probes",
    "func": "get_slo_burn_rate",
    "arguments": {
      "name": ""
    }
  }
}

YAML

name: get-slo-burn-rate
provider:
  arguments:
    name: ''
  func: get_slo_burn_rate
  module: chaosgcp.monitoring.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
namestringYesNameThe full path to the SLO name such as projects/PROJECT_ID/services/SVC_NAME/serviceLevelObjectives/SLO_ID
end_timestringnowNoEnd Window
windowstring5 minutesNoWindow Length
loopback_periodstring300sNoLoopback PeriodRate within which to compute number of bad requests

See https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/timeseries-selectors

Signature

def get_slo_burn_rate(
        name: str,
        end_time: str = 'now',
        window: str = '5 minutes',
        loopback_period: str = '300s',
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> List[Dict[str, Any]]:
    pass