Add request id to store gateway logger (#5958)

Author: yeya24

CHANGELOG.md

@@ -9,6 +9,7 @@
 * [ENHANCEMENT] Distributor/Ring: Allow disabling detailed ring metrics by ring member. #5931
 * [ENHANCEMENT] KV: Etcd Added etcd.ping-without-stream-allowed parameter to disable/enable  PermitWithoutStream #5933
 * [ENHANCEMENT] Ingester: Add a new `max_series_per_label_set` limit. This limit functions similarly to `max_series_per_metric`, but allowing users to define the maximum number of series per LabelSet. #5950
+* [ENHANCEMENT] Store Gateway: Log gRPC requests together with headers configured in `http_request_headers_to_log`. #5958
 * [CHANGE] Upgrade Dockerfile Node version from 14x to 18x. #5906
 * [CHANGE] Query Frontend/Ruler: Omit empty data field in API response. #5953 #5954
 * [BUGFIX] Configsdb: Fix endline issue in db password. #5920

go.mod

@@ -53,7 +53,7 @@ require (
 	github.com/stretchr/testify v1.9.0
 	github.com/thanos-io/objstore v0.0.0-20240309075357-e8336a5fd5f3
 	github.com/thanos-io/promql-engine v0.0.0-20240405095051-b7d0da367508
-	github.com/thanos-io/thanos v0.34.2-0.20240501161908-1e745af6720c
+	github.com/thanos-io/thanos v0.35.1-0.20240517203736-9e6cbd9fdd9d
 	github.com/uber/jaeger-client-go v2.30.0+incompatible
 	github.com/weaveworks/common v0.0.0-20230728070032-dd9e68f319d5
 	go.etcd.io/etcd/api/v3 v3.5.13

go.sum

@@ -1421,8 +1421,8 @@ github.com/thanos-io/objstore v0.0.0-20240309075357-e8336a5fd5f3 h1:Q0BjHI7FMe5K
 github.com/thanos-io/objstore v0.0.0-20240309075357-e8336a5fd5f3/go.mod h1:ptMYNPgbyAR7a2Ab2t7zHA2/0be2ePyawVR7lp7fZtg=
 github.com/thanos-io/promql-engine v0.0.0-20240405095051-b7d0da367508 h1:4X0ThYb7/wTTKS73wT13ixw0lj5OJ87g45RWIZhPZDA=
 github.com/thanos-io/promql-engine v0.0.0-20240405095051-b7d0da367508/go.mod h1:FEPnabuTql1bDA4OUM41mwcZOJ20R436k8vq+xtGEG0=
-github.com/thanos-io/thanos v0.34.2-0.20240501161908-1e745af6720c h1:clWAhj5L7+Dnw/apO874hUaVxDRHfkm9If4Qv/6CbIo=
-github.com/thanos-io/thanos v0.34.2-0.20240501161908-1e745af6720c/go.mod h1:WHGZyM/qwp857mJr8Q0d7K6eQoLtLv+6p7RNpT/yeIE=
+github.com/thanos-io/thanos v0.35.1-0.20240517203736-9e6cbd9fdd9d h1:Uomb1Yvuz1HDCJL6s0rTiHpaJpHvr8NRarO5TprM7Cs=
+github.com/thanos-io/thanos v0.35.1-0.20240517203736-9e6cbd9fdd9d/go.mod h1:mwjTxpNgULRgeOr5qWmM2IKiyu4SNh/1JypUyPtlrQA=
 github.com/tv42/httpunix v0.0.0-20150427012821-b75d8614f926/go.mod h1:9ESjWnEqriFuLhtthL60Sar/7RFoluCcXsuvEwTV5KM=
 github.com/uber/jaeger-client-go v2.28.0+incompatible/go.mod h1:WVhlPFC8FDjOFMMWRy2pZqQJSXxYSwNYOkTr/Z6d3Kk=
 github.com/uber/jaeger-client-go v2.30.0+incompatible h1:D6wyKGCecFaSRUpo8lCVbaOOb6ThwMmTEbhRwtKR97o=

pkg/storegateway/bucket_stores.go

@@ -583,6 +583,9 @@ func (u *BucketStores) getOrCreateStore(userID string) (*store.BucketStore, erro
 	bucketStoreReg := prometheus.NewRegistry()
 	bucketStoreOpts := []store.BucketStoreOption{
 		store.WithLogger(userLogger),
+		store.WithRequestLoggerFunc(func(ctx context.Context, logger log.Logger) log.Logger {
+			return util_log.HeadersFromContext(ctx, logger)
+		}),
 		store.WithRegistry(bucketStoreReg),
 		store.WithIndexCache(u.indexCache),
 		store.WithQueryGate(u.queryGate),

pkg/util/log/wrappers.go

@@ -33,7 +33,7 @@ func WithTraceID(traceID string, l log.Logger) log.Logger {
 //	log := util.WithContext(ctx)
 //	log.Errorf("Could not chunk chunks: %v", err)
 func WithContext(ctx context.Context, l log.Logger) log.Logger {
-	l = headersFromContext(ctx, l)
+	l = HeadersFromContext(ctx, l)
 
 	// Weaveworks uses "orgs" and "orgID" to represent Cortex users,
 	// even though the code-base generally uses `userID` to refer to the same thing.
@@ -57,7 +57,7 @@ func WithSourceIPs(sourceIPs string, l log.Logger) log.Logger {
 }
 
 // HeadersFromContext enables the logging of specified HTTP Headers that have been added to a context
-func headersFromContext(ctx context.Context, l log.Logger) log.Logger {
+func HeadersFromContext(ctx context.Context, l log.Logger) log.Logger {
 	headerContentsMap := HeaderMapFromContext(ctx)
 	for header, contents := range headerContentsMap {
 		l = log.With(l, header, contents)