Share via

RampUpRule Class

Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

Constructor

RampUpRule(*, action_host_name: str | None = None, reroute_percentage: float | None = None, change_step: float | None = None, change_interval_in_minutes: int | None = None, min_reroute_percentage: float | None = None, max_reroute_percentage: float | None = None, change_decision_callback_url: str | None = None, name: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
action_host_name
str

Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

Default value: None
reroute_percentage
float

Percentage of the traffic which will be redirected to <code>ActionHostName</code>.

Default value: None
change_step
float

In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.

Default value: None
change_interval_in_minutes
int

Specifies interval in minutes to reevaluate ReroutePercentage.

Default value: None
min_reroute_percentage
float

Specifies lower boundary above which ReroutePercentage will stay.

Default value: None
max_reroute_percentage
float

Specifies upper boundary below which ReroutePercentage will stay.

Default value: None
change_decision_callback_url
str

Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified.

Default value: None
name
str

Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

Default value: None

Variables

Name Description
action_host_name
str

Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
reroute_percentage
float

Percentage of the traffic which will be redirected to <code>ActionHostName</code>.
change_step
float

In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.
change_interval_in_minutes
int

Specifies interval in minutes to reevaluate ReroutePercentage.
min_reroute_percentage
float

Specifies lower boundary above which ReroutePercentage will stay.
max_reroute_percentage
float

Specifies upper boundary below which ReroutePercentage will stay.
change_decision_callback_url
str

Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified.
name
str

Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.