[Streams] Add EBT browser events (#234777)

Partially resolves elastic/streams-program#186

This adds EBT browser events for these actions in the UI:
* Processing saved
* Stream's retention config changed
* Child stream created
* Schema changed (field is mapped or unmapped)
* Failure store config changed
* Significant event suggestions generated
* Significant events created

Some events also include additional metadata. See their schema
definitions for details.

## How to test

Go through the mentioned UI actions and make sure you see corresponding
events sent via `kibana-browser` endpoint.

Author: mykolaharmash

packages/kbn-optimizer/limits.yml

@@ -163,7 +163,7 @@ pageLoadAssetSize:
   stackAlerts: 31499
   stackConnectors: 67939
   streams: 8494
-  streamsApp: 12431
+  streamsApp: 15200
   streamsAppWrapper: 5787
   synthetics: 31571
   telemetry: 25755

x-pack/platform/plugins/shared/dataset_quality/public/plugin.tsx

@@ -45,6 +45,7 @@ export class DatasetQualityPlugin
 
     const dataStreamDetailsService = new DataStreamDetailsService().start({
       http: core.http,
+      telemetryClient,
     });
 
     const DatasetQuality = createDatasetQuality({

x-pack/platform/plugins/shared/dataset_quality/public/services/data_stream_details/data_stream_details_client.ts

@@ -57,9 +57,13 @@ import type {
   UpdateFieldLimitParams,
 } from '../../../common/data_stream_details/types';
 import { DatasetQualityError } from '../../../common/errors';
+import type { ITelemetryClient } from '../telemetry';
 
 export class DataStreamDetailsClient implements IDataStreamDetailsClient {
-  constructor(private readonly http: HttpStart) {}
+  constructor(
+    private readonly http: HttpStart,
+    private readonly telemetryClient: ITelemetryClient
+  ) {}
 
   public async getDataStreamSettings({ dataStream }: GetDataStreamSettingsParams) {
     const response = await this.http
@@ -338,6 +342,12 @@ export class DataStreamDetailsClient implements IDataStreamDetailsClient {
         throw new DatasetQualityError(`Failed to update failure store": ${error}`, error);
       });
 
+    this.telemetryClient.trackFailureStoreUpdated({
+      data_stream_name: dataStream,
+      failure_store_enabled: failureStoreEnabled,
+      custom_retention_period: customRetentionPeriod,
+    });
+
     return decodeOrThrow(
       updateFailureStoreResponseRt,
       (message: string) =>

x-pack/platform/plugins/shared/dataset_quality/public/services/data_stream_details/data_stream_details_service.ts

@@ -17,16 +17,19 @@ export class DataStreamDetailsService {
 
   public setup(): DataStreamDetailsServiceSetup {}
 
-  public start({ http }: DataStreamDetailsServiceStartDeps): DataStreamDetailsServiceStart {
+  public start({
+    http,
+    telemetryClient,
+  }: DataStreamDetailsServiceStartDeps): DataStreamDetailsServiceStart {
     return {
-      getClient: () => this.getClient({ http }),
+      getClient: () => this.getClient({ http, telemetryClient }),
     };
   }
 
-  private async getClient({ http }: DataStreamDetailsServiceStartDeps) {
+  private async getClient({ http, telemetryClient }: DataStreamDetailsServiceStartDeps) {
     if (!this.client) {
       const { DataStreamDetailsClient } = await import('./data_stream_details_client');
-      const client = new DataStreamDetailsClient(http);
+      const client = new DataStreamDetailsClient(http, telemetryClient);
       this.client = client;
     }
 

x-pack/platform/plugins/shared/dataset_quality/public/services/data_stream_details/types.ts

@@ -37,6 +37,7 @@ import type {
   UpdateFailureStoreResponse,
   NonAggregatableDatasets,
 } from '../../../common/api_types';
+import type { ITelemetryClient } from '../telemetry';
 
 export type DataStreamDetailsServiceSetup = void;
 
@@ -46,6 +47,7 @@ export interface DataStreamDetailsServiceStart {
 
 export interface DataStreamDetailsServiceStartDeps {
   http: HttpStart;
+  telemetryClient: ITelemetryClient;
 }
 
 export interface IDataStreamDetailsClient {

x-pack/platform/plugins/shared/dataset_quality/public/services/telemetry/telemetry_client.ts

@@ -13,6 +13,7 @@ import type {
   DatasetDetailsNavigatedEbtProps,
   DatasetDetailsTrackingState,
   DatasetNavigatedEbtProps,
+  FailureStoreUpdateEbtProps,
 } from './types';
 import { DatasetQualityTelemetryEventTypes } from './types';
 
@@ -62,4 +63,8 @@ export class TelemetryClient implements ITelemetryClient {
       tracking_id: this.datasetDetailsTrackingId,
     });
   };
+
+  public trackFailureStoreUpdated = (eventProps: FailureStoreUpdateEbtProps) => {
+    this.analytics.reportEvent(DatasetQualityTelemetryEventTypes.FAILURE_STORE_UPDATED, eventProps);
+  };
 }

x-pack/platform/plugins/shared/dataset_quality/public/services/telemetry/telemetry_events.ts

@@ -288,9 +288,35 @@ const datasetDetailsBreakdownFieldChangedEventType: DatasetQualityTelemetryEvent
   },
 };
 
+const failureStoreUpdatedEventType: DatasetQualityTelemetryEvent = {
+  eventType: DatasetQualityTelemetryEventTypes.FAILURE_STORE_UPDATED,
+  schema: {
+    data_stream_name: {
+      type: 'keyword',
+      _meta: {
+        description: 'Name of the data stream',
+      },
+    },
+    failure_store_enabled: {
+      type: 'boolean',
+      _meta: {
+        description: 'Whether failure store is enabled for the datastream',
+      },
+    },
+    custom_retention_period: {
+      type: 'keyword',
+      _meta: {
+        description: 'Custom retention period if set, otherwise system default applies',
+        optional: true,
+      },
+    },
+  },
+};
+
 export const datasetQualityEbtEvents = {
   datasetNavigatedEventType,
   datasetDetailsOpenedEventType,
   datasetDetailsNavigatedEventType,
   datasetDetailsBreakdownFieldChangedEventType,
+  failureStoreUpdatedEventType,
 };

x-pack/platform/plugins/shared/dataset_quality/public/services/telemetry/telemetry_service.ts

@@ -25,6 +25,7 @@ export class TelemetryService {
     analytics.registerEventType(
       datasetQualityEbtEvents.datasetDetailsBreakdownFieldChangedEventType
     );
+    analytics.registerEventType(datasetQualityEbtEvents.failureStoreUpdatedEventType);
   }
 
   public start(): ITelemetryClient {

x-pack/platform/plugins/shared/dataset_quality/public/services/telemetry/types.ts

@@ -100,20 +100,28 @@ export interface DatasetDetailsNavigatedEbtProps extends DatasetDetailsEbtProps
   source: NavigationSource;
 }
 
+export interface FailureStoreUpdateEbtProps {
+  data_stream_name: string;
+  failure_store_enabled: boolean;
+  custom_retention_period?: string;
+}
+
 export interface ITelemetryClient {
   trackDatasetNavigated: (eventProps: DatasetNavigatedEbtProps) => void;
   startDatasetDetailsTracking: () => void;
   getDatasetDetailsTrackingState: () => DatasetDetailsTrackingState;
   trackDatasetDetailsOpened: (eventProps: DatasetDetailsEbtProps) => void;
   trackDatasetDetailsNavigated: (eventProps: DatasetDetailsNavigatedEbtProps) => void;
   trackDatasetDetailsBreakdownFieldChanged: (eventProps: DatasetDetailsEbtProps) => void;
+  trackFailureStoreUpdated: (eventProps: FailureStoreUpdateEbtProps) => void;
 }
 
 export enum DatasetQualityTelemetryEventTypes {
   NAVIGATED = 'Dataset Quality Navigated',
   DETAILS_OPENED = 'Dataset Quality Dataset Details Opened',
   DETAILS_NAVIGATED = 'Dataset Quality Dataset Details Navigated',
   BREAKDOWN_FIELD_CHANGED = 'Dataset Quality Dataset Details Breakdown Field Changed',
+  FAILURE_STORE_UPDATED = 'Failure Store Status Updated For A dataStream',
 }
 
 export type DatasetQualityTelemetryEvent =
@@ -132,4 +140,8 @@ export type DatasetQualityTelemetryEvent =
   | {
       eventType: DatasetQualityTelemetryEventTypes.BREAKDOWN_FIELD_CHANGED;
       schema: RootSchema<DatasetDetailsEbtProps & WithTrackingId>;
+    }
+  | {
+      eventType: DatasetQualityTelemetryEventTypes.FAILURE_STORE_UPDATED;
+      schema: RootSchema<FailureStoreUpdateEbtProps>;
     };

x-pack/platform/plugins/shared/streams_app/public/components/data_management/schema_editor/hooks/use_schema_fields.ts

@@ -12,6 +12,7 @@ import { getAdvancedParameters } from '@kbn/streams-schema';
 import { isEqual } from 'lodash';
 import { useMemo, useCallback, useState } from 'react';
 import { useAbortController, useAbortableAsync } from '@kbn/react-hooks';
+import { getStreamTypeFromDefinition } from '../../../../util/get_stream_type_from_definition';
 import { useStreamsAppFetch } from '../../../../hooks/use_streams_app_fetch';
 import { useKibana } from '../../../../hooks/use_kibana';
 import type { MappedSchemaField, SchemaField } from '../types';
@@ -35,6 +36,7 @@ export const useSchemaFields = ({
     core: {
       notifications: { toasts },
     },
+    services: { telemetryClient },
   } = useKibana();
 
   const abortController = useAbortController();
@@ -218,6 +220,10 @@ export const useSchemaFields = ({
         },
       });
 
+      telemetryClient.trackSchemaUpdated({
+        stream_type: getStreamTypeFromDefinition(definition.stream),
+      });
+
       toasts.addSuccess(
         i18n.translate('xpack.streams.streamDetailSchemaEditorEditSuccessToast', {
           defaultMessage: 'Schema was successfully modified',
@@ -234,7 +240,15 @@ export const useSchemaFields = ({
         toastLifeTimeMs: 5000,
       });
     }
-  }, [fields, streamsRepositoryClient, abortController.signal, definition, toasts, refreshFields]);
+  }, [
+    fields,
+    streamsRepositoryClient,
+    abortController.signal,
+    definition,
+    telemetryClient,
+    toasts,
+    refreshFields,
+  ]);
 
   return {
     fields,