add analytics for ft.info

Author: arthosofteq

redisinsight/api/src/constants/telemetry-events.ts

@@ -47,11 +47,13 @@ export enum TelemetryEvents {
   CliClientDeleted = 'CLI_CLIENT_DELETED',
   CliClientRecreated = 'CLI_CLIENT_RECREATED',
   CliCommandExecuted = 'CLI_COMMAND_EXECUTED',
+  CliIndexInfoSubmitted = 'CLI_INDEX_INFO_SUBMITTED',
   CliClusterNodeCommandExecuted = 'CLI_CLUSTER_COMMAND_EXECUTED',
   CliCommandErrorReceived = 'CLI_COMMAND_ERROR_RECEIVED',
 
   // Events for workbench tool
   WorkbenchCommandExecuted = 'WORKBENCH_COMMAND_EXECUTED',
+  WorkbenchIndexInfoSubmitted = 'WORKBENCH_INDEX_INFO_SUBMITTED',
   WorkbenchCommandErrorReceived = 'WORKBENCH_COMMAND_ERROR_RECEIVED',
   WorkbenchCommandDeleted = 'WORKBENCH_COMMAND_DELETE_COMMAND',
   // Custom tutorials

redisinsight/api/src/modules/cli/services/cli-analytics/cli-analytics.service.ts

@@ -76,6 +76,23 @@ export class CliAnalyticsService extends CommandTelemetryBaseService {
     }
   }
 
+  sendIndexInfoEvent(
+    databaseId: string,
+    additionalData: object = {},
+  ): void {
+    try {
+      this.sendEvent(
+        TelemetryEvents.CliIndexInfoSubmitted,
+        {
+          databaseId,
+          ...additionalData,
+        },
+      );
+    } catch (e) {
+      // ignore error
+    }
+  }
+
   public async sendCommandExecutedEvent(
     databaseId: string,
     additionalData: object = {},

redisinsight/api/src/modules/cli/services/cli-business/cli-business.service.ts

@@ -30,10 +30,12 @@ import { DatabaseRecommendationService } from 'src/modules/database-recommendati
 import { RedisClient } from 'src/modules/redis/client';
 import { DatabaseClientFactory } from 'src/modules/database/providers/database.client.factory';
 import { v4 as uuidv4 } from 'uuid';
+import { getAnalyticsDataFromIndexInfo } from 'src/utils';
 import { OutputFormatterManager } from './output-formatter/output-formatter-manager';
 import { CliOutputFormatterTypes } from './output-formatter/output-formatter.interface';
 import { TextFormatterStrategy } from './output-formatter/strategies/text-formatter.strategy';
 import { RawFormatterStrategy } from './output-formatter/strategies/raw-formatter.strategy';
+import {inspect} from "util";
 
 @Injectable()
 export class CliBusinessService {
@@ -167,6 +169,13 @@ export class CliBusinessService {
         },
       );
 
+      if (command.toLowerCase() === 'ft.info') {
+        this.cliAnalyticsService.sendIndexInfoEvent(
+          clientMetadata.databaseId,
+          getAnalyticsDataFromIndexInfo(reply as string[]),
+        );
+      }
+
       this.logger.log('Succeed to execute redis CLI command.');
 
       return {

redisinsight/api/src/modules/redis/utils/reply.util.ts

@@ -1,4 +1,4 @@
-import { chunk } from 'lodash';
+import { chunk, isArray } from 'lodash';
 import { IRedisClusterNode } from 'src/models';
 
 /**
@@ -20,13 +20,20 @@ import { IRedisClusterNode } from 'src/models';
  * }
  * ```
  * @param input
+ * @param options
  */
-export const convertArrayReplyToObject = (input: string[]): { [key: string]: any } => chunk(
+export const convertArrayReplyToObject = (
+  input: string[],
+  options: { utf?: boolean } = {},
+): { [key: string]: any } => chunk(
   input,
   2,
 ).reduce((prev: any, current: string[]) => {
   const [key, value] = current;
-  return { ...prev, [key.toString().toLowerCase()]: value };
+  return {
+    ...prev,
+    [key.toString().toLowerCase()]: options.utf && !isArray(value) ? value?.toString() : value,
+  };
 }, {});
 
 /**

redisinsight/api/src/modules/workbench/providers/workbench-commands.executor.ts

@@ -19,6 +19,7 @@ import {
   UTF8FormatterStrategy,
 } from 'src/common/transformers';
 import { RedisClient } from 'src/modules/redis/client';
+import { getAnalyticsDataFromIndexInfo } from 'src/utils';
 import { WorkbenchAnalyticsService } from '../services/workbench-analytics/workbench-analytics.service';
 
 @Injectable()
@@ -75,6 +76,13 @@ export class WorkbenchCommandsExecutor {
         { command, rawMode: mode === RunQueryMode.Raw },
       );
 
+      if (command.toLowerCase() === 'ft.info') {
+        this.analyticsService.sendIndexInfoEvent(
+          client.clientMetadata.databaseId,
+          getAnalyticsDataFromIndexInfo(response as string[]),
+        );
+      }
+
       return result;
     } catch (error) {
       this.logger.error('Failed to execute workbench command.', error);

redisinsight/api/src/modules/workbench/services/workbench-analytics/workbench-analytics.service.ts

@@ -21,6 +21,23 @@ export class WorkbenchAnalyticsService extends CommandTelemetryBaseService {
     super(eventEmitter, commandsService);
   }
 
+  sendIndexInfoEvent(
+    databaseId: string,
+    additionalData: object = {},
+  ): void {
+    try {
+      this.sendEvent(
+        TelemetryEvents.WorkbenchIndexInfoSubmitted,
+        {
+          databaseId,
+          ...additionalData,
+        },
+      );
+    } catch (e) {
+      // ignore error
+    }
+  }
+
   public async sendCommandExecutedEvents(
     databaseId: string,
     results: IExecResult[],

redisinsight/api/src/utils/analytics-helper.ts

@@ -1,4 +1,5 @@
-import { isNil } from 'lodash';
+import { includes, isNil, map } from 'lodash';
+import { convertArrayReplyToObject } from 'src/modules/redis/utils/reply.util';
 
 export const TOTAL_KEYS_BREAKPOINTS = [
   500000,
@@ -70,3 +71,47 @@ export const calculateRedisHitRatio = (
 };
 
 export const getIsPipelineEnable = (size: number): boolean => size > 1;
+
+export const getAnalyticsDataFromIndexInfo = (reply: string[]): object => {
+  const analyticsData = {};
+
+  try {
+    const replyInfo = convertArrayReplyToObject(reply, { utf: true });
+    const definition = convertArrayReplyToObject(replyInfo.index_definition, { utf: true });
+
+    analyticsData['key_type'] = definition?.key_type;
+    analyticsData['default_score'] = definition?.default_score;
+    analyticsData['num_docs'] = replyInfo?.num_docs;
+    analyticsData['max_doc_id'] = replyInfo?.max_doc_id;
+    analyticsData['num_terms'] = replyInfo?.num_terms;
+    analyticsData['num_records'] = replyInfo?.num_records;
+    analyticsData['total_indexing_time'] = replyInfo?.total_indexing_time;
+    analyticsData['number_of_uses'] = replyInfo?.number_of_uses;
+    analyticsData['cleaning'] = replyInfo?.cleaning;
+
+    if (replyInfo.dialect_stats) {
+      analyticsData['dialect_stats'] = convertArrayReplyToObject(replyInfo.dialect_stats, { utf: true });
+    }
+
+    analyticsData['attributes'] = map(replyInfo?.attributes, ((attr) => {
+      const attrArray = map(attr, (str) => str.toString().toLowerCase());
+      const attrObject = convertArrayReplyToObject(attr, { utf: true });
+
+      return {
+        type: attrObject?.['type'],
+        weight: attrObject?.['weight'] || undefined,
+        phonetic: attrObject?.['phonetic'] || undefined,
+        sortable: includes(attrArray, 'sortable') || undefined,
+        nostem: includes(attrArray, 'nostem') || undefined,
+        unf: includes(attrArray, 'unf') || undefined,
+        noindex: includes(attrArray, 'noindex') || undefined,
+        casesensitive: includes(attrArray, 'casesensitive') || undefined,
+      };
+    }));
+
+    return analyticsData;
+  } catch (e) {
+    // ignore errors
+    return null;
+  }
+};