client

Documentation

Overview

Package client make easy to use an http client

Index

• Constants
• func NewHTTPClient(tracer telemetry.Tracer, opts ...func(*http.Client)) *http.Client
• func WithLogger(c *http.Client, log log.Logger, acceptedStatusCode []string)
• type Config
  • func (c Config) SetTimeout(client *http.Client)
• type HeaderTripper
  • func NewLogTripper(parent http.RoundTripper, log log.Logger, acceptedStatusCodes []string) *HeaderTripper
  • func (rt *HeaderTripper) RoundTrip(r *http.Request) (*http.Response, error)

Constants

const PrefixHTTP = "HTTP_"

PrefixHTTP is the env prefix of Config environment variables.

Functions

func NewHTTPClient

func NewHTTPClient(tracer telemetry.Tracer, opts ...func(*http.Client)) *http.Client

NewHTTPClient crate a new *http.Client with Config fields set. If parent is present only config fields are changed.

func WithLogger

func WithLogger(c *http.Client, log log.Logger, acceptedStatusCode []string)

WithLogger wrap http client transport with log. If response code does not match any acceptedStatusCode, response body is logged.

Types

type Config

type Config struct {
	Timeout                time.Duration `env:"TIMEOUT,required"`
	RoundtripperStatusCode []string      `env:"ROUNDTRIPPER_STATUSCODE,default=2.."`
}

Config of the http client.

func (Config) SetTimeout

func (c Config) SetTimeout(client *http.Client)

SetTimeout set request timeout.

type HeaderTripper

type HeaderTripper struct {
	http.RoundTripper
	// contains filtered or unexported fields
}

HeaderTripper wrap http.RoundTripper to enrich with log. This way all outgoing requests (even bodies) will be logged.

func NewLogTripper

func NewLogTripper(parent http.RoundTripper, log log.Logger, acceptedStatusCodes []string) *HeaderTripper

NewLogTripper creates a new HeaderTripper using parent http.RoundTripper with log logger and will log responses bodies if no acceptedSatusCodes match (regex are accepted).

func (*HeaderTripper) RoundTrip

func (rt *HeaderTripper) RoundTrip(r *http.Request) (*http.Response, error)

RoundTrip refer to http.RoundTripper.