adds telemetry tracking to log rate analysis and log pattern analysis…

… routes

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,11 @@ 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 LOG_RATE_ANALYSIS = 'AIOpsLogRateAnalysis';
+
+export const LOG_PATTERN_ANALYSIS = 'AIOpsLogPatternAnalysis';
+
+export const CHANGE_POINT_DETECTION = 'AIOpsChangePointDetection';
+
+export const AIOPS_DEFAULT_SOURCE = 'mlAIOpsLabs';

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

@@ -31,6 +31,7 @@ import {
 } from '../log_rate_analysis_results';
 import type { GroupTableItem } from '../../log_rate_analysis_results_table/types';
 import { useLogRateAnalysisResultsTableRowContext } from '../../log_rate_analysis_results_table/log_rate_analysis_results_table_row_provider';
+import { AIOPS_DEFAULT_SOURCE } from '../../../../common/constants';
 
 const DEFAULT_SEARCH_QUERY = { match_all: {} };
 
@@ -64,6 +65,8 @@ export interface LogRateAnalysisContentProps {
   barHighlightColorOverride?: string;
   /** Optional callback that exposes data of the completed analysis */
   onAnalysisCompleted?: (d: LogRateAnalysisResultsData) => void;
+  /** Optional identifyer to indicate the plugin utilizing the component */
+  source?: string;
 }
 
 export const LogRateAnalysisContent: FC<LogRateAnalysisContentProps> = ({
@@ -76,6 +79,7 @@ export const LogRateAnalysisContent: FC<LogRateAnalysisContentProps> = ({
   barColorOverride,
   barHighlightColorOverride,
   onAnalysisCompleted,
+  source = AIOPS_DEFAULT_SOURCE,
 }) => {
   const [windowParameters, setWindowParameters] = useState<WindowParameters | undefined>();
   const [initialAnalysisStart, setInitialAnalysisStart] = useState<
@@ -172,6 +176,7 @@ export const LogRateAnalysisContent: FC<LogRateAnalysisContentProps> = ({
           barColorOverride={barColorOverride}
           barHighlightColorOverride={barHighlightColorOverride}
           onAnalysisCompleted={onAnalysisCompleted}
+          source={source}
         />
       )}
       {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 */
   isServerless?: boolean;
+  /** Optional identifyer to indicate the plugin utilizing the component */
+  source?: string;
 }
 
 export const LogRateAnalysisContentWrapper: FC<LogRateAnalysisContentWrapperProps> = ({
@@ -73,6 +75,7 @@ export const LogRateAnalysisContentWrapper: FC<LogRateAnalysisContentWrapperProp
   barHighlightColorOverride,
   onAnalysisCompleted,
   isServerless = false,
+  source,
 }) => {
   if (!dataView) return null;
 
@@ -104,6 +107,7 @@ export const LogRateAnalysisContentWrapper: FC<LogRateAnalysisContentWrapperProp
                   barColorOverride={barColorOverride}
                   barHighlightColorOverride={barHighlightColorOverride}
                   onAnalysisCompleted={onAnalysisCompleted}
+                  source={source}
                 />
               </DatePickerContextProvider>
             </StorageContextProvider>

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

@@ -113,6 +113,8 @@ interface LogRateAnalysisResultsProps {
   barHighlightColorOverride?: string;
   /** Optional callback that exposes data of the completed analysis */
   onAnalysisCompleted?: (d: LogRateAnalysisResultsData) => void;
+  /** Optional identifyer to indicate the plugin utilizing the component */
+  source?: string;
 }
 
 export const LogRateAnalysisResults: FC<LogRateAnalysisResultsProps> = ({
@@ -129,6 +131,7 @@ export const LogRateAnalysisResults: FC<LogRateAnalysisResultsProps> = ({
   barColorOverride,
   barHighlightColorOverride,
   onAnalysisCompleted,
+  source,
 }) => {
   const { http } = useAiopsAppContext();
 
@@ -198,7 +201,8 @@ export const LogRateAnalysisResults: FC<LogRateAnalysisResultsProps> = ({
       overrides,
       sampleProbability,
     },
-    { reducer: streamReducer, initialState }
+    { reducer: streamReducer, initialState },
+    { source }
   );
 
   const { significantTerms } = data;

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: source,
+      counterType: analysisType,
+      incrementBy: 1,
+    });
+  }
+}

x-pack/plugins/aiops/server/plugin.ts

@@ -9,8 +9,10 @@ import { Subscription } from 'rxjs';
 
 import { PluginInitializerContext, CoreSetup, CoreStart, Plugin, Logger } from '@kbn/core/server';
 import type { DataRequestHandlerContext } from '@kbn/data-plugin/server';
+import type { UsageCounter } from '@kbn/usage-collection-plugin/server';
 
 import { CASES_ATTACHMENT_CHANGE_POINT_CHART } from '../common/constants';
+import { PLUGIN_ID } from '../common';
 import { isActiveLicense } from './lib/license';
 import {
   AiopsLicense,
@@ -28,6 +30,7 @@ export class AiopsPlugin
 {
   private readonly logger: Logger;
   private licenseSubscription: Subscription | null = null;
+  private usageCounter?: UsageCounter;
 
   constructor(initializerContext: PluginInitializerContext) {
     this.logger = initializerContext.logger.get();
@@ -38,6 +41,7 @@ export class AiopsPlugin
     plugins: AiopsPluginSetupDeps
   ) {
     this.logger.debug('aiops: Setup');
+    this.usageCounter = plugins.usageCollection?.createUsageCounter(PLUGIN_ID);
 
     // Subscribe to license changes and store the current license in `currentLicense`.
     // This way we can pass on license changes to the route factory having always
@@ -51,8 +55,8 @@ export class AiopsPlugin
 
     // Register server side APIs
     core.getStartServices().then(([coreStart, depsStart]) => {
-      defineLogRateAnalysisRoute(router, aiopsLicense, this.logger, coreStart);
-      defineLogCategorizationRoutes(router, aiopsLicense);
+      defineLogRateAnalysisRoute(router, aiopsLicense, this.logger, coreStart, this.usageCounter);
+      defineLogCategorizationRoutes(router, aiopsLicense, this.usageCounter);
     });
 
     if (plugins.cases) {

x-pack/plugins/aiops/server/routes/log_categorization.ts

@@ -8,14 +8,18 @@
 import type { IRouter } from '@kbn/core/server';
 import type { DataRequestHandlerContext } from '@kbn/data-plugin/server';
 import { categorizationExamplesProvider } from '@kbn/ml-category-validator';
+import type { UsageCounter } from '@kbn/usage-collection-plugin/server';
 import { categorizationFieldValidationSchema } from '../../common/api/log_categorization/schema';
 import { AIOPS_API_ENDPOINT } from '../../common/api';
 import type { AiopsLicense } from '../types';
 import { wrapError } from './error_wrapper';
+import { trackAIOpsRouteUsage } from '../lib/track_route_usage';
+import { LOG_PATTERN_ANALYSIS } from '../../common/constants';
 
 export const defineLogCategorizationRoutes = (
   router: IRouter<DataRequestHandlerContext>,
-  license: AiopsLicense
+  license: AiopsLicense,
+  usageCounter?: UsageCounter
 ) => {
   router.versioned
     .post({
@@ -32,6 +36,9 @@ export const defineLogCategorizationRoutes = (
         },
       },
       async (context, request, response) => {
+        const { headers } = request;
+        trackAIOpsRouteUsage(LOG_PATTERN_ANALYSIS, headers.source, usageCounter);
+
         if (!license.isActivePlatinumLicense) {
           return response.forbidden();
         }

x-pack/plugins/aiops/server/routes/log_rate_analysis.ts

@@ -23,8 +23,9 @@ import type {
 } from '@kbn/ml-agg-utils';
 import { fetchHistogramsForFields } from '@kbn/ml-agg-utils';
 import { createExecutionContext } from '@kbn/ml-route-utils';
+import type { UsageCounter } from '@kbn/usage-collection-plugin/server';
 
-import { RANDOM_SAMPLER_SEED } from '../../common/constants';
+import { RANDOM_SAMPLER_SEED, LOG_RATE_ANALYSIS } from '../../common/constants';
 import {
   addSignificantTermsAction,
   addSignificantTermsGroupAction,
@@ -52,6 +53,7 @@ import { fetchFrequentItemSets } from './queries/fetch_frequent_item_sets';
 import { getHistogramQuery } from './queries/get_histogram_query';
 import { getGroupFilter } from './queries/get_group_filter';
 import { getSignificantTermGroups } from './queries/get_significant_term_groups';
+import { trackAIOpsRouteUsage } from '../lib/track_route_usage';
 
 // 10s ping frequency to keep the stream alive.
 const PING_FREQUENCY = 10000;
@@ -67,7 +69,8 @@ export const defineLogRateAnalysisRoute = (
   router: IRouter<DataRequestHandlerContext>,
   license: AiopsLicense,
   logger: Logger,
-  coreStart: CoreStart
+  coreStart: CoreStart,
+  usageCounter?: UsageCounter
 ) => {
   router.versioned
     .post({
@@ -85,6 +88,9 @@ export const defineLogRateAnalysisRoute = (
         },
       },
       async (context, request, response) => {
+        const { headers } = request;
+        trackAIOpsRouteUsage(LOG_RATE_ANALYSIS, headers.source, usageCounter);
+
         if (!license.isActivePlatinumLicense) {
           return response.forbidden();
         }

x-pack/plugins/aiops/server/types.ts

@@ -8,11 +8,13 @@
 import type { PluginSetup, PluginStart } from '@kbn/data-plugin/server';
 import type { LicensingPluginStart } from '@kbn/licensing-plugin/server';
 import type { CasesSetup } from '@kbn/cases-plugin/server';
+import type { UsageCollectionSetup } from '@kbn/usage-collection-plugin/server';
 
 export interface AiopsPluginSetupDeps {
   data: PluginSetup;
   licensing: LicensingPluginStart;
   cases?: CasesSetup;
+  usageCollection?: UsageCollectionSetup;
 }
 
 export interface AiopsPluginStartDeps {

x-pack/plugins/infra/public/alerting/log_threshold/components/alert_details_app_section/components/log_rate_analysis.tsx

@@ -268,6 +268,7 @@ export const LogRateAnalysis: FC<AlertDetailsLogRateAnalysisSectionProps> = ({ r
         </EuiFlexItem>
         <EuiFlexItem>
           <LogRateAnalysisContent
+            source="observability_alerts"
             dataView={dataView}
             timeRange={timeRange}
             esSearchQuery={esSearchQuery}