Merge pull request #2618 from snyk/chore/improve-iac-analytics

chore: improve iac analytics [CFG-1386]
snyk · Jan 25, 2022 · 7bbe2b2 · 7bbe2b2
2 parents 9cd65c6 + 564a2db
commit 7bbe2b2
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/src/cli/commands/test/iac-local-execution/analytics.ts b/src/cli/commands/test/iac-local-execution/analytics.ts
@@ -5,7 +5,11 @@ import { computeCustomRulesBundleChecksum } from './file-utils';
 
 export function addIacAnalytics(
   formattedResults: FormattedResult[],
-  ignoredIssuesCount: number,
+  opts: {
+    ignoredIssuesCount: number;
+    isLocalCustomRules: boolean;
+    isRemoteCustomRules: boolean;
+  },
 ): void {
   let totalIssuesCount = 0;
   const customRulesIdsFoundInIssues: { [customRuleId: string]: true } = {};
@@ -41,10 +45,13 @@ export function addIacAnalytics(
 
   analytics.add('packageManager', Array.from(new Set(packageManagers)));
   analytics.add('iac-issues-count', totalIssuesCount);
-  analytics.add('iac-ignored-issues-count', ignoredIssuesCount);
+  analytics.add('iac-ignored-issues-count', opts.ignoredIssuesCount);
   analytics.add('iac-type', projectTypeAnalytics);
   analytics.add('iac-metrics', performanceAnalyticsObject);
-  analytics.add('iac-test-count', formattedResults.length);
+  analytics.add('iac-test-count', formattedResults.length); // TODO: remove this once we all analytics use iac-files-count
+  analytics.add('iac-files-count', formattedResults.length);
+  analytics.add('iac-local-custom-rules', opts.isLocalCustomRules);
+  analytics.add('iac-remote-custom-rules', opts.isRemoteCustomRules);
   analytics.add('iac-custom-rules-issues-count', issuesFromCustomRulesCount);
   analytics.add(
     'iac-custom-rules-issues-percentage',

diff --git a/src/cli/commands/test/iac-local-execution/index.ts b/src/cli/commands/test/iac-local-execution/index.ts
@@ -144,7 +144,11 @@ export async function test(
       // run their tests by squashing the error.
     }
 
-    addIacAnalytics(filteredIssues, ignoreCount);
+    addIacAnalytics(filteredIssues, {
+      ignoredIssuesCount: ignoreCount,
+      isLocalCustomRules: !!customRulesPath,
+      isRemoteCustomRules: isOCIRegistryURLProvided,
+    });
 
     // TODO: add support for proper typing of old TestResult interface.
     return {