[OneDiscover] Add EBT event to track field usage (#193996)

- Closes #186156 - Closes #189454 ## Summary This PR adds new EBT event type `discover_field_usage` which we use for tracking adding and removing grid columns and adding filters via +/-/exists buttons. Properties of the added events consist of: `eventType`: `dataTableSelection`, `dataTableRemoval`, or `filterAddition` `fieldName`: name of the field if it's from ECS schema `filterOperation`: `+`, `-`, or `_exists_` <img width="1002" alt="Screenshot 2024-09-25 at 17 51 27" src="https://github.com/user-attachments/assets/b3f3fb69-55e1-43b2-9683-a6d8884f56fe"> ## Testing Enable "Usage collection" global setting. Navigate to Discover and observe `kibana-browser` requests in Network tab. ### Checklist - [x] [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 (cherry picked from commit 7aa64b6)
elastic · Sep 30, 2024 · 6c8b3ad · 6c8b3ad
1 parent 464430d
commit 6c8b3ad
Show file tree

Hide file tree

Showing 17 changed files with 946 additions and 337 deletions.
diff --git a/src/plugins/discover/public/__mocks__/services.ts b/src/plugins/discover/public/__mocks__/services.ts
@@ -45,6 +45,7 @@ import { SearchResponse } from '@elastic/elasticsearch/lib/api/types';
 import { urlTrackerMock } from './url_tracker.mock';
 import { createElement } from 'react';
 import { createContextAwarenessMocks } from '../context_awareness/__mocks__';
+import { DiscoverEBTManager } from '../services/discover_ebt_manager';
 
 export function createDiscoverServicesMock(): DiscoverServices {
   const dataPlugin = dataPluginMock.createStartContract();
@@ -245,6 +246,7 @@ export function createDiscoverServicesMock(): DiscoverServices {
     singleDocLocator: { getRedirectUrl: jest.fn(() => '') },
     urlTracker: urlTrackerMock,
     profilesManager: profilesManagerMock,
+    ebtManager: new DiscoverEBTManager(),
     setHeaderActionMenu: jest.fn(),
   } as unknown as DiscoverServices;
 }

diff --git a/src/plugins/discover/public/application/context/context_app.test.tsx b/src/plugins/discover/public/application/context/context_app.test.tsx
@@ -72,6 +72,7 @@ describe('ContextApp test', () => {
     contextLocator: { getRedirectUrl: jest.fn(() => '') },
     singleDocLocator: { getRedirectUrl: jest.fn(() => '') },
     profilesManager: discoverServices.profilesManager,
+    ebtManager: discoverServices.ebtManager,
     timefilter: discoverServices.timefilter,
     uiActions: discoverServices.uiActions,
   } as unknown as DiscoverServices;

diff --git a/src/plugins/discover/public/application/context/context_app.tsx b/src/plugins/discover/public/application/context/context_app.tsx
@@ -56,6 +56,8 @@ export const ContextApp = ({ dataView, anchorId, referrer }: ContextAppProps) =>
     navigation,
     filterManager,
     core,
+    ebtManager,
+    fieldsMetadata,
   } = services;
 
   const isLegacy = useMemo(() => uiSettings.get(DOC_TABLE_LEGACY), [uiSettings]);
@@ -199,15 +201,36 @@ export const ContextApp = ({ dataView, anchorId, referrer }: ContextAppProps) =>
   );
 
   const addFilter = useCallback(
-    async (field: DataViewField | string, values: unknown, operation: string) => {
+    async (field: DataViewField | string, values: unknown, operation: '+' | '-') => {
       const newFilters = generateFilters(filterManager, field, values, operation, dataView);
       filterManager.addFilters(newFilters);
       if (dataViews) {
         const fieldName = typeof field === 'string' ? field : field.name;
         await popularizeField(dataView, fieldName, dataViews, capabilities);
+        void ebtManager.trackFilterAddition({
+          fieldName: fieldName === '_exists_' ? String(values) : fieldName,
+          filterOperation: fieldName === '_exists_' ? '_exists_' : operation,
+          fieldsMetadata,
+        });
       }
     },
-    [filterManager, dataViews, dataView, capabilities]
+    [filterManager, dataViews, dataView, capabilities, ebtManager, fieldsMetadata]
+  );
+
+  const onAddColumnWithTracking = useCallback(
+    (columnName: string) => {
+      onAddColumn(columnName);
+      void ebtManager.trackDataTableSelection({ fieldName: columnName, fieldsMetadata });
+    },
+    [onAddColumn, ebtManager, fieldsMetadata]
+  );
+
+  const onRemoveColumnWithTracking = useCallback(
+    (columnName: string) => {
+      onRemoveColumn(columnName);
+      void ebtManager.trackDataTableRemoval({ fieldName: columnName, fieldsMetadata });
+    },
+    [onRemoveColumn, ebtManager, fieldsMetadata]
   );
 
   const TopNavMenu = navigation.ui.AggregateQueryTopNavMenu;
@@ -271,8 +294,8 @@ export const ContextApp = ({ dataView, anchorId, referrer }: ContextAppProps) =>
                 isLegacy={isLegacy}
                 columns={columns}
                 grid={appState.grid}
-                onAddColumn={onAddColumn}
-                onRemoveColumn={onRemoveColumn}
+                onAddColumn={onAddColumnWithTracking}
+                onRemoveColumn={onRemoveColumnWithTracking}
                 onSetColumns={onSetColumns}
                 predecessorCount={appState.predecessorCount}
                 successorCount={appState.successorCount}

diff --git a/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx b/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx
@@ -117,7 +117,7 @@ function DiscoverDocumentsComponent({
   const services = useDiscoverServices();
   const documents$ = stateContainer.dataState.data$.documents$;
   const savedSearch = useSavedSearchInitial();
-  const { dataViews, capabilities, uiSettings, uiActions } = services;
+  const { dataViews, capabilities, uiSettings, uiActions, ebtManager, fieldsMetadata } = services;
   const [
     dataSource,
     query,
@@ -200,6 +200,22 @@ function DiscoverDocumentsComponent({
     settings: grid,
   });
 
+  const onAddColumnWithTracking = useCallback(
+    (columnName: string) => {
+      onAddColumn(columnName);
+      void ebtManager.trackDataTableSelection({ fieldName: columnName, fieldsMetadata });
+    },
+    [onAddColumn, ebtManager, fieldsMetadata]
+  );
+
+  const onRemoveColumnWithTracking = useCallback(
+    (columnName: string) => {
+      onRemoveColumn(columnName);
+      void ebtManager.trackDataTableRemoval({ fieldName: columnName, fieldsMetadata });
+    },
+    [onRemoveColumn, ebtManager, fieldsMetadata]
+  );
+
   const setExpandedDoc = useCallback(
     (doc: DataTableRecord | undefined) => {
       stateContainer.internalState.transitions.setExpandedDoc(doc);
@@ -299,14 +315,22 @@ function DiscoverDocumentsComponent({
         columnsMeta={customColumnsMeta}
         savedSearchId={savedSearch.id}
         onFilter={onAddFilter}
-        onRemoveColumn={onRemoveColumn}
-        onAddColumn={onAddColumn}
+        onRemoveColumn={onRemoveColumnWithTracking}
+        onAddColumn={onAddColumnWithTracking}
         onClose={() => setExpandedDoc(undefined)}
         setExpandedDoc={setExpandedDoc}
         query={query}
       />
     ),
-    [dataView, onAddColumn, onAddFilter, onRemoveColumn, query, savedSearch.id, setExpandedDoc]
+    [
+      dataView,
+      onAddColumnWithTracking,
+      onAddFilter,
+      onRemoveColumnWithTracking,
+      query,
+      savedSearch.id,
+      setExpandedDoc,
+    ]
   );
 
   const configRowHeight = uiSettings.get(ROW_HEIGHT_OPTION);

diff --git a/src/plugins/discover/public/application/main/components/layout/discover_layout.tsx b/src/plugins/discover/public/application/main/components/layout/discover_layout.tsx
@@ -78,6 +78,8 @@ export function DiscoverLayout({ stateContainer }: DiscoverLayoutProps) {
     spaces,
     observabilityAIAssistant,
     dataVisualizer: dataVisualizerService,
+    ebtManager,
+    fieldsMetadata,
   } = useDiscoverServices();
   const pageBackgroundColor = useEuiBackgroundColor('plain');
   const globalQueryState = data.query.getState();
@@ -154,6 +156,22 @@ export function DiscoverLayout({ stateContainer }: DiscoverLayoutProps) {
     settings: grid,
   });
 
+  const onAddColumnWithTracking = useCallback(
+    (columnName: string) => {
+      onAddColumn(columnName);
+      void ebtManager.trackDataTableSelection({ fieldName: columnName, fieldsMetadata });
+    },
+    [onAddColumn, ebtManager, fieldsMetadata]
+  );
+
+  const onRemoveColumnWithTracking = useCallback(
+    (columnName: string) => {
+      onRemoveColumn(columnName);
+      void ebtManager.trackDataTableRemoval({ fieldName: columnName, fieldsMetadata });
+    },
+    [onRemoveColumn, ebtManager, fieldsMetadata]
+  );
+
   // The assistant is getting the state from the url correctly
   // expect from the index pattern where we have only the dataview id
   useEffect(() => {
@@ -175,9 +193,14 @@ export function DiscoverLayout({ stateContainer }: DiscoverLayoutProps) {
       if (trackUiMetric) {
         trackUiMetric(METRIC_TYPE.CLICK, 'filter_added');
       }
+      void ebtManager.trackFilterAddition({
+        fieldName: fieldName === '_exists_' ? String(values) : fieldName,
+        filterOperation: fieldName === '_exists_' ? '_exists_' : operation,
+        fieldsMetadata,
+      });
       return filterManager.addFilters(newFilters);
     },
-    [filterManager, dataView, dataViews, trackUiMetric, capabilities]
+    [filterManager, dataView, dataViews, trackUiMetric, capabilities, ebtManager, fieldsMetadata]
   );
 
   const getOperator = (fieldName: string, values: unknown, operation: '+' | '-') => {
@@ -222,8 +245,13 @@ export function DiscoverLayout({ stateContainer }: DiscoverLayoutProps) {
       if (trackUiMetric) {
         trackUiMetric(METRIC_TYPE.CLICK, 'esql_filter_added');
       }
+      void ebtManager.trackFilterAddition({
+        fieldName: fieldName === '_exists_' ? String(values) : fieldName,
+        filterOperation: fieldName === '_exists_' ? '_exists_' : operation,
+        fieldsMetadata,
+      });
     },
-    [data.query.queryString, query, trackUiMetric]
+    [data.query.queryString, query, trackUiMetric, ebtManager, fieldsMetadata]
   );
 
   const onFilter = isEsqlMode ? onPopulateWhereClause : onAddFilter;
@@ -274,8 +302,8 @@ export function DiscoverLayout({ stateContainer }: DiscoverLayoutProps) {
       return undefined;
     }
 
-    return () => onAddColumn(draggingFieldName);
-  }, [onAddColumn, draggingFieldName, currentColumns]);
+    return () => onAddColumnWithTracking(draggingFieldName);
+  }, [onAddColumnWithTracking, draggingFieldName, currentColumns]);
 
   const [sidebarToggleState$] = useState<BehaviorSubject<SidebarToggleState>>(
     () => new BehaviorSubject<SidebarToggleState>({ isCollapsed: false, toggle: () => {} })
@@ -396,10 +424,10 @@ export function DiscoverLayout({ stateContainer }: DiscoverLayoutProps) {
             sidebarPanel={
               <SidebarMemoized
                 documents$={stateContainer.dataState.data$.documents$}
-                onAddField={onAddColumn}
+                onAddField={onAddColumnWithTracking}
+                onRemoveField={onRemoveColumnWithTracking}
                 columns={currentColumns}
                 onAddFilter={onFilter}
-                onRemoveField={onRemoveColumn}
                 onChangeDataView={stateContainer.actions.onChangeDataView}
                 selectedDataView={dataView}
                 trackUiMetric={trackUiMetric}

diff --git a/src/plugins/discover/public/build_services.ts b/src/plugins/discover/public/build_services.ts
@@ -64,7 +64,7 @@ import type { DiscoverContextAppLocator } from './application/context/services/l
 import type { DiscoverSingleDocLocator } from './application/doc/locator';
 import type { DiscoverAppLocator } from '../common';
 import type { ProfilesManager } from './context_awareness';
-import type { DiscoverEBTContextManager } from './services/discover_ebt_context_manager';
+import type { DiscoverEBTManager } from './services/discover_ebt_manager';
 
 /**
  * Location state of internal Discover history instance
@@ -132,7 +132,7 @@ export interface DiscoverServices {
   noDataPage?: NoDataPagePluginStart;
   observabilityAIAssistant?: ObservabilityAIAssistantPublicStart;
   profilesManager: ProfilesManager;
-  ebtContextManager: DiscoverEBTContextManager;
+  ebtManager: DiscoverEBTManager;
   fieldsMetadata?: FieldsMetadataPublicStart;
   logsDataAccess?: LogsDataAccessPluginStart;
 }
@@ -149,7 +149,7 @@ export const buildServices = memoize(
     scopedHistory,
     urlTracker,
     profilesManager,
-    ebtContextManager,
+    ebtManager,
     setHeaderActionMenu = noop,
   }: {
     core: CoreStart;
@@ -162,7 +162,7 @@ export const buildServices = memoize(
     scopedHistory?: ScopedHistory;
     urlTracker: UrlTracker;
     profilesManager: ProfilesManager;
-    ebtContextManager: DiscoverEBTContextManager;
+    ebtManager: DiscoverEBTManager;
     setHeaderActionMenu?: AppMountParameters['setHeaderActionMenu'];
   }): DiscoverServices => {
     const { usageCollection } = plugins;
@@ -223,7 +223,7 @@ export const buildServices = memoize(
       noDataPage: plugins.noDataPage,
       observabilityAIAssistant: plugins.observabilityAIAssistant,
       profilesManager,
-      ebtContextManager,
+      ebtManager,
       fieldsMetadata: plugins.fieldsMetadata,
       logsDataAccess: plugins.logsDataAccess,
     };

diff --git a/src/plugins/discover/public/context_awareness/__mocks__/index.tsx b/src/plugins/discover/public/context_awareness/__mocks__/index.tsx
@@ -23,7 +23,7 @@ import {
 } from '../profiles';
 import { ProfileProviderServices } from '../profile_providers/profile_provider_services';
 import { ProfilesManager } from '../profiles_manager';
-import { DiscoverEBTContextManager } from '../../services/discover_ebt_context_manager';
+import { DiscoverEBTManager } from '../../services/discover_ebt_manager';
 import { createLogsContextServiceMock } from '@kbn/discover-utils/src/__mocks__';
 
 export const createContextAwarenessMocks = ({
@@ -152,12 +152,12 @@ export const createContextAwarenessMocks = ({
     documentProfileServiceMock.registerProvider(documentProfileProviderMock);
   }
 
-  const ebtContextManagerMock = new DiscoverEBTContextManager();
+  const ebtManagerMock = new DiscoverEBTManager();
   const profilesManagerMock = new ProfilesManager(
     rootProfileServiceMock,
     dataSourceProfileServiceMock,
     documentProfileServiceMock,
-    ebtContextManagerMock
+    ebtManagerMock
   );
 
   const profileProviderServices = createProfileProviderServicesMock();
@@ -173,7 +173,7 @@ export const createContextAwarenessMocks = ({
     contextRecordMock2,
     profilesManagerMock,
     profileProviderServices,
-    ebtContextManagerMock,
+    ebtManagerMock,
   };
 };
 

diff --git a/src/plugins/discover/public/context_awareness/profiles_manager.test.ts b/src/plugins/discover/public/context_awareness/profiles_manager.test.ts
@@ -21,7 +21,7 @@ describe('ProfilesManager', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     mocks = createContextAwarenessMocks();
-    jest.spyOn(mocks.ebtContextManagerMock, 'updateProfilesContextWith');
+    jest.spyOn(mocks.ebtManagerMock, 'updateProfilesContextWith');
   });
 
   it('should return default profiles', () => {
@@ -62,7 +62,7 @@ describe('ProfilesManager', () => {
       mocks.documentProfileProviderMock.profile,
     ]);
 
-    expect(mocks.ebtContextManagerMock.updateProfilesContextWith).toHaveBeenCalledWith([
+    expect(mocks.ebtManagerMock.updateProfilesContextWith).toHaveBeenCalledWith([
       'root-profile',
       'data-source-profile',
     ]);

diff --git a/src/plugins/discover/public/context_awareness/profiles_manager.ts b/src/plugins/discover/public/context_awareness/profiles_manager.ts
@@ -25,7 +25,7 @@ import type {
   DocumentContext,
 } from './profiles';
 import type { ContextWithProfileId } from './profile_service';
-import { DiscoverEBTContextManager } from '../services/discover_ebt_context_manager';
+import { DiscoverEBTManager } from '../services/discover_ebt_manager';
 
 interface SerializedRootProfileParams {
   solutionNavId: RootProfileProviderParams['solutionNavId'];
@@ -53,7 +53,7 @@ export interface GetProfilesOptions {
 export class ProfilesManager {
   private readonly rootContext$: BehaviorSubject<ContextWithProfileId<RootContext>>;
   private readonly dataSourceContext$: BehaviorSubject<ContextWithProfileId<DataSourceContext>>;
-  private readonly ebtContextManager: DiscoverEBTContextManager;
+  private readonly ebtManager: DiscoverEBTManager;
 
   private prevRootProfileParams?: SerializedRootProfileParams;
   private prevDataSourceProfileParams?: SerializedDataSourceProfileParams;
@@ -64,11 +64,11 @@ export class ProfilesManager {
     private readonly rootProfileService: RootProfileService,
     private readonly dataSourceProfileService: DataSourceProfileService,
     private readonly documentProfileService: DocumentProfileService,
-    ebtContextManager: DiscoverEBTContextManager
+    ebtManager: DiscoverEBTManager
   ) {
     this.rootContext$ = new BehaviorSubject(rootProfileService.defaultContext);
     this.dataSourceContext$ = new BehaviorSubject(dataSourceProfileService.defaultContext);
-    this.ebtContextManager = ebtContextManager;
+    this.ebtManager = ebtManager;
   }
 
   /**
@@ -206,7 +206,7 @@ export class ProfilesManager {
   private trackActiveProfiles(rootContextProfileId: string, dataSourceContextProfileId: string) {
     const dscProfiles = [rootContextProfileId, dataSourceContextProfileId];
 
-    this.ebtContextManager.updateProfilesContextWith(dscProfiles);
+    this.ebtManager.updateProfilesContextWith(dscProfiles);
   }
 }