#RI-4530 Add telemetry

Author: Artem

redisinsight/api/src/modules/cloud/autodiscovery/cloud-autodicovery.analytics.spec.ts

@@ -3,8 +3,12 @@ import { EventEmitter2 } from '@nestjs/event-emitter';
 import { TelemetryEvents } from 'src/constants';
 import { InternalServerErrorException } from '@nestjs/common';
 import { CloudAutodiscoveryAnalytics } from 'src/modules/cloud/autodiscovery/cloud-autodiscovery.analytics';
-import { CloudDatabaseStatus, CloudSubscriptionStatus } from 'src/modules/cloud/autodiscovery/models';
-import { mockCloudDatabase, mockCloudSubscription } from 'src/__mocks__';
+import {
+  CloudDatabaseStatus,
+  CloudSubscriptionStatus,
+  CloudSubscriptionType
+} from 'src/modules/cloud/autodiscovery/models';
+import { mockCloudDatabase, mockCloudDatabaseFixed, mockCloudSubscription } from 'src/__mocks__';
 
 describe('CloudAutodiscoveryAnalytics', () => {
   let service: CloudAutodiscoveryAnalytics;
@@ -36,13 +40,14 @@ describe('CloudAutodiscoveryAnalytics', () => {
       service.sendGetRECloudSubsSucceedEvent([
         mockCloudSubscription,
         mockCloudSubscription,
-      ]);
+      ], CloudSubscriptionType.Flexible);
 
       expect(sendEventMethod).toHaveBeenCalledWith(
         TelemetryEvents.RECloudSubscriptionsDiscoverySucceed,
         {
           numberOfActiveSubscriptions: 2,
           totalNumberOfSubscriptions: 2,
+          type: CloudSubscriptionType.Flexible,
         },
       );
     });
@@ -53,13 +58,14 @@ describe('CloudAutodiscoveryAnalytics', () => {
           status: CloudSubscriptionStatus.Error,
         },
         mockCloudSubscription,
-      ]);
+      ], CloudSubscriptionType.Flexible);
 
       expect(sendEventMethod).toHaveBeenCalledWith(
         TelemetryEvents.RECloudSubscriptionsDiscoverySucceed,
         {
           numberOfActiveSubscriptions: 1,
           totalNumberOfSubscriptions: 2,
+          type: CloudSubscriptionType.Flexible,
         },
       );
     });
@@ -73,52 +79,56 @@ describe('CloudAutodiscoveryAnalytics', () => {
           ...mockCloudSubscription,
           status: CloudSubscriptionStatus.Error,
         },
-      ]);
+      ], CloudSubscriptionType.Flexible);
       expect(sendEventMethod).toHaveBeenCalledWith(
         TelemetryEvents.RECloudSubscriptionsDiscoverySucceed,
         {
           numberOfActiveSubscriptions: 0,
           totalNumberOfSubscriptions: 2,
+          type: CloudSubscriptionType.Flexible,
         },
       );
     });
     it('should emit GetRECloudSubsSucceedEvent event for empty list', () => {
-      service.sendGetRECloudSubsSucceedEvent([]);
+      service.sendGetRECloudSubsSucceedEvent([], CloudSubscriptionType.Flexible);
 
       expect(sendEventMethod).toHaveBeenCalledWith(
         TelemetryEvents.RECloudSubscriptionsDiscoverySucceed,
         {
           numberOfActiveSubscriptions: 0,
           totalNumberOfSubscriptions: 0,
+          type: CloudSubscriptionType.Flexible,
         },
       );
     });
     it('should emit GetRECloudSubsSucceedEvent event for undefined input value', () => {
-      service.sendGetRECloudSubsSucceedEvent(undefined);
+      service.sendGetRECloudSubsSucceedEvent(undefined, CloudSubscriptionType.Fixed);
 
       expect(sendEventMethod).toHaveBeenCalledWith(
         TelemetryEvents.RECloudSubscriptionsDiscoverySucceed,
         {
           numberOfActiveSubscriptions: 0,
           totalNumberOfSubscriptions: 0,
+          type: CloudSubscriptionType.Fixed,
         },
       );
     });
     it('should not throw on error when sending GetRECloudSubsSucceedEvent event', () => {
       const input: any = {};
 
-      expect(() => service.sendGetRECloudSubsSucceedEvent(input)).not.toThrow();
+      expect(() => service.sendGetRECloudSubsSucceedEvent(input, CloudSubscriptionType.Flexible)).not.toThrow();
       expect(sendEventMethod).not.toHaveBeenCalled();
     });
   });
 
   describe('sendGetRECloudSubsFailedEvent', () => {
     it('should emit GetRECloudSubsFailedEvent event', () => {
-      service.sendGetRECloudSubsFailedEvent(httpException);
+      service.sendGetRECloudSubsFailedEvent(httpException, CloudSubscriptionType.Fixed);
 
       expect(sendFailedEventMethod).toHaveBeenCalledWith(
         TelemetryEvents.RECloudSubscriptionsDiscoveryFailed,
         httpException,
+        { type: CloudSubscriptionType.Fixed },
       );
     });
   });
@@ -127,14 +137,16 @@ describe('CloudAutodiscoveryAnalytics', () => {
     it('should emit event with active databases', () => {
       service.sendGetRECloudDbsSucceedEvent([
         mockCloudDatabase,
-        mockCloudDatabase,
+        mockCloudDatabaseFixed,
       ]);
 
       expect(sendEventMethod).toHaveBeenCalledWith(
         TelemetryEvents.RECloudDatabasesDiscoverySucceed,
         {
           numberOfActiveDatabases: 2,
           totalNumberOfDatabases: 2,
+          fixed: 1,
+          flexible: 1,
         },
       );
     });
@@ -152,6 +164,8 @@ describe('CloudAutodiscoveryAnalytics', () => {
         {
           numberOfActiveDatabases: 1,
           totalNumberOfDatabases: 2,
+          fixed: 0,
+          flexible: 2,
         },
       );
     });
@@ -168,6 +182,8 @@ describe('CloudAutodiscoveryAnalytics', () => {
         {
           numberOfActiveDatabases: 0,
           totalNumberOfDatabases: 1,
+          fixed: 0,
+          flexible: 1,
         },
       );
     });
@@ -179,6 +195,8 @@ describe('CloudAutodiscoveryAnalytics', () => {
         {
           numberOfActiveDatabases: 0,
           totalNumberOfDatabases: 0,
+          fixed: 0,
+          flexible: 0,
         },
       );
     });
@@ -190,6 +208,8 @@ describe('CloudAutodiscoveryAnalytics', () => {
         {
           numberOfActiveDatabases: 0,
           totalNumberOfDatabases: 0,
+          fixed: 0,
+          flexible: 0,
         },
       );
     });

redisinsight/api/src/modules/cloud/autodiscovery/cloud-autodiscovery.analytics.ts

@@ -1,3 +1,4 @@
+import { countBy } from 'lodash';
 import { HttpException, Injectable } from '@nestjs/common';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import { TelemetryEvents } from 'src/constants';
@@ -6,7 +7,7 @@ import {
   CloudDatabase,
   CloudDatabaseStatus,
   CloudSubscription,
-  CloudSubscriptionStatus,
+  CloudSubscriptionStatus, CloudSubscriptionType,
 } from 'src/modules/cloud/autodiscovery/models';
 
 @Injectable()
@@ -15,7 +16,7 @@ export class CloudAutodiscoveryAnalytics extends TelemetryBaseService {
     super(eventEmitter);
   }
 
-  sendGetRECloudSubsSucceedEvent(subscriptions: CloudSubscription[] = []) {
+  sendGetRECloudSubsSucceedEvent(subscriptions: CloudSubscription[] = [], type: CloudSubscriptionType) {
     try {
       this.sendEvent(
         TelemetryEvents.RECloudSubscriptionsDiscoverySucceed,
@@ -24,15 +25,16 @@ export class CloudAutodiscoveryAnalytics extends TelemetryBaseService {
             (sub) => sub.status === CloudSubscriptionStatus.Active,
           ).length,
           totalNumberOfSubscriptions: subscriptions.length,
+          type,
         },
       );
     } catch (e) {
       // continue regardless of error
     }
   }
 
-  sendGetRECloudSubsFailedEvent(exception: HttpException) {
-    this.sendFailedEvent(TelemetryEvents.RECloudSubscriptionsDiscoveryFailed, exception);
+  sendGetRECloudSubsFailedEvent(exception: HttpException, type: CloudSubscriptionType) {
+    this.sendFailedEvent(TelemetryEvents.RECloudSubscriptionsDiscoveryFailed, exception, { type });
   }
 
   sendGetRECloudDbsSucceedEvent(databases: CloudDatabase[] = []) {
@@ -44,6 +46,9 @@ export class CloudAutodiscoveryAnalytics extends TelemetryBaseService {
             (db) => db.status === CloudDatabaseStatus.Active,
           ).length,
           totalNumberOfDatabases: databases.length,
+          fixed: 0,
+          flexible: 0,
+          ...countBy(databases, 'subscriptionType'),
         },
       );
     } catch (e) {

redisinsight/api/src/modules/cloud/autodiscovery/cloud-autodiscovery.service.ts

@@ -143,11 +143,11 @@ export class CloudAutodiscoveryService {
       );
       this.logger.log('Succeed to get cloud flexible subscriptions.');
       const result = parseCloudSubscriptionsResponse(subscriptions, type);
-      this.analytics.sendGetRECloudSubsSucceedEvent(result);
+      this.analytics.sendGetRECloudSubsSucceedEvent(result, type);
       return result;
     } catch (error) {
       const exception = this.getApiError(error, 'Failed to get cloud flexible subscriptions');
-      this.analytics.sendGetRECloudSubsFailedEvent(exception);
+      this.analytics.sendGetRECloudSubsFailedEvent(exception, type);
       throw exception;
     }
   }