httpclient

Documentation

Overview

Package httpclient provides utilities for collect http metrics context into the outbound request headers.

Index

• type Transport
  • func NewTransport(base http.RoundTripper) *Transport
  • func (t *Transport) RoundTrip(r *http.Request) (*http.Response, error)

Types

type Transport

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

Transport implements the http.RoundTripper interface and wraps outbound HTTP(S) requests with a meter.

func NewTransport

func NewTransport(base http.RoundTripper) *Transport

NewTransport wraps the provided http.RoundTripper with one that and includes http metrics context into the outbound request headers.

If the provided http.RoundTripper is nil, http.DefaultTransport will be used as the base http.RoundTripper. It allows for collecting metrics, specifically measuring outbound request durations in seconds, for HTTP client requests made using the wrapped RoundTripper.

base: The base http.RoundTripper to be wrapped. If nil, http.DefaultTransport
      is used as the default base RoundTripper.

func (*Transport) RoundTrip

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

RoundTrip creates a Span and propagates its context via the provided request's headers before handing the request to the configured base RoundTripper. The created span will end when the response body is closed or when a read from the body returns io.EOF.