[ML][AIOps] Telemetry: track analysis endpoint usage

x-pack/packages/ml/response_stream/client/fetch_stream.ts

@@ -8,7 +8,7 @@
 import startsWith from 'lodash/startsWith';
 import type { Reducer, ReducerAction } from 'react';
 
-import type { HttpSetup } from '@kbn/core/public';
+import type { HttpSetup, HttpFetchOptions } from '@kbn/core/public';
 
 type GeneratorError = string | null;
 
@@ -42,7 +42,8 @@ export async function* fetchStream<B extends object, R extends Reducer<any, any>
   apiVersion: string | undefined,
   abortCtrl: React.MutableRefObject<AbortController>,
   body?: B,
-  ndjson = true
+  ndjson = true,
+  headers?: HttpFetchOptions['headers']
 ): AsyncGenerator<[GeneratorError, ReducerAction<R> | Array<ReducerAction<R>> | undefined]> {
   let stream: Readonly<Response> | undefined;
 
@@ -52,6 +53,7 @@ export async function* fetchStream<B extends object, R extends Reducer<any, any>
       version: apiVersion,
       asResponse: true,
       rawResponse: true,
+      headers,
       ...(body && Object.keys(body).length > 0 ? { body: JSON.stringify(body) } : {}),
     });
 

x-pack/packages/ml/response_stream/client/use_fetch_stream.ts

@@ -16,7 +16,7 @@ import {
 } from 'react';
 import useThrottle from 'react-use/lib/useThrottle';
 
-import type { HttpSetup } from '@kbn/core/public';
+import type { HttpSetup, HttpFetchOptions } from '@kbn/core/public';
 import { isPopulatedObject } from '@kbn/ml-is-populated-object';
 
 import { fetchStream } from './fetch_stream';
@@ -64,7 +64,8 @@ export function useFetchStream<B extends object, R extends Reducer<any, any>>(
   endpoint: string,
   apiVersion?: string,
   body?: B,
-  customReducer?: FetchStreamCustomReducer<R>
+  customReducer?: FetchStreamCustomReducer<R>,
+  headers?: HttpFetchOptions['headers']
 ) {
   const [errors, setErrors] = useState<string[]>([]);
   const [isCancelled, setIsCancelled] = useState(false);
@@ -104,7 +105,8 @@ export function useFetchStream<B extends object, R extends Reducer<any, any>>(
       apiVersion,
       abortCtrl,
       body,
-      customReducer !== undefined
+      customReducer !== undefined,
+      headers
     )) {
       if (fetchStreamError !== null) {
         addError(fetchStreamError);

x-pack/plugins/aiops/common/constants.ts

@@ -19,3 +19,8 @@ export const RANDOM_SAMPLER_SEED = 3867412;
 export const CASES_ATTACHMENT_CHANGE_POINT_CHART = 'aiopsChangePointChart';
 
 export const EMBEDDABLE_CHANGE_POINT_CHART_TYPE = 'aiopsChangePointChart' as const;
+
+export const AIOPS_TELEMETRY_ID = {
+  AIOPS_DEFAULT_SOURCE: 'ml_aiops_labs',
+  AIOPS_ANALYSIS_RUN_ORIGIN: 'aiops-analysis-run-origin',
+} as const;

x-pack/plugins/aiops/kibana.jsonc

@@ -20,7 +20,8 @@
       "unifiedSearch"
     ],
     "optionalPlugins": [
-      "cases"
+      "cases",
+      "usageCollection"
     ],
     "requiredBundles": [
       "fieldFormats",

x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx

@@ -15,6 +15,7 @@ import { Storage } from '@kbn/kibana-utils-plugin/public';
 import { DatePickerContextProvider, type DatePickerDependencies } from '@kbn/ml-date-picker';
 import { UI_SETTINGS } from '@kbn/data-plugin/common';
 
+import { AIOPS_TELEMETRY_ID } from '../../../common/constants';
 import { DataSourceContext } from '../../hooks/use_data_source';
 import type { AiopsAppDependencies } from '../../hooks/use_aiops_app_context';
 import { AIOPS_STORAGE_KEYS } from '../../types/storage';
@@ -65,7 +66,7 @@ export const LogCategorizationAppState: FC<LogCategorizationAppStateProps> = ({
         <DataSourceContext.Provider value={{ dataView, savedSearch }}>
           <StorageContextProvider storage={localStorage} storageKeys={AIOPS_STORAGE_KEYS}>
             <DatePickerContextProvider {...datePickerDeps}>
-              <LogCategorizationPage />
+              <LogCategorizationPage embeddingOrigin={AIOPS_TELEMETRY_ID.AIOPS_DEFAULT_SOURCE} />
             </DatePickerContextProvider>
           </StorageContextProvider>
         </DataSourceContext.Provider>

x-pack/plugins/aiops/public/components/log_categorization/log_categorization_for_flyout.tsx

@@ -22,6 +22,7 @@ import { buildEmptyFilter, Filter } from '@kbn/es-query';
 
 import { usePageUrlState } from '@kbn/ml-url-state';
 import type { FieldValidationResults } from '@kbn/ml-category-validator';
+import { AIOPS_TELEMETRY_ID } from '../../../common/constants';
 import { useData } from '../../hooks/use_data';
 import { useSearch } from '../../hooks/use_search';
 import { useCategorizeRequest } from './use_categorize_request';
@@ -45,6 +46,8 @@ export interface LogCategorizationPageProps {
   savedSearch: SavedSearch | null;
   selectedField: DataViewField;
   onClose: () => void;
+  /** Identifier to indicate the plugin utilizing the component */
+  embeddingOrigin: string;
 }
 
 const BAR_TARGET = 20;
@@ -54,6 +57,7 @@ export const LogCategorizationFlyout: FC<LogCategorizationPageProps> = ({
   savedSearch,
   selectedField,
   onClose,
+  embeddingOrigin,
 }) => {
   const {
     notifications: { toasts },
@@ -147,7 +151,8 @@ export const LogCategorizationFlyout: FC<LogCategorizationPageProps> = ({
           timeField,
           earliest,
           latest,
-          searchQuery
+          searchQuery,
+          { [AIOPS_TELEMETRY_ID.AIOPS_ANALYSIS_RUN_ORIGIN]: embeddingOrigin }
         ),
         runCategorizeRequest(
           index,
@@ -189,6 +194,7 @@ export const LogCategorizationFlyout: FC<LogCategorizationPageProps> = ({
     runCategorizeRequest,
     intervalMs,
     toasts,
+    embeddingOrigin,
   ]);
 
   const onAddFilter = useCallback(

x-pack/plugins/aiops/public/components/log_categorization/log_categorization_page.tsx

@@ -27,6 +27,7 @@ import { usePageUrlState, useUrlState } from '@kbn/ml-url-state';
 
 import type { FieldValidationResults } from '@kbn/ml-category-validator';
 import type { SearchQueryLanguage } from '@kbn/ml-query-utils';
+import { AIOPS_TELEMETRY_ID } from '../../../common/constants';
 import { useDataSource } from '../../hooks/use_data_source';
 import { useData } from '../../hooks/use_data';
 import { useSearch } from '../../hooks/use_search';
@@ -51,7 +52,12 @@ import { FieldValidationCallout } from './category_validation_callout';
 const BAR_TARGET = 20;
 const DEFAULT_SELECTED_FIELD = 'message';
 
-export const LogCategorizationPage: FC = () => {
+interface LogCategorizationPageProps {
+  /** Identifier to indicate the plugin utilizing the component */
+  embeddingOrigin: string;
+}
+
+export const LogCategorizationPage: FC<LogCategorizationPageProps> = ({ embeddingOrigin }) => {
   const {
     notifications: { toasts },
   } = useAiopsAppContext();
@@ -206,7 +212,10 @@ export const LogCategorizationPage: FC = () => {
 
     try {
       const [validationResult, categorizationResult] = await Promise.all([
-        runValidateFieldRequest(index, selectedField, timeField, earliest, latest, searchQuery),
+        runValidateFieldRequest(index, selectedField, timeField, earliest, latest, searchQuery, {
+          [AIOPS_TELEMETRY_ID.AIOPS_ANALYSIS_RUN_ORIGIN]: embeddingOrigin,
+        }),
+
         runCategorizeRequest(
           index,
           selectedField,
@@ -243,6 +252,7 @@ export const LogCategorizationPage: FC = () => {
     runCategorizeRequest,
     intervalMs,
     toasts,
+    embeddingOrigin,
   ]);
 
   useEffect(

x-pack/plugins/aiops/public/components/log_categorization/show_flyout.tsx

@@ -70,6 +70,7 @@ export async function showCategorizeFlyout(
                     savedSearch={null}
                     selectedField={field}
                     onClose={onFlyoutClose}
+                    embeddingOrigin={'discover_run_pattern_analysis'}
                   />
                 </StorageContextProvider>
               </DatePickerContextProvider>

x-pack/plugins/aiops/public/components/log_categorization/use_validate_category_field.ts

@@ -9,6 +9,7 @@ import { useRef, useCallback } from 'react';
 
 import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types';
 import type { FieldValidationResults } from '@kbn/ml-category-validator';
+import type { HttpFetchOptions } from '@kbn/core/public';
 import { AIOPS_API_ENDPOINT } from '../../../common/api';
 import { useAiopsAppContext } from '../../hooks/use_aiops_app_context';
 import { createCategorizeQuery } from './use_categorize_request';
@@ -24,7 +25,8 @@ export function useValidateFieldRequest() {
       timeField: string,
       start: number | undefined,
       end: number | undefined,
-      queryIn: QueryDslQueryContainer
+      queryIn: QueryDslQueryContainer,
+      headers?: HttpFetchOptions['headers']
     ) => {
       const query = createCategorizeQuery(queryIn, timeField, start, end);
       const resp = await http.post<FieldValidationResults>(
@@ -45,6 +47,7 @@ export function useValidateFieldRequest() {
             indicesOptions: undefined,
             includeExamples: false,
           }),
+          headers,
           version: '1',
         }
       );

x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content.tsx

@@ -64,6 +64,8 @@ export interface LogRateAnalysisContentProps {
   barHighlightColorOverride?: string;
   /** Optional callback that exposes data of the completed analysis */
   onAnalysisCompleted?: (d: LogRateAnalysisResultsData) => void;
+  /** Identifier to indicate the plugin utilizing the component */
+  embeddingOrigin: string;
 }
 
 export const LogRateAnalysisContent: FC<LogRateAnalysisContentProps> = ({
@@ -76,6 +78,7 @@ export const LogRateAnalysisContent: FC<LogRateAnalysisContentProps> = ({
   barColorOverride,
   barHighlightColorOverride,
   onAnalysisCompleted,
+  embeddingOrigin,
 }) => {
   const [windowParameters, setWindowParameters] = useState<WindowParameters | undefined>();
   const [initialAnalysisStart, setInitialAnalysisStart] = useState<
@@ -172,6 +175,7 @@ export const LogRateAnalysisContent: FC<LogRateAnalysisContentProps> = ({
           barColorOverride={barColorOverride}
           barHighlightColorOverride={barHighlightColorOverride}
           onAnalysisCompleted={onAnalysisCompleted}
+          embeddingOrigin={embeddingOrigin}
         />
       )}
       {windowParameters === undefined && (

x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_content/log_rate_analysis_content_wrapper.tsx

@@ -59,6 +59,8 @@ export interface LogRateAnalysisContentWrapperProps {
   onAnalysisCompleted?: (d: LogRateAnalysisResultsData) => void;
   /** Optional flag to indicate whether kibana is running in serverless */
   showFrozenDataTierChoice?: boolean;
+  /** Identifier to indicate the plugin utilizing the component */
+  embeddingOrigin: string;
 }
 
 export const LogRateAnalysisContentWrapper: FC<LogRateAnalysisContentWrapperProps> = ({
@@ -73,6 +75,7 @@ export const LogRateAnalysisContentWrapper: FC<LogRateAnalysisContentWrapperProp
   barHighlightColorOverride,
   onAnalysisCompleted,
   showFrozenDataTierChoice = true,
+  embeddingOrigin,
 }) => {
   if (!dataView) return null;
 
@@ -105,6 +108,7 @@ export const LogRateAnalysisContentWrapper: FC<LogRateAnalysisContentWrapperProp
                   barColorOverride={barColorOverride}
                   barHighlightColorOverride={barHighlightColorOverride}
                   onAnalysisCompleted={onAnalysisCompleted}
+                  embeddingOrigin={embeddingOrigin}
                 />
               </DatePickerContextProvider>
             </StorageContextProvider>

x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_page.tsx

@@ -22,6 +22,7 @@ import {
   getDefaultAiOpsListState,
   type AiOpsPageUrlState,
 } from '../../application/utils/url_state';
+import { AIOPS_TELEMETRY_ID } from '../../../common/constants';
 
 import { SearchPanel } from '../search_panel';
 import { useLogRateAnalysisResultsTableRowContext } from '../log_rate_analysis_results_table/log_rate_analysis_results_table_row_provider';
@@ -151,6 +152,7 @@ export const LogRateAnalysisPage: FC<Props> = ({ stickyHistogram }) => {
             setGlobalState={setGlobalState}
             esSearchQuery={searchQuery}
             stickyHistogram={stickyHistogram}
+            embeddingOrigin={AIOPS_TELEMETRY_ID.AIOPS_DEFAULT_SOURCE}
           />
         </EuiFlexGroup>
       </EuiPageSection>

x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx

@@ -36,6 +36,7 @@ import type { SignificantTerm, SignificantTermGroup } from '@kbn/ml-agg-utils';
 import { useAiopsAppContext } from '../../hooks/use_aiops_app_context';
 import { initialState, streamReducer } from '../../../common/api/stream_reducer';
 import type { AiopsApiLogRateAnalysis } from '../../../common/api';
+import { AIOPS_TELEMETRY_ID } from '../../../common/constants';
 import {
   getGroupTableItems,
   LogRateAnalysisResultsTable,
@@ -113,6 +114,8 @@ interface LogRateAnalysisResultsProps {
   barHighlightColorOverride?: string;
   /** Optional callback that exposes data of the completed analysis */
   onAnalysisCompleted?: (d: LogRateAnalysisResultsData) => void;
+  /** Identifier to indicate the plugin utilizing the component */
+  embeddingOrigin: string;
 }
 
 export const LogRateAnalysisResults: FC<LogRateAnalysisResultsProps> = ({
@@ -129,6 +132,7 @@ export const LogRateAnalysisResults: FC<LogRateAnalysisResultsProps> = ({
   barColorOverride,
   barHighlightColorOverride,
   onAnalysisCompleted,
+  embeddingOrigin,
 }) => {
   const { http } = useAiopsAppContext();
 
@@ -198,7 +202,8 @@ export const LogRateAnalysisResults: FC<LogRateAnalysisResultsProps> = ({
       overrides,
       sampleProbability,
     },
-    { reducer: streamReducer, initialState }
+    { reducer: streamReducer, initialState },
+    { [AIOPS_TELEMETRY_ID.AIOPS_ANALYSIS_RUN_ORIGIN]: embeddingOrigin }
   );
 
   const { significantTerms } = data;

x-pack/plugins/aiops/server/lib/track_route_usage.test.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+import { usageCountersServiceMock } from '@kbn/usage-collection-plugin/server/usage_counters/usage_counters_service.mock';
+import { trackAIOpsRouteUsage } from './track_route_usage';
+
+describe('trackAIOpsRouteUsage', () => {
+  it('should call `usageCounter.incrementCounter`', () => {
+    const mockUsageCountersSetup = usageCountersServiceMock.createSetupContract();
+    const mockUsageCounter = mockUsageCountersSetup.createUsageCounter('test');
+
+    trackAIOpsRouteUsage('test_type', 'test_source', mockUsageCounter);
+    expect(mockUsageCounter.incrementCounter).toHaveBeenCalledWith({
+      counterName: 'test_type',
+      counterType: 'run_via_test_source',
+      incrementBy: 1,
+    });
+  });
+
+  it('should do nothing if no usage counter is provided', () => {
+    let err;
+    try {
+      trackAIOpsRouteUsage('test', undefined);
+    } catch (e) {
+      err = e;
+    }
+    expect(err).toBeUndefined();
+  });
+});

x-pack/plugins/aiops/server/lib/track_route_usage.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { UsageCounter } from '@kbn/usage-collection-plugin/server';
+
+export function trackAIOpsRouteUsage(
+  analysisType: string,
+  source?: string | string[],
+  usageCounter?: UsageCounter
+) {
+  if (usageCounter && typeof source === 'string') {
+    usageCounter.incrementCounter({
+      counterName: analysisType,
+      counterType: `run_via_${source}`,
+      incrementBy: 1,
+    });
+  }
+}