2019-05-22 23:16:55 +02:00
package httpserver
import (
"bufio"
"context"
"crypto/tls"
"flag"
"fmt"
"io"
"net"
"net/http"
"net/http/pprof"
"runtime"
"strconv"
"strings"
"sync"
"time"
"github.com/VictoriaMetrics/VictoriaMetrics/lib/logger"
"github.com/VictoriaMetrics/VictoriaMetrics/lib/netutil"
"github.com/VictoriaMetrics/metrics"
2020-01-17 22:57:18 +01:00
"github.com/klauspost/compress/gzip"
2019-05-22 23:16:55 +02:00
)
var (
2020-02-04 14:46:13 +01:00
tlsEnable = flag . Bool ( "tls" , false , "Whether to enable TLS (aka HTTPS) for incoming requests. -tlsCertFile and -tlsKeyFile must be set if -tls is set" )
tlsCertFile = flag . String ( "tlsCertFile" , "" , "Path to file with TLS certificate. Used only if -tls is set. Prefer ECDSA certs instead of RSA certs, since RSA certs are slow" )
tlsKeyFile = flag . String ( "tlsKeyFile" , "" , "Path to file with TLS key. Used only if -tls is set" )
2019-05-22 23:16:55 +02:00
httpAuthUsername = flag . String ( "httpAuth.username" , "" , "Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password" )
2019-11-21 20:54:17 +01:00
httpAuthPassword = flag . String ( "httpAuth.password" , "" , "Password for HTTP Basic Auth. The authentication is disabled if -httpAuth.username is empty" )
2019-05-22 23:16:55 +02:00
metricsAuthKey = flag . String ( "metricsAuthKey" , "" , "Auth key for /metrics. It overrides httpAuth settings" )
pprofAuthKey = flag . String ( "pprofAuthKey" , "" , "Auth key for /debug/pprof. It overrides httpAuth settings" )
2019-05-24 11:18:40 +02:00
2020-03-27 19:08:42 +01:00
disableResponseCompression = flag . Bool ( "http.disableResponseCompression" , false , "Disable compression of HTTP responses for saving CPU resources. By default compression is enabled to save network bandwidth" )
maxGracefulShutdownDuration = flag . Duration ( "http.maxGracefulShutdownDuration" , 7 * time . Second , "The maximum duration for graceful shutdown of HTTP server. " +
"Highly loaded server may require increased value for graceful shutdown" )
2019-05-22 23:16:55 +02:00
)
var (
servers = make ( map [ string ] * http . Server )
serversLock sync . Mutex
)
// RequestHandler must serve the given request r and write response to w.
//
// RequestHandler must return true if the request has been served (successfully or not).
//
// RequestHandler must return false if it cannot serve the given request.
// In such cases the caller must serve the request.
type RequestHandler func ( w http . ResponseWriter , r * http . Request ) bool
// Serve starts an http server on the given addr with the given rh.
//
// By default all the responses are transparently compressed, since Google
// charges a lot for the egress traffic. The compression may be disabled
// by calling DisableResponseCompression before writing the first byte to w.
2019-05-24 11:18:40 +02:00
//
// The compression is also disabled if -http.disableResponseCompression flag is set.
2019-05-22 23:16:55 +02:00
func Serve ( addr string , rh RequestHandler ) {
scheme := "http"
if * tlsEnable {
scheme = "https"
}
logger . Infof ( "starting http server at %s://%s/" , scheme , addr )
logger . Infof ( "pprof handlers are exposed at %s://%s/debug/pprof/" , scheme , addr )
lnTmp , err := netutil . NewTCPListener ( scheme , addr )
if err != nil {
logger . Fatalf ( "cannot start http server at %s: %s" , addr , err )
}
setNetworkTimeouts ( lnTmp )
ln := net . Listener ( lnTmp )
if * tlsEnable {
cert , err := tls . LoadX509KeyPair ( * tlsCertFile , * tlsKeyFile )
if err != nil {
logger . Fatalf ( "cannot load TLS cert from tlsCertFile=%q, tlsKeyFile=%q: %s" , * tlsCertFile , * tlsKeyFile , err )
}
cfg := & tls . Config {
Certificates : [ ] tls . Certificate { cert } ,
}
ln = tls . NewListener ( ln , cfg )
}
serveWithListener ( addr , ln , rh )
}
func setNetworkTimeouts ( ln * netutil . TCPListener ) {
// Set network-level read and write timeouts to reasonable values
// in order to protect from DoS or broken networks.
// Application-level timeouts must be set by the authors of request handlers.
//
// The read timeout limits the life of idle connection
ln . ReadTimeout = time . Minute
ln . WriteTimeout = time . Minute
}
func serveWithListener ( addr string , ln net . Listener , rh RequestHandler ) {
s := & http . Server {
Handler : gzipHandler ( rh ) ,
// Disable http/2
TLSNextProto : make ( map [ string ] func ( * http . Server , * tls . Conn , http . Handler ) ) ,
// Do not set ReadTimeout and WriteTimeout here.
// Network-level timeouts are set in setNetworkTimeouts.
// Application-level timeouts must be set in the app.
// Do not set IdleTimeout, since it is equivalent to read timeout
// set in setNetworkTimeouts.
ErrorLog : logger . StdErrorLogger ( ) ,
}
serversLock . Lock ( )
servers [ addr ] = s
serversLock . Unlock ( )
if err := s . Serve ( ln ) ; err != nil {
if err == http . ErrServerClosed {
// The server gracefully closed.
return
}
logger . Panicf ( "FATAL: cannot serve http at %s: %s" , addr , err )
}
}
// Stop stops the http server on the given addr, which has been started
// via Serve func.
func Stop ( addr string ) error {
serversLock . Lock ( )
s := servers [ addr ]
delete ( servers , addr )
serversLock . Unlock ( )
if s == nil {
logger . Panicf ( "BUG: there is no http server at %q" , addr )
}
2020-03-27 19:08:42 +01:00
ctx , cancelFunc := context . WithTimeout ( context . Background ( ) , * maxGracefulShutdownDuration )
2019-05-22 23:16:55 +02:00
defer cancelFunc ( )
if err := s . Shutdown ( ctx ) ; err != nil {
2020-03-27 19:08:42 +01:00
return fmt . Errorf ( "cannot gracefully shutdown http server at %q in %.3fs: %s" , addr , maxGracefulShutdownDuration . Seconds ( ) , err )
2019-05-22 23:16:55 +02:00
}
return nil
}
func gzipHandler ( rh RequestHandler ) http . HandlerFunc {
hf := func ( w http . ResponseWriter , r * http . Request ) {
w = maybeGzipResponseWriter ( w , r )
handlerWrapper ( w , r , rh )
if zrw , ok := w . ( * gzipResponseWriter ) ; ok {
if err := zrw . Close ( ) ; err != nil && ! isTrivialNetworkError ( err ) {
logger . Errorf ( "gzipResponseWriter.Close: %s" , err )
}
}
}
return http . HandlerFunc ( hf )
}
2019-11-22 23:19:44 +01:00
var metricsHandlerDuration = metrics . NewHistogram ( ` vm_http_request_duration_seconds { path="/metrics"} ` )
2019-05-22 23:16:55 +02:00
func handlerWrapper ( w http . ResponseWriter , r * http . Request , rh RequestHandler ) {
requestsTotal . Inc ( )
switch r . URL . Path {
case "/health" :
w . Header ( ) . Set ( "Content-Type" , "text/plain" )
w . Write ( [ ] byte ( "OK" ) )
return
2019-12-04 18:15:49 +01:00
case "/ping" :
// This is needed for compatibility with Influx agents.
// See https://docs.influxdata.com/influxdb/v1.7/tools/api/#ping-http-endpoint
status := http . StatusNoContent
if verbose := r . FormValue ( "verbose" ) ; verbose == "true" {
status = http . StatusOK
}
w . WriteHeader ( status )
return
2019-12-18 22:06:25 +01:00
case "/favicon.ico" :
faviconRequests . Inc ( )
w . WriteHeader ( http . StatusNoContent )
return
2019-05-22 23:16:55 +02:00
case "/metrics" :
metricsRequests . Inc ( )
2019-12-18 22:06:25 +01:00
if len ( * metricsAuthKey ) > 0 && r . FormValue ( "authKey" ) != * metricsAuthKey {
http . Error ( w , "The provided authKey doesn't match -metricsAuthKey" , http . StatusUnauthorized )
return
}
startTime := time . Now ( )
2019-05-22 23:16:55 +02:00
w . Header ( ) . Set ( "Content-Type" , "text/plain" )
2020-01-25 18:19:23 +01:00
WritePrometheusMetrics ( w )
2019-05-22 23:16:55 +02:00
metricsHandlerDuration . UpdateDuration ( startTime )
return
default :
if strings . HasPrefix ( r . URL . Path , "/debug/pprof/" ) {
pprofRequests . Inc ( )
2019-12-18 22:06:25 +01:00
if len ( * pprofAuthKey ) > 0 && r . FormValue ( "authKey" ) != * pprofAuthKey {
http . Error ( w , "The provided authKey doesn't match -pprofAuthKey" , http . StatusUnauthorized )
return
}
2019-05-22 23:16:55 +02:00
DisableResponseCompression ( w )
pprofHandler ( r . URL . Path [ len ( "/debug/pprof/" ) : ] , w , r )
return
}
2019-12-18 22:06:25 +01:00
if ! checkBasicAuth ( w , r ) {
return
}
2019-05-22 23:16:55 +02:00
if rh ( w , r ) {
return
}
Errorf ( w , "unsupported path requested: %q" , r . URL . Path )
unsupportedRequestErrors . Inc ( )
return
}
}
func checkBasicAuth ( w http . ResponseWriter , r * http . Request ) bool {
if len ( * httpAuthUsername ) == 0 {
// HTTP Basic Auth is disabled.
return true
}
username , password , ok := r . BasicAuth ( )
if ok && username == * httpAuthUsername && password == * httpAuthPassword {
return true
}
w . Header ( ) . Set ( "WWW-Authenticate" , ` Basic realm="VictoriaMetrics" ` )
http . Error ( w , "" , http . StatusUnauthorized )
return false
}
func maybeGzipResponseWriter ( w http . ResponseWriter , r * http . Request ) http . ResponseWriter {
2019-05-24 11:18:40 +02:00
if * disableResponseCompression {
return w
}
2019-05-22 23:16:55 +02:00
ae := r . Header . Get ( "Accept-Encoding" )
if ae == "" {
return w
}
ae = strings . ToLower ( ae )
n := strings . Index ( ae , "gzip" )
if n < 0 {
return w
}
h := w . Header ( )
h . Set ( "Content-Encoding" , "gzip" )
zw := getGzipWriter ( w )
bw := getBufioWriter ( zw )
zrw := & gzipResponseWriter {
ResponseWriter : w ,
zw : zw ,
bw : bw ,
}
return zrw
}
// DisableResponseCompression disables response compression on w.
//
// The function must be called before the first w.Write* call.
func DisableResponseCompression ( w http . ResponseWriter ) {
w . Header ( ) . Del ( "Content-Encoding" )
}
// EnableCORS enables https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
// on the response.
func EnableCORS ( w http . ResponseWriter , _ * http . Request ) {
w . Header ( ) . Set ( "Access-Control-Allow-Origin" , "*" )
}
func getGzipWriter ( w io . Writer ) * gzip . Writer {
v := gzipWriterPool . Get ( )
if v == nil {
zw , err := gzip . NewWriterLevel ( w , 1 )
if err != nil {
logger . Panicf ( "BUG: cannot create gzip writer: %s" , err )
}
return zw
}
zw := v . ( * gzip . Writer )
zw . Reset ( w )
return zw
}
func putGzipWriter ( zw * gzip . Writer ) {
gzipWriterPool . Put ( zw )
}
var gzipWriterPool sync . Pool
type gzipResponseWriter struct {
http . ResponseWriter
zw * gzip . Writer
bw * bufio . Writer
statusCode int
firstWriteDone bool
disableCompression bool
}
func ( zrw * gzipResponseWriter ) Write ( p [ ] byte ) ( int , error ) {
if ! zrw . firstWriteDone {
h := zrw . Header ( )
if h . Get ( "Content-Encoding" ) != "gzip" {
// The request handler disabled gzip encoding.
// Send uncompressed response body.
zrw . disableCompression = true
} else if h . Get ( "Content-Type" ) == "" {
// Disable auto-detection of content-type, since it
// is incorrectly detected after the compression.
h . Set ( "Content-Type" , "text/html" )
}
zrw . firstWriteDone = true
}
if zrw . statusCode == 0 {
zrw . WriteHeader ( http . StatusOK )
}
if zrw . disableCompression {
return zrw . ResponseWriter . Write ( p )
}
return zrw . bw . Write ( p )
}
func ( zrw * gzipResponseWriter ) WriteHeader ( statusCode int ) {
if zrw . statusCode != 0 {
return
}
if statusCode == http . StatusNoContent {
DisableResponseCompression ( zrw . ResponseWriter )
}
zrw . ResponseWriter . WriteHeader ( statusCode )
zrw . statusCode = statusCode
}
// Implements http.Flusher
func ( zrw * gzipResponseWriter ) Flush ( ) {
if err := zrw . bw . Flush ( ) ; err != nil && ! isTrivialNetworkError ( err ) {
logger . Errorf ( "gzipResponseWriter.Flush (buffer): %s" , err )
}
if err := zrw . zw . Flush ( ) ; err != nil && ! isTrivialNetworkError ( err ) {
logger . Errorf ( "gzipResponseWriter.Flush (gzip): %s" , err )
}
if fw , ok := zrw . ResponseWriter . ( http . Flusher ) ; ok {
fw . Flush ( )
}
}
func ( zrw * gzipResponseWriter ) Close ( ) error {
if ! zrw . firstWriteDone {
zrw . Header ( ) . Del ( "Content-Encoding" )
return nil
}
zrw . Flush ( )
err := zrw . zw . Close ( )
putGzipWriter ( zrw . zw )
zrw . zw = nil
putBufioWriter ( zrw . bw )
zrw . bw = nil
return err
}
func getBufioWriter ( w io . Writer ) * bufio . Writer {
v := bufioWriterPool . Get ( )
if v == nil {
return bufio . NewWriterSize ( w , 16 * 1024 )
}
bw := v . ( * bufio . Writer )
bw . Reset ( w )
return bw
}
func putBufioWriter ( bw * bufio . Writer ) {
bufioWriterPool . Put ( bw )
}
var bufioWriterPool sync . Pool
func pprofHandler ( profileName string , w http . ResponseWriter , r * http . Request ) {
// This switch has been stolen from init func at https://golang.org/src/net/http/pprof/pprof.go
switch profileName {
case "cmdline" :
pprofCmdlineRequests . Inc ( )
pprof . Cmdline ( w , r )
case "profile" :
pprofProfileRequests . Inc ( )
pprof . Profile ( w , r )
case "symbol" :
pprofSymbolRequests . Inc ( )
pprof . Symbol ( w , r )
case "trace" :
pprofTraceRequests . Inc ( )
pprof . Trace ( w , r )
case "mutex" :
pprofMutexRequests . Inc ( )
seconds , _ := strconv . Atoi ( r . FormValue ( "seconds" ) )
if seconds <= 0 {
seconds = 10
}
prev := runtime . SetMutexProfileFraction ( 10 )
time . Sleep ( time . Duration ( seconds ) * time . Second )
pprof . Index ( w , r )
runtime . SetMutexProfileFraction ( prev )
default :
pprofDefaultRequests . Inc ( )
pprof . Index ( w , r )
}
}
var (
metricsRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/metrics"} ` )
pprofRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/debug/pprof/"} ` )
pprofCmdlineRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/debug/pprof/cmdline"} ` )
pprofProfileRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/debug/pprof/profile"} ` )
pprofSymbolRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/debug/pprof/symbol"} ` )
pprofTraceRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/debug/pprof/trace"} ` )
pprofMutexRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/debug/pprof/mutex"} ` )
pprofDefaultRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/debug/pprof/default"} ` )
faviconRequests = metrics . NewCounter ( ` vm_http_requests_total { path="/favicon.ico"} ` )
unsupportedRequestErrors = metrics . NewCounter ( ` vm_http_request_errors_total { path="*", reason="unsupported"} ` )
requestsTotal = metrics . NewCounter ( ` vm_http_requests_all_total ` )
)
// Errorf writes formatted error message to w and to logger.
func Errorf ( w http . ResponseWriter , format string , args ... interface { } ) {
errStr := fmt . Sprintf ( format , args ... )
2020-01-25 19:16:47 +01:00
logger . ErrorfSkipframes ( 1 , "%s" , errStr )
2019-08-23 08:46:45 +02:00
// Extract statusCode from args
statusCode := http . StatusBadRequest
for _ , arg := range args {
if esc , ok := arg . ( * ErrorWithStatusCode ) ; ok {
statusCode = esc . StatusCode
break
}
}
http . Error ( w , errStr , statusCode )
}
// ErrorWithStatusCode is error with HTTP status code.
//
// The given StatusCode is sent to client when the error is passed to Errorf.
type ErrorWithStatusCode struct {
Err error
StatusCode int
}
// Error implements error interface.
func ( e * ErrorWithStatusCode ) Error ( ) string {
return e . Err . Error ( )
2019-05-22 23:16:55 +02:00
}
func isTrivialNetworkError ( err error ) bool {
s := err . Error ( )
if strings . Contains ( s , "broken pipe" ) || strings . Contains ( s , "reset by peer" ) {
return true
}
return false
}