Golang高效实现断路器模式的插件库circuit的使用

Circuit是一个高效的、功能完整的Golang断路器模式实现，类似于Netflix的Hystrix。下面我将介绍如何使用这个库。

主要特性

• 无需强制使用goroutines
• 可恢复的panic()
• 与context.Context集成
• 全面的指标跟踪
• 高效的实现和基准测试
• 低/零内存分配成本
• 支持Netflix Hystrix仪表板
• 多种错误处理功能
• 通过expvar公开电路健康和配置
• SLO跟踪
• 可自定义的状态转换逻辑
• 实时配置更改
• 丰富的测试和示例

基本使用示例

1. 创建简单电路

// 管理所有电路
h := circuit.Manager{}
// 创建具有唯一名称的电路
c := h.MustCreateCircuit("hello-world")
// 调用电路
errResult := c.Execute(context.Background(), func(ctx context.Context) error {
  return nil
}, nil)
fmt.Println("Result of execution:", errResult)
// Output: Result of execution: <nil>

2. 使用回退逻辑

// 可以不使用管理器创建电路
c := circuit.NewCircuitFromConfig("hello-world-fallback", circuit.Config{})
errResult := c.Execute(context.Background(), func(ctx context.Context) error {
    return errors.New("this will fail")
}, func(ctx context.Context, err error) error {
    fmt.Println("Circuit failed with error, but fallback returns nil")
    return nil
})
fmt.Println("Execution result:", errResult)
// Output: Circuit failed with error, but fallback returns nil
// Execution result: <nil>

3. 在goroutine中运行

h := circuit.Manager{}
c := h.MustCreateCircuit("untrusting-circuit", circuit.Config{
  Execution: circuit.ExecutionConfig{
    // 在几毫秒后超时
    Timeout: time.Millisecond * 30,
  },
})

errResult := c.Go(context.Background(), func(ctx context.Context) error {
  // 睡眠30秒，远超过我们的超时时间
  time.Sleep(time.Second * 30)
  return nil
}, nil)
fmt.Printf("err=%v", errResult)
// Output: err=context deadline exceeded

Hystrix配置示例

configuration := hystrix.Factory{
  // Hystrix打开逻辑是在错误百分比后打开电路
  ConfigureOpener: hystrix.ConfigureOpener{
    // 我们改为等待10个请求，而不是20个，然后检查关闭
    RequestVolumeThreshold: 10,
    // 默认值匹配hystrix的默认值
  },
  // Hystrix关闭逻辑是先睡眠然后检查
  ConfigureCloser: hystrix.ConfigureCloser{
    // 默认值匹配hystrix的默认值
  },
}
h := circuit.Manager{
  // 告诉管理器在创建新电路时使用此配置工厂
  DefaultCircuitProperties: []circuit.CommandPropertiesConstructor{configuration.Configure},
}
// 此电路将从示例继承配置
c := h.MustCreateCircuit("hystrix-circuit")
fmt.Println("This is a hystrix configured circuit", c.Name())
// Output: This is a hystrix configured circuit hystrix-circuit

启用仪表板指标

// metriceventstream使用滚动统计报告电路信息
sf := rolling.StatFactory{}
h := circuit.Manager{
  DefaultCircuitProperties: []circuit.CommandPropertiesConstructor{sf.CreateConfig},
}
es := metriceventstream.MetricEventStream{
  Manager: &h,
}
go func() {
  if err := es.Start(); err != nil {
    log.Fatal(err)
  }
}()
// ES是一个http.Handler，所以可以直接传递给你的mux
http.Handle("/hystrix.stream", &es)
// ...
if err := es.Close(); err != nil {
  log.Fatal(err)
}
// Output:

运行时配置更改

// 从默认值开始
configuration := hystrix.ConfigFactory{}
h := circuit.Manager{
  // 告诉管理器在创建新电路时使用此配置工厂
  DefaultCircuitProperties: []circuit.CommandPropertiesConstructor{configuration.Configure},
}
c := h.MustCreateCircuit("hystrix-circuit")
fmt.Println("The default sleep window", c.OpenToClose.(*hystrix.Closer).Config().SleepWindow)
// 此配置更新函数是线程安全的。我们可以在电路活动时在运行时修改此配置
c.OpenToClose.(*hystrix.Closer).SetConfigThreadSafe(hystrix.ConfigureCloser{
  SleepWindow: time.Second * 3,
})
fmt.Println("The new sleep window", c.OpenToClose.(*hystrix.Closer).Config().SleepWindow)
// Output:
// The default sleep window 5s
// The new sleep window 3s

不将用户错误计为故障

c := circuit.NewCircuitFromConfig("divider", circuit.Config{})
divideInCircuit := func(numerator, denominator int) (int, error) {
  var result int
  err := c.Run(context.Background(), func(ctx context.Context) error {
    if denominator == 0 {
      // 此错误类型不计为电路故障
      return &circuit.SimpleBadRequest{
        Err: errors.New("someone tried to divide by zero"),
      }
    }
    result = numerator / denominator
    return nil
  })
  return result, err
}
_, err := divideInCircuit(10, 0)
fmt.Println("Result of 10/0 is", err)
// Output: Result of 10/0 is someone tried to divide by zero

性能基准

这个实现在每种配置下都比go-hystrix更高效。与其他实现相比，在高并发运行时对大多数情况来说更快。

仅限高并发通过电路(常见情况)的基准：

BenchmarkCiruits/cep21-circuit/Minimal/passing/75-8      	20000000	        87.7 ns/op	       0 B/op	       0 allocs/op
BenchmarkCiruits/GoHystrix/DefaultConfig/passing/75-8    	  500000	      2498 ns/op	     990 B/op	      20 allocs/op
BenchmarkCiruits/rubyist/Threshold-10/passing/75-8       	 2000000	       849 ns/op	     309 B/op	       4 allocs/op
BenchmarkCiruits/gobreaker/Default/passing/75-8          	 2000000	       698 ns/op	       0 B/op	       0 allocs/op
BenchmarkCiruits/handy/Default/passing/75-8              	 1000000	      1795 ns/op	       0 B/op	       0 allocs/op
BenchmarkCiruits/iand_circuit/Default/passing/75-8       	 5000000	       349 ns/op	       0 B/op	       0 allocs/op

开发

确保你的测试通过go test并且你的lint通过golangci-lint run。

示例

你可以在/example目录中运行一组示例电路

go run example/main.go

输出看起来像这样：

go run example/main.go
2017/12/19 15:24:42 Serving on socket :8123
2017/12/19 15:24:42 To view the stream, execute:
2017/12/19 15:24:42   curl http://localhost:8123/hystrix.stream
2017/12/19 15:24:42
2017/12/19 15:24:42 To view expvar metrics, visit expvar in your browser
2017/12/19 15:24:42   http://localhost:8123/debug/vars
2017/12/19 15:24:42
2017/12/19 15:24:42 To view a dashboard, follow the instructions at https://github.com/Netflix/Hystrix/wiki/Dashboard#run-via-gradle
2017/12/19 15:24:42   git clone git@github.com:Netflix/Hystrix.git
2017/12/19 15:24:42   cd Hystrix/hystrix-dashboard
2017/12/19 15:24:42   ../gradlew jettyRun
2017/12/19 15:24:42
2017/12/19 15:24:42 Then, add the stream http://localhost:8123/hystrix.stream

如果你加载Hystrix仪表板(按照上面的说明)，你应该能看到所有示例电路的指标。