get_slo_health

Type	probe
Module	chaosgcp.monitoring.probes
Name	get_slo_health
Return	list

Usage

JSON

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

YAML

name: get-slo-health
provider:
  arguments:
    name: ''
  func: get_slo_health
  module: chaosgcp.monitoring.probes
  type: python
type: probe

Arguments

Name	Type	Default	Required	Title	Description
name	string		Yes	Name	The full path to the SLO name such as projects/PROJECT_ID/services/SVC_NAME/serviceLevelObjectives/SLO_ID
end_time	string	now	No	End Window
window	string	5 minutes	No	Window Length
alignment_period	integer	60	No	Alignment Period	Interval, in seconds, that is used to divide the data into consistent blocks of time
per_series_aligner	string	ALIGN_MEAN	No	Per Series Aligner	Describes how to bring the data points in a single time series into temporal alignment
cross_series_reducer	string	REDUCE_MEAN	No	Cross Series Reducer	Reduction operation to be used to combine time series into a single time series
group_by_fields	string	""	No	Group By Fields	Comma-separated set of fields to preserve when Cross Series Reducer is specified

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

For aggregation, see also this

Signature

def get_slo_health(
        name: str,
        end_time: str = 'now',
        window: str = '5 minutes',
        alignment_period: int = 60,
        per_series_aligner: str = 'ALIGN_MEAN',
        cross_series_reducer: int = 'REDUCE_COUNT',
        group_by_fields: Union[str, List[str], NoneType] = None,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> List[Dict[str, Any]]:
    pass