probeSLO

get_slo

Retrieve the current state of an SLO

Activity as code

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

Typeprobe
Modulechaoshoneycomb.slo.probes
Nameget_slo
Returnmapping

Usage

JSON

{
  "name": "get-slo",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaoshoneycomb.slo.probes",
    "func": "get_slo",
    "arguments": {
      "dataset_slug": "",
      "slo_id": ""
    }
  }
}

YAML

name: get-slo
provider:
  arguments:
    dataset_slug: ''
    slo_id: ''
  func: get_slo
  module: chaoshoneycomb.slo.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
dataset_slugstringYesDatasetDataset slug
slo_idstringYesSLO Identifier
detailedbooleantrueNoDetailedReturn a detailed SLO report

Signature

def get_slo(dataset_slug: str,
            slo_id: str,
            detailed: bool = True,
            configuration: Dict[str, Dict[str, str]] = None,
            secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass