Improving Performance on the API Gzip Handler

CHANGELOG.md

@@ -12,6 +12,7 @@
 * [ENHANCEMENT] Compactor: Exposing Thanos accept-malformed-index to Cortex compactor. #5334
 * [ENHANCEMENT] Update Go version to 1.20.4. #5299
 * [ENHANCEMENT] Log: Avoid expensive log.Valuer evaluation for disallowed levels. #5297
+* [ENHANCEMENT] Improving Performance on the API Gzip Handler. #5347
 * [BUGFIX] Ruler: Validate if rule group can be safely converted back to rule group yaml from protobuf message #5265
 * [BUGFIX] Querier: Convert gRPC `ResourceExhausted` status code from store gateway to 422 limit error. #5286
 * [BUGFIX] Alertmanager: Route web-ui requests to the alertmanager distributor when sharding is enabled. #5293

go.mod

@@ -4,7 +4,6 @@ go 1.18
 
 require (
 	github.com/Masterminds/squirrel v1.5.4
-	github.com/NYTimes/gziphandler v1.1.1
 	github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137
 	github.com/alicebob/miniredis/v2 v2.30.1
 	github.com/armon/go-metrics v0.4.1

go.sum

@@ -476,7 +476,6 @@ github.com/Microsoft/hcsshim v0.9.2/go.mod h1:7pLA8lDk46WKDWlVsENo92gC0XFa8rbKfy
 github.com/Microsoft/hcsshim/test v0.0.0-20201218223536-d3e5debf77da/go.mod h1:5hlzMzRKMLyo42nCZ9oml8AdTlq/0cvIaBv6tK1RehU=
 github.com/Microsoft/hcsshim/test v0.0.0-20210227013316-43a75bb4edd3/go.mod h1:mw7qgWloBUl75W/gVH3cQszUg1+gUITj7D6NY7ywVnY=
 github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb06e3pkSAbeQ52E9H9iFoQsEEwGN64994WTCIhntQ=
-github.com/NYTimes/gziphandler v1.1.1 h1:ZUDjpQae29j0ryrS0u/B8HZfJBtBQHjqw2rQ2cqUQ3I=
 github.com/NYTimes/gziphandler v1.1.1/go.mod h1:n/CVRwUEOgIxrgPvAQhUUr9oeUtvrhMomdKFjzJNB0c=
 github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU=
 github.com/OneOfOne/xxhash v1.2.6 h1:U68crOE3y3MPttCMQGywZOLrTeF5HHJ3/vDBCJn9/bA=

pkg/api/api.go

@@ -7,10 +7,10 @@ import (
 	"path"
 	"strings"
 
-	"github.com/NYTimes/gziphandler"
 	"github.com/felixge/fgprof"
 	"github.com/go-kit/log"
 	"github.com/go-kit/log/level"
+	"github.com/klauspost/compress/gzhttp"
 	"github.com/prometheus/prometheus/storage"
 	"github.com/weaveworks/common/middleware"
 	"github.com/weaveworks/common/server"
@@ -145,7 +145,7 @@ func (a *API) RegisterRoute(path string, handler http.Handler, auth bool, method
 	}
 
 	if a.cfg.ResponseCompression {
-		handler = gziphandler.GzipHandler(handler)
+		handler = gzhttp.GzipHandler(handler)
 	}
 	if a.HTTPHeaderMiddleware != nil {
 		handler = a.HTTPHeaderMiddleware.Wrap(handler)
@@ -165,7 +165,7 @@ func (a *API) RegisterRoutesWithPrefix(prefix string, handler http.Handler, auth
 	}
 
 	if a.cfg.ResponseCompression {
-		handler = gziphandler.GzipHandler(handler)
+		handler = gzhttp.GzipHandler(handler)
 	}
 	if a.HTTPHeaderMiddleware != nil {
 		handler = a.HTTPHeaderMiddleware.Wrap(handler)

pkg/api/api_test.go

@@ -1,13 +1,24 @@
 package api
 
 import (
+	"encoding/json"
+	"fmt"
+	"io"
+	"net/http"
 	"testing"
 
 	"github.com/gorilla/mux"
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/prometheus/model/labels"
 	"github.com/stretchr/testify/require"
 	"github.com/weaveworks/common/server"
 )
 
+const (
+	acceptEncodingHeader = "Accept-Encoding"
+	gzipEncoding         = "gzip"
+)
+
 type FakeLogger struct{}
 
 func (fl *FakeLogger) Log(keyvals ...interface{}) error {
@@ -94,3 +105,109 @@ func TestNewApiWithoutHeaderLogging(t *testing.T) {
 	require.Nil(t, api.HTTPHeaderMiddleware)
 
 }
+
+func Benchmark_Compression(b *testing.B) {
+	client := &http.Client{
+		Transport: &http.Transport{
+			DisableCompression: true,
+		},
+	}
+
+	cfg := Config{
+		ResponseCompression: true,
+	}
+
+	cases := map[string]struct {
+		enc            string
+		numberOfLabels int
+	}{
+		"gzip-10-labels": {
+			enc:            gzipEncoding,
+			numberOfLabels: 10,
+		},
+		"gzip-100-labels": {
+			enc:            gzipEncoding,
+			numberOfLabels: 100,
+		},
+		"gzip-1K-labels": {
+			enc:            gzipEncoding,
+			numberOfLabels: 1000,
+		},
+		"gzip-10K-labels": {
+			enc:            gzipEncoding,
+			numberOfLabels: 10000,
+		},
+		"gzip-100K-labels": {
+			enc:            gzipEncoding,
+			numberOfLabels: 100000,
+		},
+		"gzip-1M-labels": {
+			enc:            gzipEncoding,
+			numberOfLabels: 1000000,
+		},
+	}
+
+	for name, tc := range cases {
+		b.Run(name, func(b *testing.B) {
+			serverCfg := server.Config{
+				HTTPListenNetwork: server.DefaultNetwork,
+				HTTPListenPort:    8080,
+				Registerer:        prometheus.NewRegistry(),
+			}
+
+			server, err := server.New(serverCfg)
+			require.NoError(b, err)
+			api, err := New(cfg, serverCfg, server, &FakeLogger{})
+			require.NoError(b, err)
+
+			labels := labels.ScratchBuilder{}
+
+			for i := 0; i < tc.numberOfLabels; i++ {
+				labels.Add(fmt.Sprintf("Name%v", i), fmt.Sprintf("Value%v", i))
+			}
+
+			respBody, err := json.Marshal(labels.Labels())
+			require.NoError(b, err)
+
+			api.RegisterRoute("/foo_endpoint", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				w.WriteHeader(http.StatusOK)
+				_, err := w.Write(respBody)
+				require.NoError(b, err)
+			}), false, "GET")
+
+			go func() {
+				err := server.Run()
+				require.NoError(b, err)
+			}()
+
+			defer server.Shutdown()
+			req, _ := http.NewRequest("GET", "http://"+server.HTTPListenAddr().String()+"/foo_endpoint", nil)
+			req.Header.Set(acceptEncodingHeader, "gzip")
+
+			b.ReportAllocs()
+			b.ResetTimer()
+
+			// Reusing the array to read the body and avoid allocation on the test
+			encRespBody := make([]byte, len(respBody))
+
+			for i := 0; i < b.N; i++ {
+				resp, err := client.Do(req)
+
+				require.NoError(b, err)
+
+				require.NoError(b, err, "client get failed with unexpected error")
+
+				responseBodySize := 0
+				for {
+					n, err := resp.Body.Read(encRespBody)
+					responseBodySize += n
+					if err == io.EOF {
+						break
+					}
+				}
+
+				b.ReportMetric(float64(responseBodySize), "ContentLength")
+			}
+		})
+	}
+}