gobreaker

package

v2.0.1 Latest Latest Go to latest Published: Jun 8, 2022 License: Apache-2.0 Imports: 5 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/krakendio/krakend-circuitbreaker

Links

Open Source Insights

Documentation ¶

Overview ¶

Package gobreaker provides a circuit breaker adapter using the sony/gobreaker lib.

Sample backend extra config

...
"extra_config": {
	...
	"github.com/devopsfaith/krakend-circuitbreaker/gobreaker": {
		"interval":        60,
		"timeout":         10,
		"max_errors":       5,
		"log_status_change": true,
	},
	...
},
...

The gobreaker package provides an efficient circuit breaker implementation. See https://github.com/sony/gobreaker and https://martinfowler.com/bliki/CircuitBreaker.html for more details.

Index ¶

Constants
Variables
func ConfigGetter(e config.ExtraConfig) interface{}
func NewCircuitBreaker(cfg Config, logger logging.Logger) *gobreaker.CircuitBreaker
type Config

Constants ¶

View Source

const Namespace = "github.com/devopsfaith/krakend-circuitbreaker/gobreaker"

Namespace is the key to use to store and access the custom config data

Variables ¶

View Source

var ZeroCfg = Config{}

ZeroCfg is the zero value for the Config struct

Functions ¶

func ConfigGetter ¶

func ConfigGetter(e config.ExtraConfig) interface{}

ConfigGetter implements the config.ConfigGetter interface. It parses the extra config for the gobreaker adapter and returns a ZeroCfg if something goes wrong.

func NewCircuitBreaker ¶

func NewCircuitBreaker(cfg Config, logger logging.Logger) *gobreaker.CircuitBreaker

NewCircuitBreaker builds a gobreaker circuit breaker with the injected config

Types ¶

type Config ¶

type Config struct {
	Name            string
	Interval        int
	Timeout         int
	MaxErrors       int
	LogStatusChange bool
}

Config is the custom config struct containing the params for the sony/gobreaker package

Source Files ¶

View all Source files

gobreaker.go

Directories ¶

Path	Synopsis
proxy Package gobreaker provides a circuit breaker proxy middleware using the sony/gobreaker lib.	Package gobreaker provides a circuit breaker proxy middleware using the sony/gobreaker lib.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL