Tracking: Add query execution tracking (#89)

* add query tracking

* add missing imports

src/datasource.ts

@@ -1,6 +1,6 @@
 import _ from 'lodash';
 import { from, merge, of, Observable } from 'rxjs';
-import { map } from 'rxjs/operators';
+import { map, tap } from 'rxjs/operators';
 import {
   DataSourceApi,
   DataSourceInstanceSettings,
@@ -31,6 +31,7 @@ import { bucketAggregationConfig } from './components/QueryEditor/BucketAggregat
 import { isBucketAggregationWithField } from './components/QueryEditor/BucketAggregationsEditor/aggregations';
 import { gte, lt, satisfies } from 'semver';
 import { OpenSearchAnnotationsQueryEditor } from './components/QueryEditor/AnnotationQueryEditor';
+import { trackQuery } from 'tracking';
 
 // Those are metadata fields as defined in https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html#_identity_metadata_fields.
 // custom fields can start with underscores, therefore is not safe to exclude anything that starts with one.
@@ -471,7 +472,16 @@ export class OpenSearchDatasource extends DataSourceApi<OpenSearchQuery, OpenSea
         state: LoadingState.Done,
       });
     }
-    return merge(...subQueries);
+    return merge(...subQueries).pipe(
+      tap({
+        next: response => {
+          trackQuery(response, [...pplTargets, ...luceneTargets], options.app);
+        },
+        error: error => {
+          trackQuery({ error, data: [] }, [...pplTargets, ...luceneTargets], options.app);
+        },
+      })
+    );
   }
 
   /**

src/tracking.ts

@@ -0,0 +1,39 @@
+import { DataQueryResponse } from '@grafana/data';
+import { reportInteraction } from '@grafana/runtime';
+import { OpenSearchQuery, QueryType } from 'types';
+
+export function trackQuery(response: DataQueryResponse, queries: OpenSearchQuery[], app: string): void {
+  for (const query of queries) {
+    try {
+      reportInteraction('grafana_opensearch_query_executed', {
+        app,
+        with_lucene_query: query.queryType === QueryType.Lucene,
+        with_ppl_query: query.queryType === QueryType.PPL,
+        query_type: getQueryType(query),
+        has_data: response.data.some(frame => frame.datapoints.length > 0),
+        has_error: response.error !== undefined,
+        simultaneously_sent_query_count: queries.length,
+        alias: query.alias,
+      });
+    } catch (error) {
+      console.error('error while reporting opensearch query', error);
+    }
+  }
+}
+
+function getQueryType(query: OpenSearchQuery) {
+  if (query.isLogsQuery) {
+    return 'logs';
+  }
+
+  // PPL queries are a bit special, as they can be either raw_data or metric, depending on the format
+  if (query.queryType === QueryType.PPL) {
+    return query.format === 'table' ? 'raw_data' : 'metric';
+  }
+
+  const types = ['raw_data', 'raw_document'];
+  if (types.includes(query.metrics[0].type)) {
+    return query.metrics[0].type;
+  }
+  return 'metric';
+}