熔断器

熔断器中间件，用于提供客户端熔断功能，默认实现了sre breaker 算法。

配置

WithGroup

breaker 依赖于 container/group 来实现对于针对不同 Operation 使用互相独立的 breaker。 WithGroup 可以配置自定义的 Breaker 来替换默认的熔断算法：

// WithGroup with circuit breaker group.
// NOTE: implements generics circuitbreaker.CircuitBreaker
func WithGroup(g *group.Group) Option {
    return func(o *options) {
        o.group = g
    }
}

默认配置会针对不同的 Operation 生成独立的 breaker：

opt := &options{
    group: group.NewGroup(func() interface{} {
        return sre.NewBreaker()
    }),
}

group.Group 是一个 懒加载容器 在本文中装载进 group.Group 的实例，应实现 aegis/circuitbreaker 的 CircuitBreaker 接口。

// CircuitBreaker is a circuit breaker.
type CircuitBreaker interface {
    Allow() error // 判断请求是否允许发送,如果返回 error 则表示请求被拒绝
    MarkSuccess() // 标记请求成功
    MarkFailed() // 标记请求失败
}

使用方法

在 Client 请求中使用熔断器

// http
conn, err := http.NewClient(
    context.Background(),
    http.WithMiddleware(
        circuitbreaker.Client(),
    ),
    http.WithEndpoint("127.0.0.1:8000"),
)
// grpc 
conn,err := transgrpc.Dial(
  context.Background(), 
    grpc.WithMiddleware(
        circuitbreaker.Client(),
    ),
  grpc.WithEndpoint("127.0.0.1:9000"),
)

触发熔断

当熔断器触发时，会在一段时间内对于该Operation的调用快速失败，并返回错误ErrNotAllowed，定义如下：

// ErrNotAllowed is request failed due to circuit breaker triggered.
var ErrNotAllowed = errors.New(503, "CIRCUITBREAKER", "request failed due to circuit breaker triggered")