feat: add datasource pre-filter

Author: idrissneumann

CONTRIBUTING.md

@@ -61,6 +61,13 @@ $ go test -v ./pkg/...
 $ npm run storybook
 ```
 
+## Reset grafana password
+
+```shell
+docker exec -it grafana-quickwit-datasource bash
+grafana-cli admin reset-admin-password <new_password>
+```
+
 ## Release
 
 TODO

build_and_start.sh

@@ -3,4 +3,4 @@
 npm install
 npm run build
 ~/go/bin/mage -v
-#docker compose up --build --force-recreate
+docker compose up --build --force-recreate

pkg/quickwit/client/client.go

@@ -24,6 +24,7 @@ type DatasourceInfo struct {
 	ID                         int64
 	UID                        string
 	Name                       string
+	ForcedQueryFilter          string
 	LogsDatasourceUID          string
 	LogsDatasourceName         string
 	TracesDatasourceUID        string

pkg/quickwit/data_query.go

@@ -14,7 +14,7 @@ const (
 	defaultSize = 100
 )
 
-func buildMSR(queries []*Query, defaultTimeField string) ([]*es.SearchRequest, error) {
+func buildMSR(queries []*Query, defaultTimeField string, forcedQueryFilter string) ([]*es.SearchRequest, error) {
 	ms := es.NewMultiSearchRequestBuilder()
 
 	for _, q := range queries {
@@ -31,7 +31,7 @@ func buildMSR(queries []*Query, defaultTimeField string) ([]*es.SearchRequest, e
 		// trace_id lookups go from "scan every split" to "scan a few" — the
 		// same speedup the native Jaeger endpoint gets via auto-derived bounds.
 		filters.AddDateRangeFilter(defaultTimeField, q.RangeTo, q.RangeFrom)
-		filters.AddQueryStringFilter(q.RawQuery, true, "AND")
+		filters.AddQueryStringFilter(applyForcedQueryFilter(q.RawQuery, forcedQueryFilter), true, "AND")
 		if isTraceSearchQuery(q) {
 			filters.AddQueryStringFilter(traceSearchSettingsQuery(q), true, "AND")
 		}
@@ -53,6 +53,20 @@ func buildMSR(queries []*Query, defaultTimeField string) ([]*es.SearchRequest, e
 	return ms.Build()
 }
 
+func applyForcedQueryFilter(rawQuery string, forcedQueryFilter string) string {
+	query := strings.TrimSpace(rawQuery)
+	forced := strings.TrimSpace(forcedQueryFilter)
+
+	if forced == "" {
+		return query
+	}
+	if query == "" {
+		return forced
+	}
+
+	return query + " AND " + forced
+}
+
 func setFloatPath(settings *simplejson.Json, path ...string) {
 	if stringValue, err := settings.GetPath(path...).String(); err == nil {
 		if value, err := strconv.ParseFloat(stringValue, 64); err == nil {

pkg/quickwit/data_query_test.go

@@ -24,6 +24,20 @@ func TestQueryTypeHelpersDoNotPanicWithoutMetrics(t *testing.T) {
 	})
 }
 
+func TestApplyForcedQueryFilter(t *testing.T) {
+	t.Run("adds AND when query is not empty", func(t *testing.T) {
+		assert.Equal(t, "service:api AND tenant:acme", applyForcedQueryFilter("service:api", "tenant:acme"))
+	})
+
+	t.Run("uses only forced filter when query is empty", func(t *testing.T) {
+		assert.Equal(t, "tenant:acme", applyForcedQueryFilter("", "tenant:acme"))
+	})
+
+	t.Run("keeps original query when forced filter is empty", func(t *testing.T) {
+		assert.Equal(t, "service:api", applyForcedQueryFilter("service:api", ""))
+	})
+}
+
 func TestExecuteElasticsearchDataQuery(t *testing.T) {
 	from := time.Date(2018, 5, 15, 17, 50, 0, 0, time.UTC)
 	to := time.Date(2018, 5, 15, 17, 55, 0, 0, time.UTC)
@@ -1801,7 +1815,7 @@ func executeElasticsearchDataQuery(c es.Client, body string, from, to time.Time)
 	if err != nil {
 		return nil, err
 	}
-	req, err := buildMSR(queries, configuredFields.TimeField)
+	req, err := buildMSR(queries, configuredFields.TimeField, "")
 	if err != nil {
 		return &backend.QueryDataResponse{}, err
 	}

pkg/quickwit/elasticsearch.go

@@ -25,7 +25,7 @@ func queryData(ctx context.Context, dataQueries []backend.DataQuery, dsInfo *es.
 
 	// Create a request
 	// NODE : Params should probably be assembled in a dedicated structure to be reused by parseResponse
-	req, err := buildMSR(queries, dsInfo.ConfiguredFields.TimeField)
+	req, err := buildMSR(queries, dsInfo.ConfiguredFields.TimeField, dsInfo.ForcedQueryFilter)
 	if err != nil {
 		return &backend.QueryDataResponse{}, err
 	}

pkg/quickwit/quickwit.go

@@ -67,6 +67,11 @@ func NewQuickwitDatasource(ctx context.Context, settings backend.DataSourceInsta
 		logMessageField = ""
 	}
 
+	forcedQueryFilter, ok := jsonData["forcedQueryFilter"].(string)
+	if !ok {
+		forcedQueryFilter = ""
+	}
+
 	logsDatasourceUID, ok := jsonData["logsDatasourceUid"].(string)
 	if !ok {
 		logsDatasourceUID = ""
@@ -121,6 +126,7 @@ func NewQuickwitDatasource(ctx context.Context, settings backend.DataSourceInsta
 		ID:                         settings.ID,
 		UID:                        settings.UID,
 		Name:                       settings.Name,
+		ForcedQueryFilter:          forcedQueryFilter,
 		LogsDatasourceUID:          logsDatasourceUID,
 		LogsDatasourceName:         logsDatasourceName,
 		TracesDatasourceUID:        tracesDatasourceUID,

src/configuration/ConfigEditor.test.tsx

@@ -26,6 +26,7 @@ describe('ConfigEditor', () => {
 
     // Check ElasticDetails are rendered
     expect(screen.getByText('Index settings')).toBeInTheDocument();
+    expect(screen.getByLabelText('Forced query filter')).toBeInTheDocument();
   });
 
   it('should not apply default if values are set', () => {

src/configuration/ConfigEditor.tsx

@@ -109,6 +109,21 @@ export const QuickwitDetails = ({ value, onChange }: DetailsProps) => {
               width={40}
             />
           </InlineField>
+          <InlineField
+            label="Forced query filter"
+            labelWidth={26}
+            tooltip="Lucene filter added to every query. Combined with AND when query is not empty."
+          >
+            <Input
+              id="quickwit_forced_query_filter"
+              value={value.jsonData.forcedQueryFilter}
+              onChange={(event) =>
+                onChange({ ...value, jsonData: { ...value.jsonData, forcedQueryFilter: event.currentTarget.value } })
+              }
+              placeholder="service:frontend"
+              width={40}
+            />
+          </InlineField>
         </FieldSet>
         <FieldSet label="Editor settings">
           <InlineField label="Default logs limit" labelWidth={26} tooltip="The log level field must be a fast field">

src/configuration/utils.ts

@@ -14,6 +14,7 @@ export const coerceOptions = (
       ...options.jsonData,
       logMessageField: options.jsonData.logMessageField || '',
       logLevelField: options.jsonData.logLevelField || '',
+      forcedQueryFilter: options.jsonData.forcedQueryFilter || '',
       filterAutocompleteLimit: options.jsonData.filterAutocompleteLimit ?? '1000',
       filterAutocompleteChainMode,
       filterAutocompleteUseFilterChains: filterAutocompleteChainMode !== 'none',