com.cloudera.gertrude

Interface Segment

All Known Implementing Classes:

Domain, ExperimentInfo

public interface Segment

A vertical slice of buckets contained inside of a Layer that has associated Condition logic for diversion and overrides to the default flag values.

There are two implementations of this interface. An experiment is a specific configuration of conditions and flag overrides that describes a hypothesis that we are interested in testing. A domain is a higher-level segment that can contain other Layer instances (with their own Segments) nested inside of it. Domains are a useful way of creating shared space for experiments that need to cut across multiple layers (or even binaries) in order to be valid. They can also be used to create custom partitions of the experiment space for long-running experiments or ones where there are concerns about lingering after effects of the experiment on subjects.

Method Summary

Methods

Modifier and Type	Method and Description
void	disable() Turn off this segment, preventing it from diverting requests.
SortedSet<Integer>	getBuckets() The set of buckets claimed by this Segment within its assigned Layer and DiversionCriterion.
long	getEndTimeMsec() Returns the time in milliseconds UTC that this segment stops diverting requests.
int	getId() The unique id of this Segment instance in the current ExperimentSpace.
int	getLayerId() The unique id of the Layer that owns this Segment.
long	getStartTimeMsec() Returns the time in milliseconds UTC that this segment starts diverting requests.
void	handle(ExperimentState state, List<DiversionCriterion> diversionCriteria, Map<String,FlagValueCalculator<Object>> overrides, Set<Integer> newExperimentIds) Modify the given overrides and update newExperimentIds with the ids of any experiments that this request was diverted into.
boolean	isEnabled(long requestTimeMsec) Returns true if this instance is enabled and capable of diverting requests at the given time.
boolean	isValidFor(ExperimentState state) Returns true if the given ExperimentState satisfies the Condition instances associated with this Segment.

Method Detail

getId

int getId()

The unique id of this Segment instance in the current ExperimentSpace.

Returns:

the unique id of this Segment

getLayerId

int getLayerId()

The unique id of the Layer that owns this Segment.

Returns:

the layer id

getBuckets

SortedSet<Integer> getBuckets()

The set of buckets claimed by this Segment within its assigned Layer and DiversionCriterion.

getStartTimeMsec

long getStartTimeMsec()

Returns the time in milliseconds UTC that this segment starts diverting requests.

Returns:

the time in milliseconds UTC when request diversion begins

getEndTimeMsec

long getEndTimeMsec()

Returns the time in milliseconds UTC that this segment stops diverting requests.

Returns:

the time in milliseconds UTC when request diversion ends

isEnabled

boolean isEnabled(long requestTimeMsec)

Returns true if this instance is enabled and capable of diverting requests at the given time.

Parameters:

requestTimeMsec - the time of this request in milliseconds

Returns:

whether or not this segment is enabled for diversion

disable

void disable()

Turn off this segment, preventing it from diverting requests.

isValidFor

boolean isValidFor(ExperimentState state)

Returns true if the given ExperimentState satisfies the Condition instances associated with this Segment.

Parameters:

state - the current ExperimentState

Returns:

true if the conditions evaluate to true, false otherwise

handle

void handle(ExperimentState state,
          List<DiversionCriterion> diversionCriteria,
          Map<String,FlagValueCalculator<Object>> overrides,
          Set<Integer> newExperimentIds)

Modify the given overrides and update newExperimentIds with the ids of any experiments that this request was diverted into.

Parameters:

state - the current ExperimentState

diversionCriteria - the active diversion criteria

overrides - the current overrides to flag value calculations

newExperimentIds - the experiment ids that have been added on this diversion request