client

Documentation

Overview

Package client is a generated GoMock package.

Index

• Variables
• func WithRetryPolicy(ctx context.Context, retryPolicy RetryPolicy) context.Context
• type CircuitBreakerSettings
• type Client
• type ExponentialRetryPolicy
  • func (ExponentialRetryPolicy) Backoffs() []time.Duration
  • func (ExponentialRetryPolicy) Retry(req *http.Request, resp *http.Response, err error) bool
• type HystrixSSEEvent
• type MockClient
  • func NewMockClient(ctrl *gomock.Controller) *MockClient
  • func (m *MockClient) EXPECT() *MockClientMockRecorder
  • func (m *MockClient) GetBook(ctx context.Context, i *models.GetBookInput) error
• type MockClientMockRecorder
  • func (mr *MockClientMockRecorder) GetBook(ctx, i interface{}) *gomock.Call
• type NoRetryPolicy
  • func (NoRetryPolicy) Backoffs() []time.Duration
  • func (NoRetryPolicy) Retry(*http.Request, *http.Response, error) bool
• type RetryPolicy
• type SingleRetryPolicy
  • func (SingleRetryPolicy) Backoffs() []time.Duration
  • func (SingleRetryPolicy) Retry(req *http.Request, resp *http.Response, err error) bool
• type WagClient
  • func New(basePath string) *WagClient
  • func NewFromDiscovery() (*WagClient, error)
  • func (c *WagClient) GetBook(ctx context.Context, i *models.GetBookInput) error
  • func (c *WagClient) SetCircuitBreakerDebug(b bool)
  • func (c *WagClient) SetCircuitBreakerSettings(settings CircuitBreakerSettings)
  • func (c *WagClient) SetLogger(logger logger.KayveeLogger)
  • func (c *WagClient) SetRetryPolicy(retryPolicy RetryPolicy)
  • func (c *WagClient) SetTimeout(timeout time.Duration)
  • func (c *WagClient) SetTransport(t http.RoundTripper)

Variables

var DefaultCircuitBreakerSettings = CircuitBreakerSettings{
	MaxConcurrentRequests:  100,
	RequestVolumeThreshold: 20,
	SleepWindow:            5000,
	ErrorPercentThreshold:  90,
}

DefaultCircuitBreakerSettings describes the default circuit parameters.

Functions

func WithRetryPolicy

func WithRetryPolicy(ctx context.Context, retryPolicy RetryPolicy) context.Context

WithRetryPolicy returns a new context that overrides the client object's retry policy.

Types

type CircuitBreakerSettings

type CircuitBreakerSettings struct {
	// MaxConcurrentRequests is the maximum number of concurrent requests
	// the client can make at the same time. Default: 100.
	MaxConcurrentRequests int
	// RequestVolumeThreshold is the minimum number of requests needed
	// before a circuit can be tripped due to health. Default: 20.
	RequestVolumeThreshold int
	// SleepWindow how long, in milliseconds, to wait after a circuit opens
	// before testing for recovery. Default: 5000.
	SleepWindow int
	// ErrorPercentThreshold is the threshold to place on the rolling error
	// rate. Once the error rate exceeds this percentage, the circuit opens.
	// Default: 90.
	ErrorPercentThreshold int
}

CircuitBreakerSettings are the parameters that govern the client's circuit breaker.

type Client

type Client interface {

	// GetBook makes a GET request to /books/{id}
	//
	// 200: nil
	// 400: *models.ExtendedError
	// 404: *models.NotFound
	// 500: *models.InternalError
	// default: client side HTTP errors, for example: context.DeadlineExceeded.
	GetBook(ctx context.Context, i *models.GetBookInput) error
}

Client defines the methods available to clients of the swagger-test service.

type ExponentialRetryPolicy

type ExponentialRetryPolicy struct{}

ExponentialRetryPolicy defines an exponential retry policy

func (ExponentialRetryPolicy) Backoffs

func (ExponentialRetryPolicy) Backoffs() []time.Duration

Backoffs returns five backoffs with exponentially increasing wait times between requests: 100, 200, 400, 800, and 1600 milliseconds +/- up to 5% jitter.

func (ExponentialRetryPolicy) Retry

func (ExponentialRetryPolicy) Retry(req *http.Request, resp *http.Response, err error) bool

Retry will retry non-POST, non-PATCH requests that 5XX. TODO: It does not currently retry any errors returned by net/http.Client's `Do`.

type HystrixSSEEvent

type HystrixSSEEvent struct {
	Type                            string `json:"type"`
	Name                            string `json:"name"`
	RequestCount                    int    `json:"requestCount"`
	ErrorCount                      int    `json:"errorCount"`
	ErrorPercentage                 int    `json:"errorPercentage"`
	IsCircuitBreakerOpen            bool   `json:"isCircuitBreakerOpen"`
	RollingCountFailure             int    `json:"rollingCountFailure"`
	RollingCountFallbackFailure     int    `json:"rollingCountFallbackFailure"`
	RollingCountFallbackSuccess     int    `json:"rollingCountFallbackSuccess"`
	RollingCountShortCircuited      int    `json:"rollingCountShortCircuited"`
	RollingCountSuccess             int    `json:"rollingCountSuccess"`
	RollingCountThreadPoolRejected  int    `json:"rollingCountThreadPoolRejected"`
	RollingCountTimeout             int    `json:"rollingCountTimeout"`
	CurrentConcurrentExecutionCount int    `json:"currentConcurrentExecutionCount"`
	LatencyTotalMean                int    `json:"latencyTotal_mean"`
}

HystrixSSEEvent is emitted by hystrix-go via server-sent events. It describes the state of a circuit.

type MockClient

type MockClient struct {
	// contains filtered or unexported fields
}

MockClient is a mock of Client interface

func NewMockClient

func NewMockClient(ctrl *gomock.Controller) *MockClient

NewMockClient creates a new mock instance

func (*MockClient) EXPECT

func (m *MockClient) EXPECT() *MockClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockClient) GetBook

func (m *MockClient) GetBook(ctx context.Context, i *models.GetBookInput) error

GetBook mocks base method

type MockClientMockRecorder

type MockClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockClientMockRecorder is the mock recorder for MockClient

func (*MockClientMockRecorder) GetBook

func (mr *MockClientMockRecorder) GetBook(ctx, i interface{}) *gomock.Call

GetBook indicates an expected call of GetBook

type NoRetryPolicy

type NoRetryPolicy struct{}

NoRetryPolicy defines a policy of never retrying a request.

func (NoRetryPolicy) Backoffs

func (NoRetryPolicy) Backoffs() []time.Duration

Backoffs returns an empty slice.

func (NoRetryPolicy) Retry

func (NoRetryPolicy) Retry(*http.Request, *http.Response, error) bool

Retry always returns false.

type RetryPolicy

type RetryPolicy interface {
	// Backoffs returns the number and timing of retry attempts.
	Backoffs() []time.Duration
	// Retry receives the http request, as well as the result of
	// net/http.Client's `Do` method.
	Retry(*http.Request, *http.Response, error) bool
}

RetryPolicy defines a retry policy.

type SingleRetryPolicy

type SingleRetryPolicy struct{}

SingleRetryPolicy defines a retry that retries a request once

func (SingleRetryPolicy) Backoffs

func (SingleRetryPolicy) Backoffs() []time.Duration

Backoffs returns that you should retry the request 1second after it fails.

func (SingleRetryPolicy) Retry

func (SingleRetryPolicy) Retry(req *http.Request, resp *http.Response, err error) bool

Retry will retry non-POST, non-PATCH requests that 5XX. TODO: It does not currently retry any errors returned by net/http.Client's `Do`.

type WagClient

type WagClient struct {
	// contains filtered or unexported fields
}

WagClient is used to make requests to the swagger-test service.

func New

func New(basePath string) *WagClient

New creates a new client. The base path and http transport are configurable.

func NewFromDiscovery

func NewFromDiscovery() (*WagClient, error)

NewFromDiscovery creates a client from the discovery environment variables. This method requires the three env vars: SERVICE_SWAGGER_TEST_HTTP_(HOST/PORT/PROTO) to be set. Otherwise it returns an error.

func (*WagClient) GetBook

func (c *WagClient) GetBook(ctx context.Context, i *models.GetBookInput) error

GetBook makes a GET request to /books/{id}

200: nil 400: *models.ExtendedError 404: *models.NotFound 500: *models.InternalError default: client side HTTP errors, for example: context.DeadlineExceeded.

func (*WagClient) SetCircuitBreakerDebug

func (c *WagClient) SetCircuitBreakerDebug(b bool)

SetCircuitBreakerDebug puts the circuit

func (*WagClient) SetCircuitBreakerSettings

func (c *WagClient) SetCircuitBreakerSettings(settings CircuitBreakerSettings)

SetCircuitBreakerSettings sets parameters on the circuit breaker. It must be called on application startup.

func (*WagClient) SetLogger

func (c *WagClient) SetLogger(logger logger.KayveeLogger)

SetLogger allows for setting a custom logger

func (*WagClient) SetRetryPolicy

func (c *WagClient) SetRetryPolicy(retryPolicy RetryPolicy)

SetRetryPolicy sets a the given retry policy for all requests.

func (*WagClient) SetTimeout

func (c *WagClient) SetTimeout(timeout time.Duration)

SetTimeout sets a timeout on all operations for the client. To make a single request with a timeout use context.WithTimeout as described here: https://godoc.org/golang.org/x/net/context#WithTimeout.

func (*WagClient) SetTransport

func (c *WagClient) SetTransport(t http.RoundTripper)

SetTransport sets the http transport used by the client.