added logging message, refactored logging messages into method

Author: pranavmishradatabricks

internal/cortex/frontend/transport/utils/utils.go

@@ -47,13 +47,7 @@ func (f *FailedQueryCache) updateFailedQueryCache(err error, queryExpressionNorm
 
 	// Checking if error code extracted successfully.
 	if codeExtract == nil || len(codeExtract) < 2 {
-		message := fmt.Sprintf(
-			`%s: %s, %s: %s, %s: %d, %s: %s`,
-			"msg", "String regex conversion error",
-			"normalized query", queryExpressionNormalized,
-			"query range seconds", queryExpressionRangeLength,
-			"updating cache for error", err,
-		)
+		message := createLogMessage("String to regex conversion error", queryExpressionNormalized, -1, queryExpressionRangeLength, err)
 		return false, message
 	}
 
@@ -62,25 +56,13 @@ func (f *FailedQueryCache) updateFailedQueryCache(err error, queryExpressionNorm
 
 	// Checking if error code extracted properly from string.
 	if strConvError != nil {
-		message := fmt.Sprintf(
-			`%s: %s, %s: %s, %s: %d, %s: %s`,
-			"msg", "String to int conversion error",
-			"normalized query", queryExpressionNormalized,
-			"query range seconds", queryExpressionRangeLength,
-			"updating cache for error", err,
-		)
+		message := createLogMessage("String to int conversion error", queryExpressionNormalized, -1, queryExpressionRangeLength, err)
 		return false, message
 	}
 
 	// If error should be cached, store it in cache.
 	if !isCacheableError(errCode) {
-		message := fmt.Sprintf(
-			`%s: %s, %s: %s, %s: %d, %s: %s`,
-			"msg", "Query not cached due to non-cacheable error code",
-			"normalized query", queryExpressionNormalized,
-			"query range seconds", queryExpressionRangeLength,
-			"updating cache for error", err,
-		)
+		message := createLogMessage("Query not cached due to non-cacheable error code", queryExpressionNormalized, -1, queryExpressionRangeLength, err)
 		return false, message
 	}
 
@@ -92,26 +74,16 @@ func (f *FailedQueryCache) updateFailedQueryCache(err error, queryExpressionNorm
 		lruCache.Add(queryExpressionNormalized, queryExpressionRangeLength)
 	}
 
-	message := fmt.Sprintf(
-		`%s: %s, %s: %s, %s: %d, %s: %s`,
-		"msg", "Cached a failed query",
-		"normalized query", queryExpressionNormalized,
-		"range seconds", queryExpressionRangeLength,
-		"updating cache for error", err,
-	)
+	message := createLogMessage("Cached a failed query", queryExpressionNormalized, -1, queryExpressionRangeLength, err)
 	return true, message
 }
 
 // QueryHitCache checks if the lru cache is hit and returns whether to increment counter for cache hits along with appropriate message.
 func queryHitCache(queryExpressionNormalized string, queryExpressionRangeLength int, lruCache *lru.Cache) (bool, string) {
 	if value, ok := lruCache.Get(queryExpressionNormalized); ok && value.(int) <= queryExpressionRangeLength {
-		message := fmt.Sprintf(
-			`%s: %s, %s: %s, %s: %d`, "msg", "Retrieved query from cache",
-			"normalized query", queryExpressionNormalized,
-			"range seconds", queryExpressionRangeLength)
-
+		cachedQueryRangeSeconds := value.(int)
+		message := createLogMessage("Retrieved query from cache", queryExpressionNormalized, cachedQueryRangeSeconds, queryExpressionRangeLength, nil)
 		return true, message
-
 	}
 	return false, ""
 }
@@ -143,6 +115,21 @@ func (f *FailedQueryCache) normalizeQueryString(query url.Values) string {
 	return f.regex.ReplaceAllString(query.Get("query"), " ")
 }
 
+func createLogMessage(message string, queryExpressionNormalized string, cachedQueryRangeSeconds int, queryExpressionRangeLength int, err error) string {
+	if err == nil {
+		return fmt.Sprintf(
+			`%s: %s, %s: %s, %s: %d, %s: %d`, "msg", message,
+			"cached_query", queryExpressionNormalized,
+			"cached_range_seconds", cachedQueryRangeSeconds,
+			"query_range_seconds", queryExpressionRangeLength)
+	}
+	return fmt.Sprintf(
+		`%s: %s, %s: %s, %s: %d, %s: %s`, "msg", message,
+		"cached_query", queryExpressionNormalized,
+		"query_range_seconds", queryExpressionRangeLength,
+		"cached_error", err)
+}
+
 func (f *FailedQueryCache) UpdateFailedQueryCache(err error, query url.Values) (bool, string) {
 	queryExpressionNormalized := f.normalizeQueryString(query)
 	queryExpressionRangeLength := getQueryRangeSeconds(query)

internal/cortex/frontend/transport/utils/utils_test.go

@@ -39,7 +39,7 @@ func TestUpdateFailedQueryCache(t *testing.T) {
 				"query": {"test_query"},
 			},
 			expectedResult:  false,
-			expectedMessage: "msg: String regex conversion error, normalized query: test_query, query range seconds: 100, updating cache for error: no error code here",
+			expectedMessage: "msg: String to regex conversion error, cached_query: test_query, query_range_seconds: 100, cached_error: no error code here",
 		},
 		{
 			name: "Non-cacheable error code",
@@ -50,7 +50,7 @@ func TestUpdateFailedQueryCache(t *testing.T) {
 				"query": {"test_query"},
 			},
 			expectedResult:  false,
-			expectedMessage: "msg: Query not cached due to non-cacheable error code, normalized query: test_query, query range seconds: 100, updating cache for error: serads;ajkvsd( Code(500) code)asd",
+			expectedMessage: "msg: Query not cached due to non-cacheable error code, cached_query: test_query, query_range_seconds: 100, cached_error: serads;ajkvsd( Code(500) code)asd",
 		},
 		{
 			name: "Cacheable error code",
@@ -61,7 +61,7 @@ func TestUpdateFailedQueryCache(t *testing.T) {
 				"query": {"test_query"},
 			},
 			expectedResult:  true,
-			expectedMessage: "msg: Cached a failed query, normalized query: test_query, range seconds: 100, updating cache for error: This is a random error Code(408). It is random.",
+			expectedMessage: "msg: Cached a failed query, cached_query: test_query, query_range_seconds: 100, cached_error: This is a random error Code(408). It is random.",
 		},
 
 		{
@@ -73,7 +73,7 @@ func TestUpdateFailedQueryCache(t *testing.T) {
 				"query": {"\n \t tes \t  t query  \n"},
 			},
 			expectedResult:  true,
-			expectedMessage: "msg: Cached a failed query, normalized query:  tes t query , range seconds: 100, updating cache for error: Adding error with query that has whitespace and tabs Code(408). Let's see what happens.",
+			expectedMessage: "msg: Cached a failed query, cached_query:  tes t query , query_range_seconds: 100, cached_error: Adding error with query that has whitespace and tabs Code(408). Let's see what happens.",
 		},
 
 		{
@@ -85,7 +85,7 @@ func TestUpdateFailedQueryCache(t *testing.T) {
 				"query": {"test_query"},
 			},
 			expectedResult:  true,
-			expectedMessage: "msg: Cached a failed query, normalized query: test_query, range seconds: 80, updating cache for error: error code( Code(408) error.)",
+			expectedMessage: "msg: Cached a failed query, cached_query: test_query, query_range_seconds: 80, cached_error: error code( Code(408) error.)",
 		},
 
 		{
@@ -97,7 +97,7 @@ func TestUpdateFailedQueryCache(t *testing.T) {
 				"query": {"test_query"},
 			},
 			expectedResult:  true,
-			expectedMessage: "msg: Cached a failed query, normalized query: test_query, range seconds: 0, updating cache for error: error code( Code(408) error.)",
+			expectedMessage: "msg: Cached a failed query, cached_query: test_query, query_range_seconds: 0, cached_error: error code( Code(408) error.)",
 		},
 	}
 
@@ -136,7 +136,7 @@ func TestQueryHitCache(t *testing.T) {
 				"query": {"test_query"},
 			},
 			expectedResult:  true,
-			expectedMessage: "msg: Retrieved query from cache, normalized query: test_query, range seconds: 100",
+			expectedMessage: "msg: Retrieved query from cache, cached_query: test_query, cached_range_seconds: 100, query_range_seconds: 100",
 		},
 		{
 			name: "Cache miss",
@@ -168,7 +168,7 @@ func TestQueryHitCache(t *testing.T) {
 				"query": {" \n\ttes \tt \n   query \t\n  "},
 			},
 			expectedResult:  true,
-			expectedMessage: "msg: Retrieved query from cache, normalized query:  tes t query , range seconds: 100",
+			expectedMessage: "msg: Retrieved query from cache, cached_query:  tes t query , cached_range_seconds: 100, query_range_seconds: 100",
 		},
 
 		{