circuitbreaker

README

Circuit Breaker

Circuit Breaker filters out nodes that have higher error ratio by collecting response of each request.

Usages

Use client.WithCircuitBreakerName("xxx") to specify a circuit breaker.

opts := []client.Option{
	client.WithCircuitBreakerName("xxxx"),
}

proxy := pb.NewGreeterProxy()
req := &pb.HelloRequest{
	Msg: "trpc-go-client",
}
proxy.SayHello(ctx, req, opts...)

Circuit Breaker Interface

// CircuitBreaker defines whether a node is available and reports the result of RPC on the node.
type CircuitBreaker interface {
	Available(node *registry.Node) bool
	Report(node *registry.Node, cost time.Duration, err error) error
}

The default implementation is NOOP.

Documentation

Overview

Package circuitbreaker is a pluggable circuit breaker module.

Index

• func Register(name string, s CircuitBreaker)
• func SetDefaultCircuitBreaker(cb CircuitBreaker)
• type CircuitBreaker
  • func Get(name string) CircuitBreaker
• type NoopCircuitBreaker
  • func (*NoopCircuitBreaker) Available(*registry.Node) bool
  • func (*NoopCircuitBreaker) Report(*registry.Node, time.Duration, error) error
• type Options

Functions

func Register

func Register(name string, s CircuitBreaker)

Register registers a named circuit breaker.

func SetDefaultCircuitBreaker

func SetDefaultCircuitBreaker(cb CircuitBreaker)

SetDefaultCircuitBreaker sets the default circuit breaker.

Types

type CircuitBreaker

type CircuitBreaker interface {
	Available(node *registry.Node) bool
	Report(node *registry.Node, cost time.Duration, err error) error
}

CircuitBreaker is the interface that defines the circuit breaker which determines whether a node is available and report the result of an RPC on the node.

var DefaultCircuitBreaker CircuitBreaker = &NoopCircuitBreaker{}

DefaultCircuitBreaker is the default circuit breaker.

func Get

func Get(name string) CircuitBreaker

Get gets a named circuit breaker.

type NoopCircuitBreaker

type NoopCircuitBreaker struct{}

NoopCircuitBreaker is a noop circuit breaker.

func (*NoopCircuitBreaker) Available

func (*NoopCircuitBreaker) Available(*registry.Node) bool

Available always returns true.

func (*NoopCircuitBreaker) Report

func (*NoopCircuitBreaker) Report(*registry.Node, time.Duration, error) error

Report does nothing.

type Options

type Options struct{}

Options defines the call options.