Infinite scrolling: Add X-Query-Tag header (#81089)

packages/grafana-schema/src/raw/composable/loki/dataquery/x/LokiDataQuery_types.gen.ts

@@ -26,6 +26,7 @@ export enum LokiQueryType {
 
 export enum SupportingQueryType {
   DataSample = 'dataSample',
+  InfiniteScroll = 'infiniteScroll',
   LogsSample = 'logsSample',
   LogsVolume = 'logsVolume',
 }

pkg/tsdb/loki/api.go

@@ -332,6 +332,8 @@ func getSupportingQueryHeaderValue(req *http.Request, supportingQueryType Suppor
 		value = "logsample"
 	case SupportingQueryDataSample:
 		value = "datasample"
+	case SupportingQueryInfiniteScroll:
+		value = "infinitescroll"
 	default: //ignore
 	}
 

pkg/tsdb/loki/api_test.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/grafana/grafana/pkg/tsdb/loki/kinds/dataquery"
 	"github.com/stretchr/testify/require"
 )
 
@@ -82,6 +83,30 @@ func TestApiLogVolume(t *testing.T) {
 	})
 }
 
+func TestInfiniteScroll(t *testing.T) {
+	response := []byte(`
+	{
+		"status": "success",
+		"data": {
+			"resultType" : "matrix",
+			"result": []
+		}
+	}
+	`)
+
+	t.Run("infinite scrolling queries should set infinite scroll http header", func(t *testing.T) {
+		called := false
+		api := makeMockedAPI(200, "application/json", response, func(req *http.Request) {
+			called = true
+			require.Equal(t, "Source=infinitescroll", req.Header.Get("X-Query-Tags"))
+		}, false)
+
+		_, err := api.DataQuery(context.Background(), lokiQuery{Expr: "", SupportingQueryType: dataquery.SupportingQueryTypeInfiniteScroll, QueryType: QueryTypeRange}, ResponseOpts{})
+		require.NoError(t, err)
+		require.True(t, called)
+	})
+}
+
 func TestApiUrlHandling(t *testing.T) {
 	response := []byte(`
 	{

pkg/tsdb/loki/kinds/dataquery/types_dataquery_gen.go

@@ -30,9 +30,10 @@ const (
 
 // Defines values for SupportingQueryType.
 const (
-	SupportingQueryTypeDataSample SupportingQueryType = "dataSample"
-	SupportingQueryTypeLogsSample SupportingQueryType = "logsSample"
-	SupportingQueryTypeLogsVolume SupportingQueryType = "logsVolume"
+	SupportingQueryTypeDataSample     SupportingQueryType = "dataSample"
+	SupportingQueryTypeInfiniteScroll SupportingQueryType = "infiniteScroll"
+	SupportingQueryTypeLogsSample     SupportingQueryType = "logsSample"
+	SupportingQueryTypeLogsVolume     SupportingQueryType = "logsVolume"
 )
 
 // These are the common properties available to all queries in all datasources.

pkg/tsdb/loki/types.go

@@ -16,10 +16,11 @@ const (
 )
 
 const (
-	SupportingQueryLogsVolume                     = dataquery.SupportingQueryTypeLogsVolume
-	SupportingQueryLogsSample                     = dataquery.SupportingQueryTypeLogsSample
-	SupportingQueryDataSample                     = dataquery.SupportingQueryTypeDataSample
-	SupportingQueryNone       SupportingQueryType = "none"
+	SupportingQueryLogsVolume                         = dataquery.SupportingQueryTypeLogsVolume
+	SupportingQueryLogsSample                         = dataquery.SupportingQueryTypeLogsSample
+	SupportingQueryDataSample                         = dataquery.SupportingQueryTypeDataSample
+	SupportingQueryInfiniteScroll                     = dataquery.SupportingQueryTypeInfiniteScroll
+	SupportingQueryNone           SupportingQueryType = "none"
 )
 
 const (

public/app/features/explore/state/query.ts

@@ -41,6 +41,7 @@ import { getShiftedTimeRange } from 'app/core/utils/timePicker';
 import { getCorrelationsBySourceUIDs } from 'app/features/correlations/utils';
 import { infiniteScrollRefId } from 'app/features/logs/logsModel';
 import { getFiscalYearStartMonth, getTimeZone } from 'app/features/profile/state/selectors';
+import { SupportingQueryType } from 'app/plugins/datasource/loki/types';
 import { MIXED_DATASOURCE_NAME } from 'app/plugins/datasource/mixed/MixedDataSource';
 import {
   createAsyncThunk,
@@ -732,6 +733,7 @@ export const runLoadMoreLogsQueries = createAsyncThunk<void, RunLoadMoreLogsQuer
         ...query,
         datasource: query.datasource || datasourceInstance?.getRef(),
         refId: `${infiniteScrollRefId}${query.refId}`,
+        supportingQueryType: SupportingQueryType.InfiniteScroll,
       }));
 
     if (!hasNonEmptyQuery(logQueries) || !datasourceInstance) {

public/app/plugins/datasource/loki/dataquery.cue

@@ -47,7 +47,7 @@ composableKinds: DataQuery: {
 
 				#LokiQueryType: "range" | "instant" | "stream" @cuetsy(kind="enum")
 
-				#SupportingQueryType: "logsVolume" | "logsSample" | "dataSample" @cuetsy(kind="enum")
+				#SupportingQueryType: "logsVolume" | "logsSample" | "dataSample" | "infiniteScroll" @cuetsy(kind="enum")
 
 				#LokiQueryDirection: "forward" | "backward" @cuetsy(kind="enum")
 			}

public/app/plugins/datasource/loki/dataquery.gen.ts

@@ -23,6 +23,7 @@ export enum LokiQueryType {
 
 export enum SupportingQueryType {
   DataSample = 'dataSample',
+  InfiniteScroll = 'infiniteScroll',
   LogsSample = 'logsSample',
   LogsVolume = 'logsVolume',
 }