Skip to content

Package speculatively provides a simple mechanism to re-execute a task in parallel only after some initial timeout has elapsed.

License

Notifications You must be signed in to change notification settings

mccutchen/speculatively

Repository files navigation

speculatively

Documentation Build status Code coverage Go report card

Package speculatively provides a simple mechanism to speculatively execute a task in parallel only after some initial timeout has elapsed:

// An example task that will wait for a random amount of time before returning
task := func(ctx context.Context) (string, error) {
    delay := time.Duration(float64(250*time.Millisecond) * rand.Float64())
    select {
    case <-time.After(delay):
        return "success", nil
    case <-ctx.Done():
        return "timeout", ctx.Err()
    }
}

ctx, cancel := context.WithTimeout(context.Background(), 50*time.Millisecond)
defer cancel()

// If task doesn't return within 20ms, it will be executed again in parallel
result, err := speculatively.Do(ctx, 20*time.Millisecond, task)

This was inspired by the "Defeat your 99th percentile with speculative task" blog post, which describes it nicely:

The inspiration came from BigData world. In Spark when task execution runs suspiciously long the application master starts the same task speculatively on a different executor but it lets the long running tasks to continue. The solution looked elegant:

  • Service response time limit is 50ms.

  • If the first attempt doesn’t finish within 25ms start a new one, but keep the first thread running.

  • Wait for either thread to finish and take result from the first one ready.

The speculative tasks implemented here are similar to "hedged requests" as described in The Tail at Scale and implemented in the Query example function in Go Concurrency Patterns: Timing out, moving on, but they a) have no knowledge of different replicas and b) wait for a caller-controlled timeout before launching additional tasks.

About

Package speculatively provides a simple mechanism to re-execute a task in parallel only after some initial timeout has elapsed.

Topics

Resources

License

Stars

Watchers

Forks