[ES|QL] Recommended query selection telemetry events (#240757)

## Summary

This PR adds the below telemetry events in the esql editor
- [x] esql.recommended_query_clicked (help or autocomplete)
- [x] esql.query_submitted (source: help)

### Checklist

Check the PR satisfies following conditions. 

Reviewers should verify this PR satisfies this list as well.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This was checked for breaking HTTP API changes, and any breaking
changes have been approved by the breaking-change committee. The
`release_note:breaking` label should be applied in these situations.
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
- [ ] Review the [backport
guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing)
and apply applicable `backport:*` labels.

### Identify risks

Does this PR introduce any risks? For example, consider risks like hard
to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified
risk. Invite stakeholders and evaluate how to proceed before merging.

- [ ] [See some risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
- [ ] ...

Author: momovdg

packages/kbn-optimizer/limits.yml

@@ -48,7 +48,7 @@ pageLoadAssetSize:
   embeddableAlertsTable: 6524
   embeddableEnhanced: 8448
   enterpriseSearch: 38000
-  esql: 16289
+  esql: 16500
   esqlDataGrid: 10209
   esUiShared: 101220
   eventAnnotation: 22361

src/platform/packages/private/kbn-esql-editor/src/editor_footer/index.tsx

@@ -51,7 +51,7 @@ interface EditorFooterProps {
   warnings?: MonacoMessage[];
   detectedTimestamp?: string;
   onErrorClick: (error: MonacoMessage) => void;
-  runQuery: (source: TelemetryQuerySubmittedProps['query_source']) => void;
+  runQuery: (source: TelemetryQuerySubmittedProps['source']) => void;
   updateQuery: (qs: string) => void;
   isHistoryOpen: boolean;
   setIsHistoryOpen: (status: boolean) => void;

src/platform/packages/private/kbn-esql-editor/src/esql_editor.tsx

@@ -48,10 +48,6 @@ import type { ComponentProps } from 'react';
 import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import { createPortal } from 'react-dom';
 import useObservable from 'react-use/lib/useObservable';
-import {
-  hasLimitBeforeAggregate,
-  missingSortBeforeLimit,
-} from '@kbn/esql-utils/src/utils/query_parsing_helpers';
 import type { TelemetryQuerySubmittedProps } from '@kbn/esql-types/src/esql_telemetry_types';
 import { QuerySource } from '@kbn/esql-types/src/esql_telemetry_types';
 import { useCanCreateLookupIndex, useLookupIndexCommand } from './custom_commands';
@@ -201,7 +197,7 @@ const ESQLEditorInternal = function ESQLEditor({
   );
 
   const onQuerySubmit = useCallback(
-    (source: TelemetryQuerySubmittedProps['query_source']) => {
+    (source: TelemetryQuerySubmittedProps['source']) => {
       if (isQueryLoading && isLoading && allowQueryCancellation) {
         abortController?.abort();
         setIsQueryLoading(false);
@@ -218,11 +214,8 @@ const ESQLEditorInternal = function ESQLEditor({
         // TODO: add rest of options
         if (currentValue) {
           telemetryService.trackQuerySubmitted({
-            query_source: source,
-            query_length: editor1.current?.getModel()?.getValueLength().toString() ?? '0',
-            query_lines: editor1.current?.getModel()?.getLineCount().toString() ?? '0',
-            anti_limit_before_aggregate: hasLimitBeforeAggregate(currentValue),
-            anti_missing_sort_before_limit: missingSortBeforeLimit(currentValue),
+            source,
+            query: currentValue,
           });
         }
         onTextLangQuerySubmit({ esql: currentValue } as AggregateQuery, abc);
@@ -336,6 +329,11 @@ const ESQLEditorInternal = function ESQLEditor({
     openTimePickerPopover();
   });
 
+  monaco.editor.registerCommand('esql.recommendedQuery.accept', (...args) => {
+    const [, { queryLabel }] = args;
+    telemetryService.trackRecommendedQueryClicked(QuerySource.AUTOCOMPLETE, queryLabel);
+  });
+
   const controlCommands = [
     { command: 'esql.control.multi_values.create', variableType: ESQLVariableType.MULTI_VALUES },
     { command: 'esql.control.time_literal.create', variableType: ESQLVariableType.TIME_LITERAL },

src/platform/packages/private/kbn-esql-editor/src/telemetry/events_registration.ts

@@ -20,6 +20,7 @@ export const ESQL_QUERY_HISTORY_OPENED = 'esql.query_history_opened';
 export const ESQL_QUERY_HISTORY_CLICKED = 'esql.query_history_clicked';
 export const ESQL_STARRED_QUERY_CLICKED = 'esql.starred_query_clicked';
 export const ESQL_QUERY_SUBMITTED = 'esql.query_submitted';
+export const ESQL_RECOMMENDED_QUERY_CLICKED = 'esql.recommended_query_clicked';
 
 /**
  * Registers the esql editor analytics events.
@@ -110,4 +111,22 @@ export const registerESQLEditorAnalyticsEvents = once((analytics: AnalyticsServi
       },
     },
   });
+  analytics.registerEventType({
+    eventType: ESQL_RECOMMENDED_QUERY_CLICKED,
+    schema: {
+      trigger_source: {
+        type: 'keyword',
+        _meta: {
+          description:
+            'The UI surface where the recommendation was shown. Possible values are: help|autocomplete',
+        },
+      },
+      recommended_query: {
+        type: 'keyword',
+        _meta: {
+          description: 'The label of the recommended query that was clicked',
+        },
+      },
+    },
+  });
 });

src/platform/packages/private/kbn-esql-editor/src/telemetry/telemetry_service.ts

@@ -8,11 +8,18 @@
  */
 import type { AnalyticsServiceStart } from '@kbn/core/server';
 import type { TelemetryQuerySubmittedProps } from '@kbn/esql-types/src/esql_telemetry_types';
+import { QuerySource } from '@kbn/esql-types/src/esql_telemetry_types';
+import { BasicPrettyPrinter, Parser } from '@kbn/esql-ast';
+import {
+  hasLimitBeforeAggregate,
+  missingSortBeforeLimit,
+} from '@kbn/esql-utils/src/utils/query_parsing_helpers';
 import {
   ESQL_LOOKUP_JOIN_ACTION_SHOWN,
   ESQL_QUERY_HISTORY_CLICKED,
   ESQL_QUERY_HISTORY_OPENED,
   ESQL_QUERY_SUBMITTED,
+  ESQL_RECOMMENDED_QUERY_CLICKED,
   ESQL_STARRED_QUERY_CLICKED,
   ESQL_SUGGESTIONS_WITH_CUSTOM_COMMAND_SHOWN,
 } from './events_registration';
@@ -100,13 +107,35 @@ export class ESQLEditorTelemetryService {
     }
   }
 
-  public trackQuerySubmitted(props: TelemetryQuerySubmittedProps) {
+  public trackQuerySubmitted({ source, query }: TelemetryQuerySubmittedProps) {
+    // parsing and prettifying the raw query
+    // to remove comments for accurately measuring its length
+    const { root } = Parser.parse(query);
+    const prettyQuery = BasicPrettyPrinter.print(root);
+    const hasLimitBeforeStats =
+      source === QuerySource.HELP || source === QuerySource.AUTOCOMPLETE
+        ? false
+        : hasLimitBeforeAggregate(query);
+    const hasMissingSortBeforeLimit =
+      source === QuerySource.HELP || source === QuerySource.AUTOCOMPLETE
+        ? false
+        : missingSortBeforeLimit(query);
     this._reportEvent(ESQL_QUERY_SUBMITTED, {
-      query_source: props.query_source,
-      query_length: props.query_length,
-      query_lines: props.query_lines,
-      anti_limit_before_aggregate: props.anti_limit_before_aggregate,
-      anti_missing_sort_before_limit: props.anti_missing_sort_before_limit,
+      query_source: source,
+      query_length: prettyQuery.length.toString(),
+      query_lines: query.split('\n').length.toString(),
+      anti_limit_before_aggregate: hasLimitBeforeStats,
+      anti_missing_sort_before_limit: hasMissingSortBeforeLimit,
+    });
+  }
+
+  public trackRecommendedQueryClicked(
+    source: QuerySource.HELP | QuerySource.AUTOCOMPLETE,
+    label: string
+  ) {
+    this._reportEvent(ESQL_RECOMMENDED_QUERY_CLICKED, {
+      trigger_source: source,
+      recommended_query: label,
     });
   }
 }

src/platform/packages/shared/kbn-esql-ast/src/commands_registry/options/recommended_queries/index.ts

@@ -196,6 +196,11 @@ export const getRecommendedQueriesSuggestionsFromStaticTemplates = async (
       kind: 'Issue',
       detail: query.description,
       sortText: query?.sortText ?? 'E',
+      command: {
+        id: 'esql.recommendedQuery.accept',
+        title: 'Accept recommended query',
+        arguments: [{ queryLabel: query.label }],
+      },
     };
   });
 

src/platform/packages/shared/kbn-esql-ast/src/commands_registry/types.ts

@@ -71,6 +71,7 @@ export interface ISuggestionItem {
   command?: {
     title: string;
     id: string;
+    arguments?: { [key: string]: string }[];
   };
   /**
    * The range that should be replaced when the suggestion is applied

src/platform/packages/shared/kbn-esql-types/src/esql_telemetry_types.ts

@@ -17,12 +17,10 @@ export enum QuerySource {
   STARRED = 'starred',
   MANUAL = 'manual',
   HELP = 'help',
+  AUTOCOMPLETE = 'autocomplete',
 }
 
 export interface TelemetryQuerySubmittedProps {
-  query_source: QuerySource;
-  query_length: string;
-  query_lines: string;
-  anti_limit_before_aggregate: boolean;
-  anti_missing_sort_before_limit: boolean;
+  source: QuerySource;
+  query: string;
 }

src/platform/plugins/shared/unified_search/public/query_string_input/esql_menu_popover.tsx

@@ -28,6 +28,8 @@ import { getRecommendedQueriesTemplates } from '@kbn/esql-ast/src/commands_regis
 import { LanguageDocumentationFlyout } from '@kbn/language-documentation';
 import { getCategorizationField } from '@kbn/aiops-utils';
 import { prettifyQueryTemplate } from '@kbn/esql-ast/src/commands_registry/options/recommended_queries/utils';
+import { ESQLEditorTelemetryService } from '@kbn/esql-editor/src/telemetry/telemetry_service';
+import { QuerySource } from '@kbn/esql-types/src/esql_telemetry_types';
 import type { IUnifiedSearchPluginServices } from '../types';
 
 export interface ESQLMenuPopoverProps {
@@ -42,7 +44,7 @@ export const ESQLMenuPopover: React.FC<ESQLMenuPopoverProps> = ({
   onESQLQuerySubmit,
 }) => {
   const kibana = useKibana<IUnifiedSearchPluginServices>();
-  const { docLinks, http, chrome } = kibana.services;
+  const { docLinks, http, chrome, analytics } = kibana.services;
 
   const { euiTheme } = useEuiTheme();
 
@@ -54,6 +56,8 @@ export const ESQLMenuPopover: React.FC<ESQLMenuPopoverProps> = ({
     RecommendedQuery[]
   >([]);
 
+  const telemetryServiceRef = useRef(new ESQLEditorTelemetryService(analytics));
+
   const { queryForRecommendedQueries, timeFieldName, categorizationField } = useMemo(() => {
     if (adHocDataview && typeof adHocDataview !== 'string') {
       const textFields = adHocDataview.fields?.getByType('string') ?? [];
@@ -244,7 +248,15 @@ export const ESQLMenuPopover: React.FC<ESQLMenuPopoverProps> = ({
           return {
             name: query.label,
             onClick: () => {
+              telemetryServiceRef.current.trackRecommendedQueryClicked(
+                QuerySource.HELP,
+                query.label
+              );
               onESQLQuerySubmit?.(query.queryString);
+              telemetryServiceRef.current.trackQuerySubmitted({
+                source: QuerySource.HELP,
+                query: query.queryString,
+              });
               setIsESQLMenuPopoverOpen(false);
             },
           };