[9.0] [Rule Migration] Telemetry improvements (#210275) (#210582)

# Backport This will backport the following commits from `main` to `9.0`: - [[Rule Migration] Telemetry improvements (#210275)](#210275)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Marius Iversen <marius.iversen@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
elastic · Feb 21, 2025 · 2a4e4c0 · 2a4e4c0
1 parent 172592a
commit 2a4e4c0
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 19 deletions.
diff --git a/...ns/security_solution/server/lib/siem_migrations/rules/task/rule_migrations_task_client.ts b/...ns/security_solution/server/lib/siem_migrations/rules/task/rule_migrations_task_client.ts
@@ -102,6 +102,7 @@ export class RuleMigrationsTaskClient {
     const stats = { completed: 0, failed: 0 };
     const telemetryClient = new SiemMigrationTelemetryClient(
       this.dependencies.telemetry,
+      this.logger,
       migrationId,
       model.model
     );

diff --git a/...y_solution/server/lib/siem_migrations/rules/task/rule_migrations_telemetry_client.test.ts b/...y_solution/server/lib/siem_migrations/rules/task/rule_migrations_telemetry_client.test.ts
@@ -6,6 +6,7 @@
  */
 
 import { coreMock } from '@kbn/core/server/mocks';
+import { loggerMock } from '@kbn/logging-mocks';
 import { SiemMigrationTelemetryClient } from './rule_migrations_telemetry_client';
 import type { RuleMigrationIntegration, RuleMigrationPrebuiltRule } from '../types';
 import type { MigrateRuleState } from './agent/types';
@@ -68,8 +69,10 @@ const preFilterIntegrationMocks: RuleMigrationIntegration[] = [
 ];
 
 const mockTelemetry = coreMock.createSetup().analytics;
+const mockLogger = loggerMock.create();
 const siemTelemetryClient = new SiemMigrationTelemetryClient(
   mockTelemetry,
+  mockLogger,
   'testmigration',
   'testModel'
 );
@@ -199,7 +202,7 @@ describe('siemMigrationTelemetry', () => {
       migrationId: 'testmigration',
       model: 'testModel',
       postFilterRuleCount: 1,
-      postFilterRuleNames: 'rule1id',
+      postFilterRuleName: 'rule1id',
       preFilterRuleCount: 2,
       preFilterRuleNames: ['rule1id', 'rule2id'],
     });
@@ -212,7 +215,7 @@ describe('siemMigrationTelemetry', () => {
       migrationId: 'testmigration',
       model: 'testModel',
       postFilterRuleCount: 0,
-      postFilterRuleNames: '',
+      postFilterRuleName: '',
       preFilterRuleCount: 2,
       preFilterRuleNames: ['rule1id', 'rule2id'],
     });

diff --git a/...curity_solution/server/lib/siem_migrations/rules/task/rule_migrations_telemetry_client.ts b/...curity_solution/server/lib/siem_migrations/rules/task/rule_migrations_telemetry_client.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import type { AnalyticsServiceSetup } from '@kbn/core/public';
+import type { AnalyticsServiceSetup, Logger, EventTypeOpts } from '@kbn/core/server';
 import {
   SIEM_MIGRATIONS_INTEGRATIONS_MATCH,
   SIEM_MIGRATIONS_MIGRATION_FAILURE,
@@ -43,17 +43,24 @@ interface SiemMigrationEvent {
 export class SiemMigrationTelemetryClient {
   constructor(
     private readonly telemetry: AnalyticsServiceSetup,
+    private readonly logger: Logger,
     private readonly migrationId: string,
-    private readonly modelName: string | undefined
-  ) {
-    this.modelName = modelName || '';
+    private readonly modelName: string = ''
+  ) {}
+
+  private reportEvent<T extends object>(eventTypeOpts: EventTypeOpts<T>, data: T): void {
+    try {
+      this.telemetry.reportEvent(eventTypeOpts.eventType, data);
+    } catch (e) {
+      this.logger.error(`Error reporting event ${eventTypeOpts.eventType}: ${e.message}`);
+    }
   }
 
   public reportIntegrationsMatch({
     preFilterIntegrations,
     postFilterIntegration,
   }: IntegrationMatchEvent): void {
-    this.telemetry.reportEvent(SIEM_MIGRATIONS_INTEGRATIONS_MATCH.eventType, {
+    this.reportEvent(SIEM_MIGRATIONS_INTEGRATIONS_MATCH, {
       model: this.modelName,
       migrationId: this.migrationId,
       preFilterIntegrationNames: preFilterIntegrations.map((integration) => integration.id) || [],
@@ -66,12 +73,12 @@ export class SiemMigrationTelemetryClient {
     preFilterRules,
     postFilterRule,
   }: PrebuiltRuleMatchEvent): void {
-    this.telemetry.reportEvent(SIEM_MIGRATIONS_PREBUILT_RULES_MATCH.eventType, {
+    this.reportEvent(SIEM_MIGRATIONS_PREBUILT_RULES_MATCH, {
       model: this.modelName,
       migrationId: this.migrationId,
       preFilterRuleNames: preFilterRules.map((rule) => rule.rule_id) || [],
       preFilterRuleCount: preFilterRules.length,
-      postFilterRuleNames: postFilterRule ? postFilterRule.rule_id : '',
+      postFilterRuleName: postFilterRule ? postFilterRule.rule_id : '',
       postFilterRuleCount: postFilterRule ? 1 : 0,
     });
   }
@@ -84,17 +91,17 @@ export class SiemMigrationTelemetryClient {
       const duration = Date.now() - startTime;
 
       if (error) {
-        this.telemetry.reportEvent(SIEM_MIGRATIONS_RULE_TRANSLATION_FAILURE.eventType, {
+        this.reportEvent(SIEM_MIGRATIONS_RULE_TRANSLATION_FAILURE, {
           migrationId: this.migrationId,
           error: error.message,
           model: this.modelName,
         });
         return;
       }
 
-      this.telemetry.reportEvent(SIEM_MIGRATIONS_RULE_TRANSLATION_SUCCESS.eventType, {
+      this.reportEvent(SIEM_MIGRATIONS_RULE_TRANSLATION_SUCCESS, {
         migrationId: this.migrationId,
-        translationResult: migrationResult?.translation_result,
+        translationResult: migrationResult?.translation_result || '',
         duration,
         model: this.modelName,
         prebuiltMatch: migrationResult?.elastic_rule?.prebuilt_rule_id ? true : false,
@@ -106,26 +113,26 @@ export class SiemMigrationTelemetryClient {
 
     return ({ error, stats }) => {
       const duration = Date.now() - startTime;
-      const total = stats?.completed + stats?.failed;
+      const total = stats ? stats.completed + stats.failed : 0;
 
       if (error) {
-        this.telemetry.reportEvent(SIEM_MIGRATIONS_MIGRATION_FAILURE.eventType, {
+        this.reportEvent(SIEM_MIGRATIONS_MIGRATION_FAILURE, {
           migrationId: this.migrationId,
           model: this.modelName || '',
-          completed: stats?.completed,
-          failed: stats?.failed,
+          completed: stats ? stats.completed : 0,
+          failed: stats ? stats.failed : 0,
           total,
           duration,
           error: error.message,
         });
         return;
       }
 
-      this.telemetry.reportEvent(SIEM_MIGRATIONS_MIGRATION_SUCCESS.eventType, {
+      this.reportEvent(SIEM_MIGRATIONS_MIGRATION_SUCCESS, {
         migrationId: this.migrationId,
         model: this.modelName || '',
-        completed: stats?.completed,
-        failed: stats?.failed,
+        completed: stats ? stats.completed : 0,
+        failed: stats ? stats.failed : 0,
         total,
         duration,
       });