clihttp

Documentation

Overview

Package clihttp adds opentracing support to http client.

Example

client := NewClient(opentracing.GlobalTracer())
req, _ := http.NewRequest("GET", "https://example.com/", nil)
resp, _ := client.Do(req)
resp.Body.Close()

Index

• type Client
  • func NewClient(tracer opentracing.Tracer, options ...Option) *Client
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
• type HttpDoer
• type Option
  • func WithDoer(doer contract.HttpDoer) Option
  • func WithRequestLogThreshold(num int) Option
  • func WithResponseLogThreshold(num int) Option

Examples

• Package

Types

type Client

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

Client is a http client that traces http requests.

func NewClient

func NewClient(tracer opentracing.Tracer, options ...Option) *Client

NewClient creates a Client with tracing support.

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

Do sends the request.

type HttpDoer

type HttpDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

HttpDoer modules a upstream http client.

type Option

type Option func(*Client)

Option changes the behavior of Client.

func WithDoer

func WithDoer(doer contract.HttpDoer) Option

WithDoer is an option that accepts a HttpDoer as the underlying client.

func WithRequestLogThreshold

func WithRequestLogThreshold(num int) Option

WithRequestLogThreshold is options that sets threshold of request logging in number of bytes. If the payload is larger than this threshold, the log will be omit.

func WithResponseLogThreshold

func WithResponseLogThreshold(num int) Option

WithResponseLogThreshold is options that sets threshold of response logging in number of bytes. If the response body is larger than this threshold, the log will be omit.