backoffcli's Introduction

Backoff CLI

~# go run .\cmd\backoff\ -h                      
usage: backoff [<flags>] <path>

A command-line tool designed to implement and manage customizable backoff
strategies for retrying failed operations efficiently..


Flags:
  -h, --[no-]help              Show context-sensitive help (also try --help-long
                               and --help-man).
      --duration.initial=0s    initial wait seconds
      --duration.max=5m        max wait seconds
      --retry.max=0            max retry, 0 means unlimited
      --factor.exponent=1      exponent factor
      --factor.const.inter=0s  inter const factor
      --factor.const.outer=0s  outer const factor
      --name=NAME              pipe name for singleton, default generate by path
      --[no-]singleton         run with singleton parton with unique name

Args:
  <path>  program to run

Backoff Wait Time Calculating Logic

$Wait = duration.initial

for {
    if Fn_Succuess {
        quit
    }
    if HealthCheckExist && HealthCheckSuccess {
        $Wait = duration.initial
    } else {
        $Wait = ($Wait + factor.const.inter) * (2 ^ factor.exponent) + factor.const.outer
        $Wait = min($Wait, duration.max)
    }
    
    sleep($Wait)
}

Use as go library

go get github.com/Mmx233/BackoffCli/backoff

package main

import (
	"context"
	"github.com/Mmx233/BackoffCli/backoff"
	"time"
)

func main() {
	instance := backoff.New(func(ctx context.Context) error {
		// put logic here
		return nil
	}, backoff.Conf{
		Logger:           nil, // logrus logger
		DisableRecovery:  false,
		HealthChecker:    func(ctx context.Context) <-chan error {
			// health check logic
		},
		InitialDuration:  time.Second,
		MaxDuration:      time.Second*10,
		MaxRetry:         10,
		ExponentFactor:   1,
		InterConstFactor: time.Second,
		OuterConstFactor: time.Second,
	})

	if err := instance.Run(context.Background()); err != nil {
		panic(err)
	}
}

Recommend Projects