httpstats

package module
v0.0.0-...-fb3244f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 5, 2022 License: MIT Imports: 6 Imported by: 0

README

httpstats

Go Reference Go Report Card

import "github.com/thiagonache/httpstats"

The idea of this package is to provide an easy way to collect detailed HTTP metrics from the client. It exports a function that injects hooks using HTTPTrace Package. If you want a better understand about how HTTPTrace works read my blog post.

You just need to instantiate a new object and call the wrapper function of the http module. For instance, to create a new request instead of using http.NewRequest you should use newStatsObject.NewRequest.

Example

Usual http call code

c := &http.Client{}
req, err := http.NewRequest(http.MethodGet, "https://httpbin.org/get", nil)
if err != nil {
    log.Fatal(err)
}
res, err := c.Do(req)
if err != nil {
    log.Fatal(err)
}
body, err := io.ReadAll(res.Body)
if err != nil {
    log.Fatal(err)
}
fmt.Println(string(body))

Output

{
  "args": {},
  "headers": {
    "Accept-Encoding": "gzip",
    "Host": "httpbin.org",
    "User-Agent": "Go-http-client/2.0",
    "X-Amzn-Trace-Id": "Root=1-62bdfa65-252f4f6244194d1257217609"
  },
  "origin": "201.95.218.50",
  "url": "https://httpbin.org/get"
}

Using this package to get detailed metrics.

s := httpstats.New()
c := &http.Client{}
req, err := s.NewRequest(http.MethodGet, "https://httpbin.org/get", nil)
...
fmt.Println("DNS:", s.DNS[0])
fmt.Println("Connect:", s.Connect[0])

Output

{
  "args": {},
  "headers": {
    "Accept-Encoding": "gzip",
    "Host": "httpbin.org",
    "User-Agent": "Go-http-client/2.0",
    "X-Amzn-Trace-Id": "Root=1-62bdfaef-6a1f4a8533030f0f78dbb4e6"
  },
  "origin": "201.95.218.50",
  "url": "https://httpbin.org/get"
}

DNS: 9.454983ms
Connect: 147.036392ms

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Stats

type Stats struct {
	Connect      []time.Duration
	ConnectStart time.Time
	DNS          []time.Duration
	DNSStart     time.Time
	Send         []time.Duration
	SendStart    time.Time
	TLS          []time.Duration
	TLSStart     time.Time
	Wait         []time.Duration
	WaitStart    time.Time
	// contains filtered or unexported fields
}

func New

func New() *Stats

func (*Stats) NewRequest

func (s *Stats) NewRequest(method, url string, body io.Reader) (*http.Request, error)

func (*Stats) SetHTTPTrace

func (s *Stats) SetHTTPTrace(r *http.Request) *http.Request

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL