#RI-4667 - Telemetry improvements

Author: egor-zalenski

redisinsight/api/package.json

@@ -23,7 +23,7 @@
     "start": "nest start",
     "start:dev": "cross-env NODE_ENV=development BUILD_TYPE=DOCKER_ON_PREMISE SERVER_STATIC_CONTENT=1 nest start --watch",
     "start:debug": "nest start --debug --watch",
-    "start:stage": "cross-env NODE_ENV=staging SERVER_STATIC_CONTENT=true node dist/src/main",
+    "start:stage": "cross-env NODE_ENV=staging BUILD_TYPE=DOCKER_ON_PREMISE SERVER_STATIC_CONTENT=true node dist/src/main",
     "start:prod": "cross-env NODE_ENV=production node dist/src/main",
     "test": "cross-env NODE_ENV=test ./node_modules/.bin/jest -w 1",
     "test:watch": "cross-env NODE_ENV=test jest --watch -w 1",

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

@@ -72,6 +72,9 @@ export enum TelemetryEvents {
   FeatureFlagConfigUpdateError = 'FEATURE_FLAG_CONFIG_UPDATE_ERROR',
   FeatureFlagInvalidRemoteConfig = 'FEATURE_FLAG_INVALID_REMOTE_CONFIG',
   FeatureFlagRecalculated = 'FEATURE_FLAG_RECALCULATED',
+
+  // Insights
+  InsightsRecommendationGenerated = 'INSIGHTS_RECOMMENDATION_GENERATED',
 }
 
 export enum CommandType {

redisinsight/api/src/modules/database-recommendation/database-recommendation.analytics.spec.ts

@@ -0,0 +1,48 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import {
+  mockDatabase,
+  mockDatabaseRecommendation,
+  mockDatabaseWithTlsAuth,
+} from 'src/__mocks__';
+import { TelemetryEvents } from 'src/constants';
+import { DatabaseRecommendationAnalytics } from './database-recommendation.analytics';
+
+const provider = 'cloud'
+
+describe('DatabaseRecommendationAnalytics', () => {
+  let service: DatabaseRecommendationAnalytics;
+  let sendEventSpy;
+  let sendFailedEventSpy;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        EventEmitter2,
+        DatabaseRecommendationAnalytics,
+      ],
+    }).compile();
+
+    service = await module.get(DatabaseRecommendationAnalytics);
+    sendEventSpy = jest.spyOn(service as any, 'sendEvent');
+    sendFailedEventSpy = jest.spyOn(service as any, 'sendFailedEvent');
+  });
+
+  describe('sendInstanceAddedEvent', () => {
+    it('should emit event with recommendationName and provider', () => {
+      service.sendCreatedRecommendationEvent(
+        mockDatabaseRecommendation,
+        mockDatabaseWithTlsAuth,
+      );
+
+      expect(sendEventSpy).toHaveBeenCalledWith(
+        TelemetryEvents.InsightsRecommendationGenerated,
+        {
+          recommendationName: mockDatabaseRecommendation.name,
+          databaseId: mockDatabase.id,
+          provider: mockDatabaseWithTlsAuth.provider,
+        },
+      );
+    });
+  });
+});

redisinsight/api/src/modules/database-recommendation/database-recommendation.analytics.ts

@@ -0,0 +1,24 @@
+import { Injectable } from '@nestjs/common';
+import { EventEmitter2 } from '@nestjs/event-emitter';
+import { TelemetryBaseService } from 'src/modules/analytics/telemetry.base.service';
+import { TelemetryEvents } from 'src/constants';
+import { DatabaseRecommendation } from './models';
+import { Database } from '../database/models/database';
+
+@Injectable()
+export class DatabaseRecommendationAnalytics extends TelemetryBaseService {
+  constructor(protected eventEmitter: EventEmitter2) {
+    super(eventEmitter);
+  }
+
+  sendCreatedRecommendationEvent(recommendation: DatabaseRecommendation, database: Database): void {
+    this.sendEvent(
+      TelemetryEvents.InsightsRecommendationGenerated,
+      {
+        recommendationName: recommendation.name,
+        databaseId: database.id,
+        provider: database.provider,
+      },
+    );
+  }
+}

redisinsight/api/src/modules/database-recommendation/database-recommendation.module.ts

@@ -10,6 +10,7 @@ import { DatabaseRecommendationGateway } from 'src/modules/database-recommendati
 import {
   DatabaseRecommendationEmitter,
 } from 'src/modules/database-recommendation/providers/database-recommendation.emitter';
+import { DatabaseRecommendationAnalytics } from 'src/modules/database-recommendation/database-recommendation.analytics';
 
 @Module({})
 export class DatabaseRecommendationModule {
@@ -25,6 +26,7 @@ export class DatabaseRecommendationModule {
         RecommendationProvider,
         DatabaseRecommendationGateway,
         DatabaseRecommendationEmitter,
+        DatabaseRecommendationAnalytics,
         {
           provide: DatabaseRecommendationRepository,
           useClass: databaseRecommendationRepository,

redisinsight/api/src/modules/database-recommendation/repositories/local.database.recommendation.repository.ts

@@ -22,6 +22,8 @@ import {
 import { RecommendationEvents } from 'src/modules/database-recommendation/constants';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import { ModelEncryptor } from 'src/modules/encryption/model.encryptor';
+import { DatabaseService } from 'src/modules/database/database.service';
+import { DatabaseRecommendationAnalytics } from '../database-recommendation.analytics';
 
 @Injectable()
 export class LocalDatabaseRecommendationRepository extends DatabaseRecommendationRepository {
@@ -33,6 +35,8 @@ export class LocalDatabaseRecommendationRepository extends DatabaseRecommendatio
     @InjectRepository(DatabaseRecommendationEntity)
     private readonly repository: Repository<DatabaseRecommendationEntity>,
     private eventEmitter: EventEmitter2,
+    private readonly analytics: DatabaseRecommendationAnalytics,
+    private readonly databaseService: DatabaseService,
     private readonly encryptionService: EncryptionService,
   ) {
     super();
@@ -56,6 +60,10 @@ export class LocalDatabaseRecommendationRepository extends DatabaseRecommendatio
     );
     this.eventEmitter.emit(RecommendationEvents.NewRecommendation, [recommendation]);
 
+    const database = await this.databaseService.get(entity?.databaseId)
+
+    this.analytics.sendCreatedRecommendationEvent(recommendation, database)
+
     return recommendation;
   }