chore: add gw failure stats (#3809)

Add stats for failures at GW
rudderlabs · Sep 1, 2023 · 437b8d5 · 437b8d5
1 parent fdfb4f6
commit 437b8d5
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 30 deletions.
diff --git a/gateway/gateway_test.go b/gateway/gateway_test.go
@@ -904,7 +904,7 @@ var _ = Describe("Gateway", func() {
 								"workspaceId": "",
 								"writeKey":    "noWriteKey",
 								"reqType":     reqType,
-								"reason":      "noWriteKeyInBasicAuth",
+								"reason":      "Failed to read writeKey from header",
 								"sourceType":  "",
 								"sdkVersion":  "",
 							},
@@ -935,7 +935,7 @@ var _ = Describe("Gateway", func() {
 								"workspaceId": "",
 								"writeKey":    "noWriteKey",
 								"reqType":     reqType,
-								"reason":      "noWriteKeyInBasicAuth",
+								"reason":      "Failed to read writeKey from header",
 								"sourceType":  "",
 								"sdkVersion":  "",
 							},

diff --git a/gateway/handle_http_auth.go b/gateway/handle_http_auth.go
@@ -18,24 +18,26 @@ func (gw *Handle) writeKeyAuth(delegate http.HandlerFunc) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		reqType := r.Context().Value(gwtypes.CtxParamCallType).(string)
 		var errorMessage string
+		var arctx *gwtypes.AuthRequestContext
 		defer func() {
 			gw.handleHttpError(w, r, errorMessage)
+			gw.handleFailureStats(errorMessage, reqType, arctx)
 		}()
 		writeKey, _, ok := r.BasicAuth()
 		if !ok || writeKey == "" {
-			stat := gwstats.SourceStat{
-				Source:   "noWriteKey",
-				SourceID: "noWriteKey",
-				WriteKey: "noWriteKey",
-				ReqType:  reqType,
-			}
-			stat.RequestFailed("noWriteKeyInBasicAuth")
-			stat.Report(gw.stats)
 			errorMessage = response.NoWriteKeyInBasicAuth
 			return
 		}
-		arctx := gw.authRequestContextForWriteKey(writeKey)
+		arctx = gw.authRequestContextForWriteKey(writeKey)
 		if arctx == nil {
+			stat := gwstats.SourceStat{
+				Source:   "invalidWriteKey",
+				SourceID: "invalidWriteKey",
+				WriteKey: writeKey,
+				ReqType:  reqType,
+			}
+			stat.RequestFailed("invalidWriteKey")
+			stat.Report(gw.stats)
 			errorMessage = response.InvalidWriteKey
 			return
 		}
@@ -55,9 +57,11 @@ func (gw *Handle) writeKeyAuth(delegate http.HandlerFunc) http.HandlerFunc {
 func (gw *Handle) webhookAuth(delegate http.HandlerFunc) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		reqType := r.Context().Value(gwtypes.CtxParamCallType).(string)
+		var arctx *gwtypes.AuthRequestContext
 		var errorMessage string
 		defer func() {
 			gw.handleHttpError(w, r, errorMessage)
+			gw.handleFailureStats(errorMessage, reqType, arctx)
 		}()
 
 		var writeKey string
@@ -67,18 +71,10 @@ func (gw *Handle) webhookAuth(delegate http.HandlerFunc) http.HandlerFunc {
 			writeKey, _, _ = r.BasicAuth()
 		}
 		if writeKey == "" {
-			stat := gwstats.SourceStat{
-				Source:   "noWriteKey",
-				SourceID: "noWriteKey",
-				WriteKey: "noWriteKey",
-				ReqType:  reqType,
-			}
-			stat.RequestFailed("noWriteKeyInQueryParams")
-			stat.Report(gw.stats)
 			errorMessage = response.NoWriteKeyInQueryParams
 			return
 		}
-		arctx := gw.authRequestContextForWriteKey(writeKey)
+		arctx = gw.authRequestContextForWriteKey(writeKey)
 		if arctx == nil || arctx.SourceCategory != "webhook" {
 			errorMessage = response.InvalidWriteKey
 			return
@@ -99,23 +95,17 @@ func (gw *Handle) sourceIDAuth(delegate http.HandlerFunc) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		reqType := r.Context().Value(gwtypes.CtxParamCallType).(string)
 		var errorMessage string
+		var arctx *gwtypes.AuthRequestContext
 		defer func() {
 			gw.handleHttpError(w, r, errorMessage)
+			gw.handleFailureStats(errorMessage, reqType, arctx)
 		}()
 		sourceID := r.Header.Get("X-Rudder-Source-Id")
 		if sourceID == "" {
-			stat := gwstats.SourceStat{
-				Source:   "noSourceID",
-				SourceID: "noSourceID",
-				WriteKey: "noSourceID",
-				ReqType:  reqType,
-			}
-			stat.RequestFailed("noSourceIdInHeader")
-			stat.Report(gw.stats)
 			errorMessage = response.NoSourceIdInHeader
 			return
 		}
-		arctx := gw.authRequestContextForSourceID(sourceID)
+		arctx = gw.authRequestContextForSourceID(sourceID)
 		if arctx == nil {
 			errorMessage = response.InvalidSourceID
 			return
@@ -138,6 +128,7 @@ func (gw *Handle) replaySourceIDAuth(delegate http.HandlerFunc) http.HandlerFunc
 		s, ok := gw.sourceIDSourceMap[arctx.SourceID]
 		if !ok || !s.IsReplaySource() {
 			gw.handleHttpError(w, r, response.InvalidReplaySource)
+			gw.handleFailureStats(response.InvalidReplaySource, "replay", arctx)
 			return
 		}
 		delegate.ServeHTTP(w, r)
@@ -200,3 +191,48 @@ func (gw *Handle) handleHttpError(w http.ResponseWriter, r *http.Request, errorM
 		http.Error(w, responseBody, status)
 	}
 }
+
+func (gw *Handle) handleFailureStats(errorMessage, reqType string, arctx *gwtypes.AuthRequestContext) {
+	if errorMessage != "" {
+		var stat gwstats.SourceStat
+		switch errorMessage {
+		case response.NoWriteKeyInBasicAuth, response.NoWriteKeyInQueryParams:
+			stat = gwstats.SourceStat{
+				Source:   "noWriteKey",
+				SourceID: "noWriteKey",
+				WriteKey: "noWriteKey",
+				ReqType:  reqType,
+			}
+		case response.InvalidWriteKey:
+			stat = gwstats.SourceStat{
+				Source:   "noWriteKey",
+				SourceID: "noWriteKey",
+				WriteKey: "noWriteKey",
+				ReqType:  reqType,
+			}
+		case response.InvalidSourceID:
+			stat = gwstats.SourceStat{
+				SourceID: "InvalidSourceId",
+				WriteKey: "InvalidSourceId",
+				ReqType:  reqType,
+				Source:   "InvalidSourceId",
+			}
+		case response.NoSourceIdInHeader:
+			stat = gwstats.SourceStat{
+				SourceID: "noSourceIDInHeader",
+				WriteKey: "noSourceIDInHeader",
+				ReqType:  reqType,
+				Source:   "noSourceIDInHeader",
+			}
+		case response.SourceDisabled:
+			stat = gwstats.SourceStat{
+				SourceID: arctx.SourceID,
+				WriteKey: arctx.WriteKey,
+				ReqType:  reqType,
+				Source:   arctx.SourceTag(),
+			}
+		}
+		stat.RequestFailed(response.GetStatus(errorMessage))
+		stat.Report(gw.stats)
+	}
+}
diff --git a/gateway/handle_http_beacon.go b/gateway/handle_http_beacon.go
@@ -3,6 +3,7 @@ package gateway
 import (
 	"net/http"
 
+	gwstats "github.com/rudderlabs/rudder-server/gateway/internal/stats"
 	"github.com/rudderlabs/rudder-server/gateway/response"
 	"github.com/rudderlabs/rudder-server/utils/misc"
 )
@@ -25,6 +26,14 @@ func (gw *Handle) beaconInterceptor(delegate http.HandlerFunc) http.HandlerFunc
 		} else {
 			status := http.StatusUnauthorized
 			responseBody := response.NoWriteKeyInQueryParams
+			stat := gwstats.SourceStat{
+				Source:   "invalidWriteKey",
+				SourceID: "invalidWriteKey",
+				WriteKey: "invalidWriteKey",
+				ReqType:  "beacon",
+			}
+			stat.RequestFailed("invalidWriteKey")
+			stat.Report(gw.stats)
 			gw.logger.Infow("response",
 				"ip", misc.GetIPFromReq(r),
 				"path", r.URL.Path,

diff --git a/gateway/handle_http_pixel.go b/gateway/handle_http_pixel.go
@@ -10,6 +10,8 @@ import (
 
 	"github.com/tidwall/sjson"
 
+	gwstats "github.com/rudderlabs/rudder-server/gateway/internal/stats"
+
 	"github.com/rudderlabs/rudder-server/gateway/response"
 	"github.com/rudderlabs/rudder-server/utils/misc"
 )
@@ -67,6 +69,14 @@ func (gw *Handle) pixelInterceptor(reqType string, next http.HandlerFunc) http.H
 				}
 			}
 		} else {
+			stat := gwstats.SourceStat{
+				Source:   "NoWriteKeyInQueryParams",
+				SourceID: "NoWriteKeyInQueryParams",
+				WriteKey: "NoWriteKeyInQueryParams",
+				ReqType:  reqType,
+			}
+			stat.RequestFailed("NoWriteKeyInQueryParams")
+			stat.Report(gw.stats)
 			gw.logger.Infow("Error while handling request",
 				"ip", misc.GetIPFromReq(r),
 				"path", r.URL.Path,

diff --git a/gateway/internal/stats/stats.go b/gateway/internal/stats/stats.go
@@ -97,7 +97,6 @@ func (ss *SourceStat) Report(s stats.Stats) {
 	if ss.reason != "" {
 		failedTags["reason"] = ss.reason
 	}
-
 	s.NewTaggedStat("gateway.write_key_requests", stats.CountType, tags).Count(ss.requests.total)
 	s.NewTaggedStat("gateway.write_key_successful_requests", stats.CountType, tags).Count(ss.requests.succeeded)
 	s.NewTaggedStat("gateway.write_key_failed_requests", stats.CountType, failedTags).Count(ss.requests.failed)