timeouthttp

README

go-timeout-httpclient

Yet another HTTP Client with configurable timeouts and TLS options.

Usage

Create a HTTP client with specific timeouts once and re-use it wherever you need it.

import "github.com/pteich/go-timeout-httpclient"

// Create an HTTP client with a timeout of 5s
httpClient := timeouthttp.New(timeouthttp.WithTimeout(5))

Built-in Circuit Breaker

Using the option timeouthttp.WithCircuitBreaker() automatically enables a circuit breaker for the requested host. This is implemented using the http.RoundTripper interface.

By now there are no further configuration values possible. This means the circuit is considered open if there are more than 3 requests and a failure ratio > 0.6.

Caveat: A new circuit breaker is created for every new host. There will be a memory issue if you request a lot of different hosts as there is no cleaning build in for the time being.

Documentation

Index

• func New(opts ...Option) *http.Client
• func NewClient(config Config) *http.Client
• func NewPooledClient(config Config) *http.Client
• type Client
• type Config
• type Option
  • func WithCircuitBreaker() Option
  • func WithConnectTimeout(timeout int) Option
  • func WithKeepAliveTimeout(timeout int) Option
  • func WithMaxIdleConnections(count int) Option
  • func WithPooledTransport(maxIdleConnectionsPerHost int) Option
  • func WithRequestTimeout(timeout int) Option
  • func WithTimeout(timeout int) Option
  • func WithTlsConfig(tlsConfig *tls.Config) Option
  • func WithTransport(t http.RoundTripper) Option
• type Transport
  • func DefaultPooledTransport(config Config) *Transport
  • func DefaultTransport(config Config) *Transport
  • func (t *Transport) RoundTrip(r *http.Request) (*http.Response, error)

Functions

func New

func New(opts ...Option) *http.Client

New returns a new clean HTTP.Client with variable options set

func NewClient

func NewClient(config Config) *http.Client

NewClient returns a new clean HTTP.Client with timeouts (default 1s for connection and request), disabled idle connections and disabled keep-alives

func NewPooledClient

func NewPooledClient(config Config) *http.Client

NewPooledClient returns a new clean HTTP.Client with timeouts (default 1s for connection and request) and shared transport across hosts with keepalive on, you can set the number of idle connections per host with Config.MaxIdleConnsPerHost (default 1)

Types

type Client

type Client struct {
	http.Client
}

type Config

type Config struct {
	ConnectTimeout            int
	RequestTimeout            int
	KeepAliveTimeout          int
	MaxIdleConnectionsPerHost int
	KeepAlive                 bool
	// contains filtered or unexported fields
}

Config defines timeouts and max idle connections per host if pooled transport is used all timeouts are seconds

type Option

type Option func(c *Config)

func WithCircuitBreaker

func WithCircuitBreaker() Option

func WithConnectTimeout

func WithConnectTimeout(timeout int) Option

func WithKeepAliveTimeout

func WithKeepAliveTimeout(timeout int) Option

func WithMaxIdleConnections

func WithMaxIdleConnections(count int) Option

func WithPooledTransport

func WithPooledTransport(maxIdleConnectionsPerHost int) Option

func WithRequestTimeout

func WithRequestTimeout(timeout int) Option

func WithTimeout

func WithTimeout(timeout int) Option

WithTimeout sets all timeouts to the provided value in seconds

func WithTlsConfig

func WithTlsConfig(tlsConfig *tls.Config) Option

func WithTransport

func WithTransport(t http.RoundTripper) Option

type Transport

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

func DefaultPooledTransport

func DefaultPooledTransport(config Config) *Transport

func DefaultTransport

func DefaultTransport(config Config) *Transport

func (*Transport) RoundTrip

func (t *Transport) RoundTrip(r *http.Request) (*http.Response, error)