Package com.datastax.driver.core.policies

Class PercentileSpeculativeExecutionPolicy

java.lang.Object

com.datastax.driver.core.policies.PercentileSpeculativeExecutionPolicy

All Implemented Interfaces:

SpeculativeExecutionPolicy

public class PercentileSpeculativeExecutionPolicy
extends Object
implements SpeculativeExecutionPolicy

A policy that triggers speculative executions when the request to the current host is above a given percentile.

Nested Class Summary

Nested classes/interfaces inherited from interface com.datastax.driver.core.policies.SpeculativeExecutionPolicy

SpeculativeExecutionPolicy.SpeculativeExecutionPlan

Constructor Summary

Constructors

Constructor	Description
PercentileSpeculativeExecutionPolicy(PercentileTracker percentileTracker, double percentile, int maxSpeculativeExecutions)	Builds a new instance.

Method Summary

Modifier and Type	Method	Description
void	close()	Gets invoked at cluster shutdown.
int	getMaxSpeculativeExecutions()	The maximum number of speculative executions this policy triggers for a request, as specified at instantiation.
double	getPercentile()	The latency percentile a request must fall into to be considered slow, as specified at instantiation.
void	init(Cluster cluster)	Gets invoked at cluster startup.
SpeculativeExecutionPolicy.SpeculativeExecutionPlan	newPlan(String loggedKeyspace, Statement statement)	Returns the plan to use for a new query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PercentileSpeculativeExecutionPolicy

public PercentileSpeculativeExecutionPolicy(PercentileTracker percentileTracker,
                                            double percentile,
                                            int maxSpeculativeExecutions)

Builds a new instance.

Parameters:

percentileTracker - the component that will record latencies. It will get registered with the cluster when this policy initializes.

percentile - the percentile that a request's latency must fall into to be considered slow (ex: 99.0).

maxSpeculativeExecutions - the maximum number of speculative executions that will be triggered for a given request (this does not include the initial, normal request). Must be strictly positive.

Method Detail

getMaxSpeculativeExecutions

@Beta
public int getMaxSpeculativeExecutions()

The maximum number of speculative executions this policy triggers for a request, as specified at instantiation. This does not include the initial, normal request.

Returns:

the maximum number of speculative executions, always strictly positive.

getPercentile

@Beta
public double getPercentile()

The latency percentile a request must fall into to be considered slow, as specified at instantiation.

Returns:

the percentile, in the range 0 (inclusive) to 100 (exclusive).

newPlan

public SpeculativeExecutionPolicy.SpeculativeExecutionPlan newPlan(String loggedKeyspace,
                                                                   Statement statement)

Description copied from interface: SpeculativeExecutionPolicy

Returns the plan to use for a new query.

Specified by:

newPlan in interface SpeculativeExecutionPolicy

Parameters:

loggedKeyspace - the currently logged keyspace (the one set through either Cluster.connect(String) or by manually doing a USE query) for the session on which this plan need to be built. This can be null if the corresponding session has no keyspace logged in.

statement - the query for which to build a plan.

Returns:

the plan.

init

public void init(Cluster cluster)

Description copied from interface: SpeculativeExecutionPolicy

Gets invoked at cluster startup.

Specified by:

init in interface SpeculativeExecutionPolicy

Parameters:

cluster - the cluster that this policy is associated with.

close

public void close()

Description copied from interface: SpeculativeExecutionPolicy

Gets invoked at cluster shutdown.

This gives the policy the opportunity to perform some cleanup, for instance stop threads that it might have started.

Specified by:

close in interface SpeculativeExecutionPolicy