httputil

Documentation

Index

• func AssertStatusCode(r *http.Response, statusCode int) error
• func InstrumentHandler(handler http.Handler) http.Handler
• func ResolveRequestURL(r *http.Request) (*url.URL, error)
• func SpanFromRequest(r *http.Request) (context.Context, trace.Span)
• type AuthHandler
• type AuthHandlerFunc
  • func (f AuthHandlerFunc) HandleAuth(r *http.Request) error
• type AuthMux
  • func NewAuthMux() *AuthMux
  • func (a *AuthMux) Copy(other *AuthMux)
  • func (a *AuthMux) Handle(pattern string, handler AuthHandler)
  • func (a *AuthMux) HandleAuth(r *http.Request) error
  • func (a *AuthMux) HandleFunc(pattern string, handler func(*http.Request) error)
  • func (a *AuthMux) SetHeader(key string, value string)
• type BasicAuthHandler
  • func (h BasicAuthHandler) HandleAuth(r *http.Request) error
• type BearerToken
  • func (t BearerToken) HandleAuth(r *http.Request) error
• type Client
  • func NewClient(cache cache.Cache, maxAge time.Duration) *Client
  • func (c *Client) CacheKey(req *http.Request) string
  • func (c *Client) Collect(ch chan<- prometheus.Metric)
  • func (c *Client) Describe(descs chan<- *prometheus.Desc)
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) DoCached(req *http.Request) (*http.Response, error)
• type Error
  • func (e Error) Error() string
• type Link
  • func ParseLinkHeader(origin *url.URL, header string) ([]Link, error)
• type StatusRecorder
  • func (s *StatusRecorder) Flush()
  • func (s *StatusRecorder) Header() http.Header
  • func (s *StatusRecorder) StatusCode() int
  • func (s *StatusRecorder) Write(b []byte) (int, error)
  • func (s *StatusRecorder) WriteHeader(statusCode int)

Functions

func AssertStatusCode

func AssertStatusCode(r *http.Response, statusCode int) error

AssertStatusCode returns an error if the response does not match the given status code.

func InstrumentHandler

func InstrumentHandler(handler http.Handler) http.Handler

InstrumentHandler instruments a http.Handler. Instrumented handlers are required to set the http.route attribute to the span if available.

If CORS is in use, it's the wrapped handler's responsibility to allow the traceresponse header.

SEE: https://opentelemetry.io/docs/specs/semconv/http/http-spans/#http-server-semantic-conventions

func ResolveRequestURL

func ResolveRequestURL(r *http.Request) (*url.URL, error)

func SpanFromRequest

func SpanFromRequest(r *http.Request) (context.Context, trace.Span)

SpanFromRequest returns the current span for a handler instrumented using InstrumentHandler. Panics if handler is not instrumented. A span received this way MUST NOT be manually closed. It is closed once the instrumented handler completed the request.

Types

type AuthHandler

type AuthHandler interface {
	HandleAuth(*http.Request) error
}

type AuthHandlerFunc

type AuthHandlerFunc func(*http.Request) error

func (AuthHandlerFunc) HandleAuth

func (f AuthHandlerFunc) HandleAuth(r *http.Request) error

type AuthMux

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

func NewAuthMux

func NewAuthMux() *AuthMux

func (*AuthMux) Copy

func (a *AuthMux) Copy(other *AuthMux)

func (*AuthMux) Handle

func (a *AuthMux) Handle(pattern string, handler AuthHandler)

func (*AuthMux) HandleAuth

func (a *AuthMux) HandleAuth(r *http.Request) error

func (*AuthMux) HandleFunc

func (a *AuthMux) HandleFunc(pattern string, handler func(*http.Request) error)

func (*AuthMux) SetHeader

func (a *AuthMux) SetHeader(key string, value string)

type BasicAuthHandler

type BasicAuthHandler struct {
	Username string
	Password string
}

func (BasicAuthHandler) HandleAuth

func (h BasicAuthHandler) HandleAuth(r *http.Request) error

type BearerToken

type BearerToken string

func (BearerToken) HandleAuth

func (t BearerToken) HandleAuth(r *http.Request) error

type Client

type Client struct {
	http.Client

	UserAgent string
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cache cache.Cache, maxAge time.Duration) *Client

func (*Client) CacheKey

func (c *Client) CacheKey(req *http.Request) string

func (*Client) Collect

func (c *Client) Collect(ch chan<- prometheus.Metric)

Collect implements prometheus.Collector.

func (*Client) Describe

func (c *Client) Describe(descs chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

func (*Client) Do

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

See http.Client.Do.

func (*Client) DoCached

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

DoCached returns a cached response for the request. If no cache entry exists, http.Client.Do is used. If the request succeeds, its response is cached if the response code is 2xx. It is the caller's responsibility to ensure that caching the request is sensible (i.e. only for GET requests). NOTE: Cached responses for URLs that were redirected will not have the correct request URL for the response - it will be the original request rather than the request to the final resource.

type Error

type Error struct {
	Status     string
	StatusCode int
}

func (Error) Error

func (e Error) Error() string

type Link

type Link struct {
	URL    *url.URL
	Params map[string]string
}

func ParseLinkHeader

func ParseLinkHeader(origin *url.URL, header string) ([]Link, error)

ParseLinkHeader parses a Link header.

SEE: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link.

type StatusRecorder

type StatusRecorder struct {
	Writer http.ResponseWriter
	// contains filtered or unexported fields
}

func (*StatusRecorder) Flush

func (s *StatusRecorder) Flush()

Flush implements http.Flusher.

func (*StatusRecorder) Header

func (s *StatusRecorder) Header() http.Header

Header implements http.ResponseWriter.

func (*StatusRecorder) StatusCode

func (s *StatusRecorder) StatusCode() int

func (*StatusRecorder) Write

func (s *StatusRecorder) Write(b []byte) (int, error)

Write implements http.ResponseWriter.

func (*StatusRecorder) WriteHeader

func (s *StatusRecorder) WriteHeader(statusCode int)

WriteHeader implements http.ResponseWriter.