Skip to content

Goal

Used by
Source code in docs_src/capo_application_signals/types/goal.py 
13
14
15
16
17
18
19
20
21
22
23
class Goal(TypedDict, closed=True):
    interval: NotRequired["capo_application_signals.types.interval.Interval"]
    """<p>The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.</p> <p>If you omit this parameter, a rolling interval of 7 days is used.</p>"""
    attainment_goal: NotRequired[
        "capo_application_signals.types.attainment_goal.AttainmentGoal"
    ]
    """<p>The threshold that determines if the goal is being met.</p> <p>If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.</p> <p>If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.</p> <p>If you omit this parameter, 99 is used to represent 99% as the attainment goal.</p>"""
    warning_threshold: NotRequired[
        "capo_application_signals.types.warning_threshold.WarningThreshold"
    ]
    """<p>The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used. </p>"""

attainment_goal instance-attribute 

attainment_goal: NotRequired[AttainmentGoal]

The threshold that determines if the goal is being met.

If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.

If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.

If you omit this parameter, 99 is used to represent 99% as the attainment goal.

interval instance-attribute 

interval: NotRequired[Interval]

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

If you omit this parameter, a rolling interval of 7 days is used.

warning_threshold instance-attribute 

warning_threshold: NotRequired[WarningThreshold]

The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.