Enabling UI Metric Collector (opensearch-project#6203)

Signed-off-by: Suchit Sahoo <[email protected]>

CHANGELOG.md

@@ -108,6 +108,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Workspace] Add workspaces filter to saved objects page. ([#6458](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6458))
 - [Multiple Datasource] Support multi data source in Region map ([#6654](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6654))
 - Add `rightNavigationButton` component in chrome service for applications to register and add dev tool to top right navigation. ([#6553](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6553))
+- Enable UI Metric Collector to collect UI Metrics and Application Usage ([#6203](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6203))
 
 ### 🐛 Bug Fixes
 

config/opensearch_dashboards.yml

@@ -313,3 +313,7 @@
 
 # Set the value to true to enable workspace feature
 # workspace.enabled: false
+
+# Set the value to true to enable Ui Metric Collectors in Usage Collector
+# This publishes the Application Usage and UI Metrics into the saved object, which can be accessed by /api/stats?extended=true&legacy=true&exclude_usage=false
+# usageCollection.uiMetric.enabled: false

packages/osd-analytics/src/reporter.ts

@@ -36,7 +36,7 @@ import { Report, ReportManager } from './report';
 import { ApplicationUsage } from './metrics';
 
 export interface ReporterConfig {
-  // http: ReportHTTP;
+  http: ReportHTTP;
   storage?: Storage;
   checkInterval?: number;
   debug?: boolean;
@@ -49,7 +49,7 @@ export class Reporter {
   checkInterval: number;
   private interval?: NodeJS.Timer;
   private lastAppId?: string;
-  // private http: ReportHTTP;
+  private http: ReportHTTP;
   private reportManager: ReportManager;
   private storageManager: ReportStorageManager;
   private readonly applicationUsage: ApplicationUsage;
@@ -59,8 +59,8 @@ export class Reporter {
   private started = false;
 
   constructor(config: ReporterConfig) {
-    const { storage, debug, checkInterval = 90000, storageKey = 'analytics' } = config;
-    // this.http = http;
+    const { http, storage, debug, checkInterval = 90000, storageKey = 'analytics' } = config;
+    this.http = http;
     this.checkInterval = checkInterval;
     this.applicationUsage = new ApplicationUsage();
     this.storageManager = new ReportStorageManager(storageKey, storage);
@@ -144,14 +144,14 @@ export class Reporter {
   public reportApplicationUsage(appId?: string) {
     this.log(`Reporting application changed to ${appId}`);
     this.lastAppId = appId || this.lastAppId;
-    // const appChangedReport = this.applicationUsage.appChanged(appId);
-    // if (appChangedReport) this.saveToReport([appChangedReport]);
+    const appChangedReport = this.applicationUsage.appChanged(appId);
+    if (appChangedReport) this.saveToReport([appChangedReport]);
   }
 
   public sendReports = async () => {
     if (!this.reportManager.isReportEmpty()) {
       try {
-        // await this.http(this.reportManager.report);
+        await this.http(this.reportManager.report);
         this.flushReport();
       } catch (err) {
         this.log(`Error Sending Metrics Report ${err}`);

src/plugins/usage_collection/public/services/create_reporter.ts

@@ -38,20 +38,20 @@ interface AnalyicsReporterConfig {
 }
 
 export function createReporter(config: AnalyicsReporterConfig): Reporter {
-  const { localStorage, debug } = config;
+  const { localStorage, debug, fetch } = config;
 
   return new Reporter({
     debug,
     storage: localStorage,
-    // async http(report) {
-    //   const response = await fetch.post('/api/ui_metric/report', {
-    //     body: JSON.stringify({ report }),
-    //   });
+    async http(report) {
+      const response = await fetch.post('/api/ui_metric/report', {
+        body: JSON.stringify({ report }),
+      });
 
-    //   if (response.status !== 'ok') {
-    //     throw Error('Unable to store report.');
-    //   }
-    //   return response;
-    // },
+      if (response.status !== 'ok') {
+        throw Error('Unable to store report.');
+      }
+      return response;
+    },
   });
 }

src/plugins/usage_collection/server/config.ts

@@ -34,7 +34,7 @@ import { DEFAULT_MAXIMUM_WAIT_TIME_FOR_ALL_COLLECTORS_IN_S } from '../common/con
 
 export const configSchema = schema.object({
   uiMetric: schema.object({
-    enabled: schema.boolean({ defaultValue: true }),
+    enabled: schema.boolean({ defaultValue: false }),
     debug: schema.boolean({ defaultValue: schema.contextRef('dev') }),
   }),
   maximumWaitTimeForAllCollectorsInS: schema.number({

src/plugins/usage_collection/server/routes/report_metrics.ts

@@ -28,15 +28,14 @@
  * under the License.
  */
 
-// import { schema } from '@osd/config-schema';
+import { schema } from '@osd/config-schema';
 import { IRouter, ISavedObjectsRepository } from 'opensearch-dashboards/server';
-// import { storeReport, reportSchema } from '../report';
+import { storeReport, reportSchema } from '../report';
 
 export function registerUiMetricRoute(
   router: IRouter,
   getSavedObjects: () => ISavedObjectsRepository | undefined
 ) {
-  /*
   router.post(
     {
       path: '/api/ui_metric/report',
@@ -59,5 +58,5 @@ export function registerUiMetricRoute(
         return res.ok({ body: { status: 'fail' } });
       }
     }
-  );*/
+  );
 }

src/plugins/vis_type_vega/server/types.ts

@@ -33,7 +33,7 @@ import { DataSourcePluginSetup } from 'src/plugins/data_source/server';
 import { HomeServerPluginSetup } from '../../home/server';
 import { UsageCollectionSetup } from '../../usage_collection/server';
 
-export type ConfigObservable = Observable<{ kibana: { index: string } }>;
+export type ConfigObservable = Observable<{ opensearchDashboards: { index: string } }>;
 
 export interface VegaSavedObjectAttributes {
   title: string;

src/plugins/vis_type_vega/server/usage_collector/get_usage_collector.test.ts

@@ -87,7 +87,7 @@ const getMockCallCluster = (hits?: unknown[]) =>
   jest.fn().mockReturnValue(Promise.resolve({ hits: { hits } }) as unknown) as LegacyAPICaller;
 
 describe('Vega visualization usage collector', () => {
-  const configMock = of({ kibana: { index: '' } });
+  const configMock = of({ opensearchDashboards: { index: '' } });
   const usageCollector = getUsageCollector(configMock, {
     home: ({
       sampleData: {

src/plugins/vis_type_vega/server/usage_collector/get_usage_collector.ts

@@ -151,7 +151,7 @@ export function getUsageCollector(
     type: VEGA_USAGE_TYPE,
     isReady: () => true,
     fetch: async (callCluster: LegacyAPICaller) => {
-      const { index } = (await config.pipe(first()).toPromise()).kibana;
+      const { index } = (await config.pipe(first()).toPromise()).opensearchDashboards;
 
       return await getStats(callCluster, index, dependencies);
     },