httputil

Documentation

Index

• Constants
• Variables
• func DefaultLoggingMiddleware(requestIDHeaderName string, fields logging.Fields, middlewareLogLevel string) func(next http.Handler) http.Handler
• func ETag(checksum string) string
• func GetRequestLakeFSClient(r *http.Request) string
• func HeaderTimestamp(ts time.Time) string
• func HostMatches(r *http.Request, hosts []string) bool
• func HostOnly(hostname string) string
• func HostSubdomainOf(r *http.Request, hosts []string) bool
• func HostsOnly(hostname []string) []string
• func IsRequestCanceled(r *http.Request) bool
• func IsSuccessStatusCode(response *http.Response) bool
• func LoggingMiddleware(requestIDHeaderName string, fields logging.Fields, ...) func(next http.Handler) http.Handler
• func RequestID(r *http.Request) (*http.Request, string)
• func RequestScheme(r *http.Request) string
• func ServeHealth() http.Handler
• func ServePPROF(pprofPrefix string) http.Handler
• func SetHealthHandlerInfo(info string)
• func SourceIP(r *http.Request) string
• func StripQuotesAndSpaces(etag string) string
• func TracingMiddleware(requestIDHeaderName string, fields logging.Fields, traceRequestHeaders bool) func(http.Handler) http.Handler
• type CappedBuffer
  • func (c *CappedBuffer) Write(p []byte) (n int, err error)
• type MetricResponseWriter
  • func NewMetricResponseWriter(w http.ResponseWriter) *MetricResponseWriter
  • func (mrw *MetricResponseWriter) WriteHeader(code int)
• type Range
  • func ParseRange(spec string, length int64) (Range, error)
  • func (r Range) Size() int64
  • func (r Range) String() string
• type ResponseRecordingWriter
  • func (w *ResponseRecordingWriter) Header() http.Header
  • func (w *ResponseRecordingWriter) Write(data []byte) (int, error)
  • func (w *ResponseRecordingWriter) WriteHeader(statusCode int)

Constants

const (
	RequestIDContextKey contextKey = "request_id"
	AuditLogEndMessage  string     = "HTTP call ended"
)

const (
	MaxBodyBytes                      = 750               // Log lines will be < 2KiB
	RequestTracingMaxRequestBodySize  = 1024 * 1024 * 50  // 50KB
	RequestTracingMaxResponseBodySize = 1024 * 1024 * 150 // 150KB
)

const (
	// DateHeaderTimestampFormat - Last-Modified: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
	DateHeaderTimestampFormat = "Mon, 02 Jan 2006 15:04:05 GMT"
)

const (
	RequestIDHeaderName = "X-Request-ID"
)

Variables

var ErrBadRange = errors.New("invalid range")

var ErrUnsatisfiableRange = errors.New("unsatisfiable range")

Functions

func DefaultLoggingMiddleware

func DefaultLoggingMiddleware(requestIDHeaderName string, fields logging.Fields, middlewareLogLevel string) func(next http.Handler) http.Handler

func ETag

func ETag(checksum string) string

func GetRequestLakeFSClient

func GetRequestLakeFSClient(r *http.Request) string

GetRequestLakeFSClient get lakeFS client identifier from request.

It extracts the data from X-Lakefs-Client header and fallback to the user-agent

func HeaderTimestamp

func HeaderTimestamp(ts time.Time) string

func HostMatches

func HostMatches(r *http.Request, hosts []string) bool

func HostOnly

func HostOnly(hostname string) string

func HostSubdomainOf

func HostSubdomainOf(r *http.Request, hosts []string) bool

func HostsOnly

func HostsOnly(hostname []string) []string

func IsRequestCanceled

func IsRequestCanceled(r *http.Request) bool

func IsSuccessStatusCode

func IsSuccessStatusCode(response *http.Response) bool

IsSuccessStatusCode returns true for status code 2xx

func LoggingMiddleware

func LoggingMiddleware(requestIDHeaderName string, fields logging.Fields, loggingMiddlewareLevel string, traceRequestHeaders bool) func(next http.Handler) http.Handler

func RequestID

func RequestID(r *http.Request) (*http.Request, string)

func RequestScheme

func RequestScheme(r *http.Request) string

func ServeHealth

func ServeHealth() http.Handler

func ServePPROF

func ServePPROF(pprofPrefix string) http.Handler

func SetHealthHandlerInfo

func SetHealthHandlerInfo(info string)

func SourceIP

func SourceIP(r *http.Request) string

func StripQuotesAndSpaces

func StripQuotesAndSpaces(etag string) string

func TracingMiddleware

func TracingMiddleware(requestIDHeaderName string, fields logging.Fields, traceRequestHeaders bool) func(http.Handler) http.Handler

Types

type CappedBuffer

type CappedBuffer struct {
	SizeBytes int

	Buffer []byte
	// contains filtered or unexported fields
}

func (*CappedBuffer) Write

func (c *CappedBuffer) Write(p []byte) (n int, err error)

type MetricResponseWriter

type MetricResponseWriter struct {
	http.ResponseWriter
	StatusCode int
}

func NewMetricResponseWriter

func NewMetricResponseWriter(w http.ResponseWriter) *MetricResponseWriter

func (*MetricResponseWriter) WriteHeader

func (mrw *MetricResponseWriter) WriteHeader(code int)

type Range

type Range struct {
	StartOffset int64
	EndOffset   int64
}

Range represents an RFC 2616 HTTP Range

func ParseRange

func ParseRange(spec string, length int64) (Range, error)

ParseRange parses an HTTP RFC 2616 Range header value and returns an Range object for the given object length

func (Range) Size

func (r Range) Size() int64

func (Range) String

func (r Range) String() string

type ResponseRecordingWriter

type ResponseRecordingWriter struct {
	StatusCode   int
	ResponseSize int64
	Writer       http.ResponseWriter
}

func (*ResponseRecordingWriter) Header

func (w *ResponseRecordingWriter) Header() http.Header

func (*ResponseRecordingWriter) Write

func (w *ResponseRecordingWriter) Write(data []byte) (int, error)

func (*ResponseRecordingWriter) WriteHeader

func (w *ResponseRecordingWriter) WriteHeader(statusCode int)