Merge pull request #924 from RedisInsight/fix/bulk-actions-telemetry

arthosofteq · web-flow · commit 267b96740ab2 · 2022-07-19T12:37:16.000+03:00
add telemtry for bulk actions
diff --git a/redisinsight/api/src/constants/telemetry-events.ts b/redisinsight/api/src/constants/telemetry-events.ts
@@ -51,4 +51,8 @@ export enum TelemetryEvents {
   PubSubMessagePublished = 'PUBSUB_MESSAGE_PUBLISHED',
   PubSubChannelSubscribed = 'PUBSUB_CHANNEL_SUBSCRIBED',
   PubSubChannelUnsubscribed = 'PUBSUB_CHANNEL_UNSUBSCRIBED',
+
+  // Bulk Actions
+  BulkActionsStarted = 'BULK_ACTIONS_STARTED',
+  BulkActionsStopped = 'BULK_ACTIONS_STOPPED',
 }
diff --git a/redisinsight/api/src/modules/bulk-actions/bulk-actions-analytics.service.ts b/redisinsight/api/src/modules/bulk-actions/bulk-actions-analytics.service.ts
@@ -0,0 +1,79 @@
+import { Injectable } from '@nestjs/common';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { TelemetryEvents } from 'src/constants';
+import { TelemetryBaseService } from 'src/modules/shared/services/base/telemetry.base.service';
+import { CommandExecutionStatus } from 'src/modules/cli/dto/cli.dto';
+import { RedisError, ReplyError } from 'src/models';
+import { IBulkActionOverview } from 'src/modules/bulk-actions/interfaces/bulk-action-overview.interface';
+
+export interface IExecResult {
+  response: any;
+  status: CommandExecutionStatus;
+  error?: RedisError | ReplyError | Error,
+}
+
+@Injectable()
+export class BulkActionsAnalyticsService extends TelemetryBaseService {
+  private events: Map<TelemetryEvents, Function> = new Map();
+
+  constructor(protected eventEmitter: EventEmitter2) {
+    super(eventEmitter);
+    this.events.set(TelemetryEvents.BulkActionsStarted, this.sendActionStarted.bind(this));
+    this.events.set(TelemetryEvents.BulkActionsStopped, this.sendActionStopped.bind(this));
+  }
+
+  sendActionStarted(overview: IBulkActionOverview): void {
+    try {
+      this.sendEvent(
+        TelemetryEvents.BulkActionsStarted,
+        {
+          databaseId: overview.databaseId,
+          type: overview.type,
+          duration: overview.duration,
+          filter: {
+            match: overview.filter.match === '*' ? '*' : 'PATTERN',
+            type: overview.filter.type,
+          },
+          progress: {
+            scanned: overview.progress.scanned,
+            total: overview.progress.total,
+          },
+        },
+      );
+    } catch (e) {
+      // continue regardless of error
+    }
+  }
+
+  sendActionStopped(overview: IBulkActionOverview): void {
+    try {
+      this.sendEvent(
+        TelemetryEvents.BulkActionsStopped,
+        {
+          databaseId: overview.databaseId,
+          type: overview.type,
+          duration: overview.duration,
+          filter: {
+            match: overview.filter.match === '*' ? '*' : 'PATTERN',
+            type: overview.filter.type,
+          },
+          progress: {
+            scanned: overview.progress.scanned,
+            total: overview.progress.total,
+          },
+          summary: {
+            processed: overview.summary.processed,
+            succeed: overview.summary.succeed,
+            failed: overview.summary.failed,
+          },
+        },
+      );
+    } catch (e) {
+      // continue regardless of error
+    }
+  }
+
+  getEventsEmitters(): Map<TelemetryEvents, Function> {
+    return this.events;
+  }
+}
diff --git a/redisinsight/api/src/modules/bulk-actions/bulk-actions.module.ts b/redisinsight/api/src/modules/bulk-actions/bulk-actions.module.ts
@@ -3,6 +3,7 @@ import { BulkActionsService } from 'src/modules/bulk-actions/bulk-actions.servic
 import { BulkActionsProvider } from 'src/modules/bulk-actions/providers/bulk-actions.provider';
 import { BulkActionsGateway } from 'src/modules/bulk-actions/bulk-actions.gateway';
 import { SharedModule } from 'src/modules/shared/shared.module';
+import { BulkActionsAnalyticsService } from 'src/modules/bulk-actions/bulk-actions-analytics.service';
 
 @Module({
   imports: [
@@ -12,6 +13,7 @@ import { SharedModule } from 'src/modules/shared/shared.module';
     BulkActionsGateway,
     BulkActionsService,
     BulkActionsProvider,
+    BulkActionsAnalyticsService,
   ],
 })
 export class BulkActionsModule {}
diff --git a/redisinsight/api/src/modules/bulk-actions/bulk-actions.service.spec.ts b/redisinsight/api/src/modules/bulk-actions/bulk-actions.service.spec.ts
@@ -11,6 +11,7 @@ import { CreateBulkActionDto } from 'src/modules/bulk-actions/dto/create-bulk-ac
 import { BulkActionFilter } from 'src/modules/bulk-actions/models/bulk-action-filter';
 import { BulkAction } from 'src/modules/bulk-actions/models/bulk-action';
 import { BulkActionsService } from 'src/modules/bulk-actions/bulk-actions.service';
+import { BulkActionsAnalyticsService } from 'src/modules/bulk-actions/bulk-actions-analytics.service';
 
 export const mockSocket1 = new MockedSocket();
 mockSocket1.id = '1';
@@ -38,6 +39,7 @@ const mockCreateBulkActionDto = Object.assign(new CreateBulkActionDto(), {
 
 const mockBulkAction = new BulkAction(
   mockCreateBulkActionDto.id,
+  mockCreateBulkActionDto.databaseId,
   mockCreateBulkActionDto.type,
   mockBulkActionFilter,
   mockSocket1,
@@ -65,6 +67,13 @@ describe('BulkActionsService', () => {
             abortUsersBulkActions: jest.fn().mockReturnValue(2),
           }),
         },
+        {
+          provide: BulkActionsAnalyticsService,
+          useFactory: () => ({
+            sendActionStarted: jest.fn(),
+            sendActionStopped: jest.fn(),
+          }),
+        },
       ],
     }).compile();
 
diff --git a/redisinsight/api/src/modules/bulk-actions/bulk-actions.service.ts b/redisinsight/api/src/modules/bulk-actions/bulk-actions.service.ts
@@ -1,18 +1,24 @@
+import { Socket } from 'socket.io';
 import { Injectable } from '@nestjs/common';
 import { BulkActionsProvider } from 'src/modules/bulk-actions/providers/bulk-actions.provider';
 import { CreateBulkActionDto } from 'src/modules/bulk-actions/dto/create-bulk-action.dto';
 import { BulkActionIdDto } from 'src/modules/bulk-actions/dto/bulk-action-id.dto';
-import { Socket } from 'socket.io';
+import { BulkActionsAnalyticsService } from 'src/modules/bulk-actions/bulk-actions-analytics.service';
 
 @Injectable()
 export class BulkActionsService {
   constructor(
     private readonly bulkActionsProvider: BulkActionsProvider,
+    private readonly analyticsService: BulkActionsAnalyticsService,
   ) {}
 
   async create(dto: CreateBulkActionDto, socket: Socket) {
     const bulkAction = await this.bulkActionsProvider.create(dto, socket);
-    return bulkAction.getOverview();
+    const overview = bulkAction.getOverview();
+
+    this.analyticsService.sendActionStarted(overview);
+
+    return overview;
   }
 
   async get(dto: BulkActionIdDto) {
@@ -22,7 +28,11 @@ export class BulkActionsService {
 
   async abort(dto: BulkActionIdDto) {
     const bulkAction = await this.bulkActionsProvider.abort(dto.id);
-    return bulkAction.getOverview();
+    const overview = bulkAction.getOverview();
+
+    this.analyticsService.sendActionStopped(overview);
+
+    return overview;
   }
 
   disconnect(socketId: string) {
diff --git a/redisinsight/api/src/modules/bulk-actions/interfaces/bulk-action-overview.interface.ts b/redisinsight/api/src/modules/bulk-actions/interfaces/bulk-action-overview.interface.ts
@@ -5,6 +5,7 @@ import { IBulkActionFilterOverview } from './bulk-action-filter-overview.interfa
 
 export interface IBulkActionOverview {
   id: string,
+  databaseId: string,
   duration: number,
   type: BulkActionType,
   status: BulkActionStatus,
diff --git a/redisinsight/api/src/modules/bulk-actions/models/bulk-action.spec.ts b/redisinsight/api/src/modules/bulk-actions/models/bulk-action.spec.ts
@@ -77,6 +77,7 @@ describe('AbstractBulkActionSimpleRunner', () => {
 
     bulkAction = new BulkAction(
       mockCreateBulkActionDto.id,
+      mockCreateBulkActionDto.databaseId,
       mockCreateBulkActionDto.type,
       mockBulkActionFilter,
       mockSocket,
diff --git a/redisinsight/api/src/modules/bulk-actions/models/bulk-action.ts b/redisinsight/api/src/modules/bulk-actions/models/bulk-action.ts
@@ -12,6 +12,8 @@ export class BulkAction implements IBulkAction {
 
   private readonly id: string;
 
+  private readonly databaseId: string;
+
   private startTime: number = Date.now();
 
   private endTime: number;
@@ -28,8 +30,9 @@ export class BulkAction implements IBulkAction {
 
   private readonly debounce: Function;
 
-  constructor(id, type, filter, socket) {
+  constructor(id, databaseId, type, filter, socket) {
     this.id = id;
+    this.databaseId = databaseId;
     this.type = type;
     this.filter = filter;
     this.socket = socket;
@@ -133,6 +136,7 @@ export class BulkAction implements IBulkAction {
 
     return {
       id: this.id,
+      databaseId: this.databaseId,
       type: this.type,
       duration: (this.endTime || Date.now()) - this.startTime,
       status: this.status,
diff --git a/redisinsight/api/src/modules/bulk-actions/models/runners/abstract.bulk-action.runner.spec.ts b/redisinsight/api/src/modules/bulk-actions/models/runners/abstract.bulk-action.runner.spec.ts
@@ -34,6 +34,7 @@ describe('AbstractBulkActionRunner', () => {
   beforeEach(() => {
     bulkAction = new BulkAction(
       mockCreateBulkActionDto.id,
+      mockCreateBulkActionDto.databaseId,
       mockCreateBulkActionDto.type,
       mockBulkActionFilter,
       mockSocket,
diff --git a/redisinsight/api/src/modules/bulk-actions/models/runners/simple/abstract.bulk-action.simple.runner.spec.ts b/redisinsight/api/src/modules/bulk-actions/models/runners/simple/abstract.bulk-action.simple.runner.spec.ts
@@ -43,6 +43,7 @@ describe('AbstractBulkActionSimpleRunner', () => {
 
     bulkAction = new BulkAction(
       mockCreateBulkActionDto.id,
+      mockCreateBulkActionDto.databaseId,
       mockCreateBulkActionDto.type,
       mockBulkActionFilter,
       mockSocket,
diff --git a/redisinsight/api/src/modules/bulk-actions/models/runners/simple/delete.bulk-action.simple.runner.spec.ts b/redisinsight/api/src/modules/bulk-actions/models/runners/simple/delete.bulk-action.simple.runner.spec.ts
@@ -25,6 +25,7 @@ const mockCreateBulkActionDto = {
 
 const bulkAction = new BulkAction(
   mockCreateBulkActionDto.id,
+  mockCreateBulkActionDto.databaseId,
   mockCreateBulkActionDto.type,
   mockBulkActionFilter,
   mockSocket,
diff --git a/redisinsight/api/src/modules/bulk-actions/providers/bulk-actions.provider.ts b/redisinsight/api/src/modules/bulk-actions/providers/bulk-actions.provider.ts
@@ -33,7 +33,7 @@ export class BulkActionsProvider {
       throw new Error('You already have bulk action with such id');
     }
 
-    const bulkAction = new BulkAction(dto.id, dto.type, dto.filter, socket);
+    const bulkAction = new BulkAction(dto.id, dto.databaseId, dto.type, dto.filter, socket);
 
     this.bulkActions.set(dto.id, bulkAction);
 

Original file line number	Diff line number	Diff line change
`@@ -51,4 +51,8 @@ export enum TelemetryEvents {`
`51`	`51`	`PubSubMessagePublished = 'PUBSUB_MESSAGE_PUBLISHED',`
`52`	`52`	`PubSubChannelSubscribed = 'PUBSUB_CHANNEL_SUBSCRIBED',`
`53`	`53`	`PubSubChannelUnsubscribed = 'PUBSUB_CHANNEL_UNSUBSCRIBED',`
	`54`	`+`
	`55`	`+ // Bulk Actions`
	`56`	`+ BulkActionsStarted = 'BULK_ACTIONS_STARTED',`
	`57`	`+ BulkActionsStopped = 'BULK_ACTIONS_STOPPED',`
`54`	`58`	`}`