fix: collect image size telemetry

Author: ivanstanev

src/scanner/images/index.ts

@@ -1,4 +1,5 @@
-import { unlink } from 'fs';
+import { unlink, stat } from 'fs';
+import { promisify } from 'util';
 import { PluginResponse, scan } from 'snyk-docker-plugin';
 import { DepGraph, legacy } from '@snyk/dep-graph';
 
@@ -12,6 +13,9 @@ import {
   extractFactsFromDockerPluginResponse,
   LegacyPluginResponse,
 } from './docker-plugin-shim';
+import type { Telemetry } from '../../transmitter/types';
+
+const statAsync = promisify(stat);
 
 /*
  pulled images by skopeo archive repo type:
@@ -105,6 +109,7 @@ export function getImageParts(imageWithTag: string): {
 
 export async function scanImages(
   images: IPullableImage[],
+  telemetry: Partial<Telemetry>,
 ): Promise<IScanResult[]> {
   const scannedImages: IScanResult[] = [];
 
@@ -127,6 +132,19 @@ export async function scanImages(
         throw Error('Unexpected empty result from docker-plugin');
       }
 
+      try {
+        const fileStats = await statAsync(fileSystemPath);
+        if (!telemetry.imageSizeBytes) {
+          telemetry.imageSizeBytes = 0;
+        }
+        telemetry.imageSizeBytes += fileStats.size;
+      } catch (err) {
+        logger.warn(
+          { error: err, imageName, imageWithDigest, fileSystemPath },
+          'could not determine archive size',
+        );
+      }
+
       const depTree = await getDependencyTreeFromPluginResponse(
         pluginResponse,
         imageName,

src/scanner/index.ts

@@ -120,7 +120,7 @@ async function scanImagesAndSendResults(
   telemetry: Partial<Telemetry>,
 ): Promise<void> {
   const imageScanStartTimestampMs = Date.now();
-  const scannedImages = await scanImages(pulledImages);
+  const scannedImages = await scanImages(pulledImages, telemetry);
   const imageScanDurationMs = Date.now() - imageScanStartTimestampMs;
 
   if (scannedImages.length === 0) {

src/transmitter/types.ts

@@ -101,6 +101,10 @@ export interface IRequestError {
 export interface Telemetry {
   enqueueDurationMs: number;
   queueSize: number;
+  /** This metric captures the total duration to pull all images of a workload. */
   imagePullDurationMs: number;
+  /** This metric captures the total duration to scan all images of a workload. */
   imageScanDurationMs: number;
+  /** This metric captures the combined size of all images of a workload. */
+  imageSizeBytes: number;
 }

test/system/kind.spec.ts

@@ -254,6 +254,7 @@ test('Kubernetes-Monitor with KinD', async (jestDoneCallback) => {
             enqueueDurationMs: expect.any(Number),
             imagePullDurationMs: expect.any(Number),
             imageScanDurationMs: expect.any(Number),
+            imageSizeBytes: expect.any(Number),
             queueSize: expect.any(Number),
           },
           imageLocator: expect.objectContaining({
@@ -270,10 +271,7 @@ test('Kubernetes-Monitor with KinD', async (jestDoneCallback) => {
                 { type: 'imageOsReleasePrettyName', data: expect.any(String) },
               ]),
               target: { image: 'docker-image|docker.io/library/java' },
-              identity: {
-                type: 'deb',
-                args: { platform: 'linux/amd64' },
-              },
+              identity: { type: 'deb', args: { platform: 'linux/amd64' } },
             },
             {
               facts: [