Add sets the name as a reference to the given circuit breaker.

Call wraps a function the Breaker will protect. A failure is recorded whenever the function returns an error. If the called function takes longer than

Fail increments the failure count

Limit returns true if rate was exceeded

Tripped returns true if the circuit breaker is tripped, false if it is reset.

Reset resets the counts to 0

Ready will return true if the circuit breaker is ready to call the function. It will be ready if the breaker is in a reset state, or if it is time to

NewThresholdBreaker creates a Breaker with a ThresholdTripFunc.

NewBreaker creates a base breaker with an exponential backoff and no TripFunc

Reset will reset the circuit breaker. After Reset() is called, Tripped() will return false.

Trip will trip the circuit breaker. After Trip() is called, Tripped() will return true.

New creates a new rate limiter instance

Sucecss increments the success count

Fail is used to indicate a failure condition the Breaker should record. It will increment the failure counters and store the time of the last failure.

SetSpanTags sets one or more tags on the given span according to the error.

Do wraps http.Client Do()

Get retrieves a circuit breaker by name. If no circuit breaker exists, it returns the NoOp one and sets ok to false.

NewPanel creates a new Panel

StreamServerInterceptor is a gRPC server-side interceptor that provides Prometheus monitoring for Streaming RPCs.

UnaryServerInterceptor is a gRPC server-side interceptor that provides Prometheus monitoring for Unary RPCs.

Get wraps http.Client Get()

NewBreakerWithOptions creates a base breaker with a specified backoff, clock and TripFunc

CallContext is same as Call but if the ctx is canceled after the circuit returned an error, the error will not be marked as a failure because the call

ConsecFailures returns the number of consecutive failures that have occured.

ErrorClass returns the class of the given error

Failures returns the number of failures for this circuit breaker.

NewRateBreaker creates a Breaker with a RateTripFunc.

newOptions returns the default options.

Failures returns the total number of failures recorded in all buckets.

Subscribe returns a channel of PanelEvents. Whenever a breaker changes state, the PanelEvent will be sent over the channel. See BreakerEvent for the t

Successes returns the number of successes for this circuit breaker.

UnaryClientInterceptor is a gRPC client-side interceptor that provides Prometheus monitoring for Unary RPCs.

newWindow creates a new window. windowTime is the time covering the entire window. windowBuckets is the number of buckets the window is divided into.

EnableClientHandlingTimeHistogram turns on recording of handling time of RPCs. Histogram metrics can be very expensive for Prometheus to retain and qu

EnableHandlingTimeHistogram enables histograms being registered when registering the ServerMetrics on a Prometheus registry. Histograms can be expensi

ErrorRate returns the error rate calculated over all buckets, expressed as a floating point number (e.g. 0.9 for 90%)

ErrorRate returns the current error rate of the Breaker, expressed as a floating point number (e.g. 0.9 for 90%), since the last time the breaker was

InitializeMetrics initializes all metrics, with their appropriate null value, for all gRPC methods registered on a gRPC server. This is useful, to ens

NewClientMetrics returns a ClientMetrics object. Use a new instance of ClientMetrics when not using the default Prometheus metrics registry, for examp

NewConsecutiveBreaker creates a Breaker with a ConsecutiveTripFunc.

NewHTTPClient provides a circuit breaker wrapper around http.Client. It wraps all of the regular http.Client functions. Specifying 0 for timeout will

NewServerMetrics returns a ServerMetrics object. Use a new instance of ServerMetrics when not using the default Prometheus metrics registry, for examp

StreamClientInterceptor is a gRPC client-side interceptor that provides Prometheus monitoring for Streaming RPCs.

Success is used to indicate a success condition the Breaker should record. If the success was triggered by a retry attempt, the breaker will be Reset(

Successes returns the total number of successes recorded in all buckets.

getLatestBucket returns the current bucket. If the bucket time has elapsed it will move to the next bucket, resetting its counts and updating the last

state returns the state of the TrippableBreaker. The states available are: closed - the circuit is in a reset state and is operational open - the circ

toFloat64HistCount does the same thing as prometheus go client testutil.ToFloat64, but for histograms. TODO(bwplotka): Upstream this function to prome

now as unix nanoseconds

AddListener adds a channel of ListenerEvents on behalf of a listener. The listener channel must be buffered.

Break trips the circuit breaker and prevents it from auto resetting. Use this when manual control over the circuit breaker state is needed.

Collect is called by the Prometheus registry when collecting metrics. The implementation sends each collected metric via the provided channel and retu

ConsecutiveTripFunc returns a TripFunc that trips whenever the consecutive failure count meets the threshold.

EnableClientHandlingTimeHistogram turns on recording of handling time of RPCs. Histogram metrics can be very expensive for Prometheus to retain and qu

EnableHandlingTimeHistogram turns on recording of handling time of RPCs. Histogram metrics can be very expensive for Prometheus to retain and query. T

NewHTTPClientWithBreaker provides a circuit breaker wrapper around http.Client. It wraps all of the regular http.Client functions using the provided B

RateTripFunc returns a TripFunc that trips whenever the error rate hits the threshold. The error rate is calculated as such: f = number of failures s

Register takes a gRPC server and pre-initializes all counters to 0. This allows for easier monitoring in Prometheus (no missing metrics), and should b

RegisterExampleServiceHandler registers the http handlers for service ExampleService to "mux". The handlers forward requests to the grpc endpoint over

RegisterExampleServiceHandlerClient registers the http handlers for service ExampleService to "mux". The handlers forward requests to the grpc endpoin

RemoveListener removes a channel previously added via AddListener. Once removed, the channel will no longer receive ListenerEvents. Returns true if th

ResetCounters will reset only the failures, consecFailures, and success counters

Subscribe returns a channel of BreakerEvents. Whenever the breaker changes state, the state will be sent over the channel. See BreakerEvent for the ty

ThresholdTripFunc returns a TripFunc with that trips whenever the failure count meets the threshold.