Revert "[Upgrade Assistant] Refactor telemetry (#112177)"

x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json

@@ -7324,6 +7324,44 @@
               }
             }
           }
+        },
+        "ui_open": {
+          "properties": {
+            "elasticsearch": {
+              "type": "long",
+              "_meta": {
+                "description": "Number of times a user viewed the list of Elasticsearch deprecations."
+              }
+            },
+            "overview": {
+              "type": "long",
+              "_meta": {
+                "description": "Number of times a user viewed the Overview page."
+              }
+            },
+            "kibana": {
+              "type": "long",
+              "_meta": {
+                "description": "Number of times a user viewed the list of Kibana deprecations"
+              }
+            }
+          }
+        },
+        "ui_reindex": {
+          "properties": {
+            "close": {
+              "type": "long"
+            },
+            "open": {
+              "type": "long"
+            },
+            "start": {
+              "type": "long"
+            },
+            "stop": {
+              "type": "long"
+            }
+          }
         }
       }
     },

x-pack/plugins/upgrade_assistant/README.md

@@ -226,29 +226,4 @@ This is a non-exhaustive list of different error scenarios in Upgrade Assistant.
 - **Error updating deprecation logging status.** Mock a `404` status code to `PUT /api/upgrade_assistant/deprecation_logging`. Alternatively, edit [this line](https://github.com/elastic/kibana/blob/545c1420c285af8f5eee56f414bd6eca735aea11/x-pack/plugins/upgrade_assistant/public/application/lib/api.ts#L77) locally and replace `deprecation_logging` with `fake_deprecation_logging`.
 - **Unauthorized error fetching ES deprecations.** Mock a `403` status code to `GET /api/upgrade_assistant/es_deprecations` with the response payload: `{ "statusCode": 403 }`
 - **Partially upgraded error fetching ES deprecations.** Mock a `426` status code to `GET /api/upgrade_assistant/es_deprecations` with the response payload: `{ "statusCode": 426, "attributes": { "allNodesUpgraded": false } }`
-- **Upgraded error fetching ES deprecations.** Mock a `426` status code to `GET /api/upgrade_assistant/es_deprecations` with the response payload: `{ "statusCode": 426, "attributes": { "allNodesUpgraded": true } }` 
-
-### Telemetry
-
-The Upgrade Assistant tracks several triggered events in the UI, using Kibana Usage Collection service's [UI counters](https://github.com/elastic/kibana/blob/master/src/plugins/usage_collection/README.mdx#ui-counters).
-
-**Overview page**
-- Component loaded
-- Click event for "Create snapshot" button
-- Click event for "View deprecation logs in Observability" link
-- Click event for "Analyze logs in Discover" link
-- Click event for "Reset counter" button
-
-**ES deprecations page**
-- Component loaded
-- Click events for starting and stopping reindex tasks
-- Click events for upgrading or deleting a Machine Learning snapshot
-- Click event for deleting a deprecated index setting
-
-**Kibana deprecations page**
-- Component loaded
-- Click event for "Quick resolve" button
-
-In addition to UI counters, the Upgrade Assistant has a [custom usage collector](https://github.com/elastic/kibana/blob/master/src/plugins/usage_collection/README.mdx#custom-collector). It currently is only responsible for tracking whether the user has deprecation logging enabled or not.
-
-For testing instructions, refer to the [Kibana Usage Collection service README](https://github.com/elastic/kibana/blob/master/src/plugins/usage_collection/README.mdx#testing).
+- **Upgraded error fetching ES deprecations.** Mock a `426` status code to `GET /api/upgrade_assistant/es_deprecations` with the response payload: `{ "statusCode": 426, "attributes": { "allNodesUpgraded": true } }` 

x-pack/plugins/upgrade_assistant/common/types.ts

@@ -141,14 +141,43 @@ export interface UIReindex {
   stop: boolean;
 }
 
+export interface UpgradeAssistantTelemetrySavedObject {
+  ui_open: {
+    overview: number;
+    elasticsearch: number;
+    kibana: number;
+  };
+  ui_reindex: {
+    close: number;
+    open: number;
+    start: number;
+    stop: number;
+  };
+}
+
 export interface UpgradeAssistantTelemetry {
+  ui_open: {
+    overview: number;
+    elasticsearch: number;
+    kibana: number;
+  };
+  ui_reindex: {
+    close: number;
+    open: number;
+    start: number;
+    stop: number;
+  };
   features: {
     deprecation_logging: {
       enabled: boolean;
     };
   };
 }
 
+export interface UpgradeAssistantTelemetrySavedObjectAttributes {
+  [key: string]: any;
+}
+
 export type MIGRATION_DEPRECATION_LEVEL = 'none' | 'info' | 'warning' | 'critical';
 export interface DeprecationInfo {
   level: MIGRATION_DEPRECATION_LEVEL;

x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_types/index_settings/flyout.tsx

@@ -5,9 +5,8 @@
  * 2.0.
  */
 
-import React, { useCallback } from 'react';
+import React from 'react';
 import { i18n } from '@kbn/i18n';
-import { METRIC_TYPE } from '@kbn/analytics';
 import {
   EuiButton,
   EuiButtonEmpty,
@@ -26,7 +25,6 @@ import {
 } from '@elastic/eui';
 import { EnrichedDeprecationInfo, IndexSettingAction } from '../../../../../../common/types';
 import type { ResponseError } from '../../../../lib/api';
-import { uiMetricService, UIM_INDEX_SETTINGS_DELETE_CLICK } from '../../../../lib/ui_metric';
 import type { Status } from '../../../types';
 import { DeprecationBadge } from '../../../shared';
 
@@ -109,11 +107,6 @@ export const RemoveIndexSettingsFlyout = ({
   // Flag used to hide certain parts of the UI if the deprecation has been resolved or is in progress
   const isResolvable = ['idle', 'error'].includes(statusType);
 
-  const onRemoveSettings = useCallback(() => {
-    uiMetricService.trackUiMetric(METRIC_TYPE.CLICK, UIM_INDEX_SETTINGS_DELETE_CLICK);
-    removeIndexSettings(index!, (correctiveAction as IndexSettingAction).deprecatedSettings);
-  }, [correctiveAction, index, removeIndexSettings]);
-
   return (
     <>
       <EuiFlyoutHeader hasBorder>
@@ -197,7 +190,12 @@ export const RemoveIndexSettingsFlyout = ({
                 fill
                 data-test-subj="deleteSettingsButton"
                 color="danger"
-                onClick={onRemoveSettings}
+                onClick={() =>
+                  removeIndexSettings(
+                    index!,
+                    (correctiveAction as IndexSettingAction).deprecatedSettings
+                  )
+                }
               >
                 {statusType === 'error'
                   ? i18nTexts.retryRemoveButtonLabel

x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_types/ml_snapshots/flyout.tsx

@@ -8,7 +8,6 @@
 import React from 'react';
 import { i18n } from '@kbn/i18n';
 import { FormattedMessage } from '@kbn/i18n/react';
-import { METRIC_TYPE } from '@kbn/analytics';
 
 import {
   EuiButton,
@@ -26,11 +25,6 @@ import {
 } from '@elastic/eui';
 
 import { EnrichedDeprecationInfo } from '../../../../../../common/types';
-import {
-  uiMetricService,
-  UIM_ML_SNAPSHOT_UPGRADE_CLICK,
-  UIM_ML_SNAPSHOT_DELETE_CLICK,
-} from '../../../../lib/ui_metric';
 import { DeprecationBadge } from '../../../shared';
 import { MlSnapshotContext } from './context';
 import { useAppContext } from '../../../../app_context';
@@ -179,13 +173,11 @@ export const FixSnapshotsFlyout = ({
   const isResolved = snapshotState.status === 'complete';
 
   const onUpgradeSnapshot = () => {
-    uiMetricService.trackUiMetric(METRIC_TYPE.CLICK, UIM_ML_SNAPSHOT_UPGRADE_CLICK);
     upgradeSnapshot();
     closeFlyout();
   };
 
   const onDeleteSnapshot = () => {
-    uiMetricService.trackUiMetric(METRIC_TYPE.CLICK, UIM_ML_SNAPSHOT_DELETE_CLICK);
     deleteSnapshot();
     closeFlyout();
   };

x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_types/reindex/flyout/checklist_step.tsx

@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import React, { Fragment, useCallback } from 'react';
+import React, { Fragment } from 'react';
 
 import {
   EuiButton,
@@ -19,14 +19,8 @@ import {
   EuiTitle,
 } from '@elastic/eui';
 import { FormattedMessage } from '@kbn/i18n/react';
-import { METRIC_TYPE } from '@kbn/analytics';
 
 import { ReindexStatus } from '../../../../../../../common/types';
-import {
-  uiMetricService,
-  UIM_REINDEX_START_CLICK,
-  UIM_REINDEX_STOP_CLICK,
-} from '../../../../../lib/ui_metric';
 import { LoadingState } from '../../../../types';
 import type { ReindexState } from '../use_reindex_state';
 import { ReindexProgress } from './progress';
@@ -80,16 +74,6 @@ export const ChecklistFlyoutStep: React.FunctionComponent<{
   const hasFetchFailed = status === ReindexStatus.fetchFailed;
   const hasReindexingFailed = status === ReindexStatus.failed;
 
-  const onStartReindex = useCallback(() => {
-    uiMetricService.trackUiMetric(METRIC_TYPE.CLICK, UIM_REINDEX_START_CLICK);
-    startReindex();
-  }, [startReindex]);
-
-  const onStopReindex = useCallback(() => {
-    uiMetricService.trackUiMetric(METRIC_TYPE.CLICK, UIM_REINDEX_STOP_CLICK);
-    cancelReindex();
-  }, [cancelReindex]);
-
   return (
     <Fragment>
       <EuiFlyoutBody>
@@ -168,7 +152,7 @@ export const ChecklistFlyoutStep: React.FunctionComponent<{
             />
           </h3>
         </EuiTitle>
-        <ReindexProgress reindexState={reindexState} cancelReindex={onStopReindex} />
+        <ReindexProgress reindexState={reindexState} cancelReindex={cancelReindex} />
       </EuiFlyoutBody>
       <EuiFlyoutFooter>
         <EuiFlexGroup justifyContent="spaceBetween">
@@ -186,7 +170,7 @@ export const ChecklistFlyoutStep: React.FunctionComponent<{
                 fill
                 color={status === ReindexStatus.paused ? 'warning' : 'primary'}
                 iconType={status === ReindexStatus.paused ? 'play' : undefined}
-                onClick={onStartReindex}
+                onClick={startReindex}
                 isLoading={loading}
                 disabled={loading || !hasRequiredPrivileges}
                 data-test-subj="startReindexingButton"

x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_types/reindex/table_row.tsx

@@ -7,15 +7,9 @@
 
 import React, { useState, useEffect, useCallback } from 'react';
 import { EuiTableRowCell } from '@elastic/eui';
-import { METRIC_TYPE } from '@kbn/analytics';
 import { EnrichedDeprecationInfo } from '../../../../../../common/types';
 import { GlobalFlyout } from '../../../../../shared_imports';
 import { useAppContext } from '../../../../app_context';
-import {
-  uiMetricService,
-  UIM_REINDEX_CLOSE_FLYOUT_CLICK,
-  UIM_REINDEX_OPEN_FLYOUT_CLICK,
-} from '../../../../lib/ui_metric';
 import { DeprecationTableColumns } from '../../../types';
 import { EsDeprecationsTableCells } from '../../es_deprecations_table_cells';
 import { ReindexResolutionCell } from './resolution_table_cell';
@@ -35,15 +29,18 @@ const ReindexTableRowCells: React.FunctionComponent<TableRowProps> = ({
 }) => {
   const [showFlyout, setShowFlyout] = useState(false);
   const reindexState = useReindexContext();
+  const {
+    services: { api },
+  } = useAppContext();
 
   const { addContent: addContentToGlobalFlyout, removeContent: removeContentFromGlobalFlyout } =
     useGlobalFlyout();
 
   const closeFlyout = useCallback(async () => {
     removeContentFromGlobalFlyout('reindexFlyout');
     setShowFlyout(false);
-    uiMetricService.trackUiMetric(METRIC_TYPE.CLICK, UIM_REINDEX_CLOSE_FLYOUT_CLICK);
-  }, [removeContentFromGlobalFlyout]);
+    await api.sendReindexTelemetryData({ close: true });
+  }, [api, removeContentFromGlobalFlyout]);
 
   useEffect(() => {
     if (showFlyout) {
@@ -67,9 +64,13 @@ const ReindexTableRowCells: React.FunctionComponent<TableRowProps> = ({
 
   useEffect(() => {
     if (showFlyout) {
-      uiMetricService.trackUiMetric(METRIC_TYPE.CLICK, UIM_REINDEX_OPEN_FLYOUT_CLICK);
+      async function sendTelemetry() {
+        await api.sendReindexTelemetryData({ open: true });
+      }
+
+      sendTelemetry();
     }
-  }, [showFlyout]);
+  }, [showFlyout, api]);
 
   return (
     <>

x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/deprecation_types/reindex/use_reindex_state.tsx

@@ -132,6 +132,8 @@ export const useReindexStatus = ({ indexName, api }: { indexName: string; api: A
       cancelLoadingState: undefined,
     });
 
+    api.sendReindexTelemetryData({ start: true });
+
     const { data, error } = await api.startReindexTask(indexName);
 
     if (error) {
@@ -149,6 +151,8 @@ export const useReindexStatus = ({ indexName, api }: { indexName: string; api: A
   }, [api, indexName, reindexState, updateStatus]);
 
   const cancelReindex = useCallback(async () => {
+    api.sendReindexTelemetryData({ stop: true });
+
     const { error } = await api.cancelReindexTask(indexName);
 
     setReindexState({

x-pack/plugins/upgrade_assistant/public/application/components/es_deprecations/es_deprecations.tsx

@@ -12,12 +12,10 @@ import { EuiPageHeader, EuiSpacer, EuiPageContent, EuiLink } from '@elastic/eui'
 import { i18n } from '@kbn/i18n';
 import { FormattedMessage } from '@kbn/i18n/react';
 import { DocLinksStart } from 'kibana/public';
-import { METRIC_TYPE } from '@kbn/analytics';
 
 import { EnrichedDeprecationInfo } from '../../../../common/types';
 import { SectionLoading } from '../../../shared_imports';
 import { useAppContext } from '../../app_context';
-import { uiMetricService, UIM_ES_DEPRECATIONS_PAGE_LOAD } from '../../lib/ui_metric';
 import { getEsDeprecationError } from '../../lib/get_es_deprecation_error';
 import { DeprecationsPageLoadingError, NoDeprecationsPrompt, DeprecationCount } from '../shared';
 import { EsDeprecationsTable } from './es_deprecations_table';
@@ -84,7 +82,13 @@ export const EsDeprecations = withRouter(({ history }: RouteComponentProps) => {
     },
   } = useAppContext();
 
-  const { data: esDeprecations, isLoading, error, resendRequest } = api.useLoadEsDeprecations();
+  const {
+    data: esDeprecations,
+    isLoading,
+    error,
+    resendRequest,
+    isInitialRequest,
+  } = api.useLoadEsDeprecations();
 
   const deprecationsCountByLevel: {
     warningDeprecations: number;
@@ -99,8 +103,16 @@ export const EsDeprecations = withRouter(({ history }: RouteComponentProps) => {
   }, [breadcrumbs]);
 
   useEffect(() => {
-    uiMetricService.trackUiMetric(METRIC_TYPE.LOADED, UIM_ES_DEPRECATIONS_PAGE_LOAD);
-  }, []);
+    if (isLoading === false && isInitialRequest) {
+      async function sendTelemetryData() {
+        await api.sendPageTelemetryData({
+          elasticsearch: true,
+        });
+      }
+
+      sendTelemetryData();
+    }
+  }, [api, isLoading, isInitialRequest]);
 
   if (error) {
     return (