http

Documentation

Overview

Package http provides a client with included tracing capabilities.

Index

• type Client
• type OptionFunc
  • func CircuitBreaker(name string, set circuitbreaker.Setting) OptionFunc
  • func Timeout(timeout time.Duration) OptionFunc
  • func Transport(rt http.RoundTripper) OptionFunc
• type TracedClient
  • func New(oo ...OptionFunc) (*TracedClient, error)
  • func (tc *TracedClient) Do(ctx context.Context, req *http.Request) (*http.Response, error)

Types

type Client

type Client interface {
	Do(ctx context.Context, req *http.Request) (*http.Response, error)
}

Client interface of a HTTP client.

type OptionFunc

type OptionFunc func(*TracedClient) error

OptionFunc definition for configuring the client in a functional way.

func CircuitBreaker

func CircuitBreaker(name string, set circuitbreaker.Setting) OptionFunc

CircuitBreaker option for setting up a circuit breaker.

func Timeout

func Timeout(timeout time.Duration) OptionFunc

Timeout option for adjusting the timeout of the connection.

func Transport

func Transport(rt http.RoundTripper) OptionFunc

Transport option for setting the Transport for the client.

type TracedClient

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

TracedClient defines a HTTP client with tracing integrated.

func New

func New(oo ...OptionFunc) (*TracedClient, error)

New creates a new HTTP client.

func (*TracedClient) Do

func (tc *TracedClient) Do(ctx context.Context, req *http.Request) (*http.Response, error)

Do executes a HTTP request with integrated tracing and tracing propagation downstream.