Add telemetry for TRAP cache cleanup

lib/analyze-action.js

@@ -48,7 +48,7 @@ const status_report_1 = require("./status-report");
 const trap_caching_1 = require("./trap-caching");
 const uploadLib = __importStar(require("./upload-lib"));
 const util = __importStar(require("./util"));
-async function sendStatusReport(startedAt, config, stats, error, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, logger) {
+async function sendStatusReport(startedAt, config, stats, error, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, trapCacheCleanup, logger) {
     const status = (0, status_report_1.getActionsStatus)(error, stats?.analyze_failure_language);
     const statusReportBase = await (0, status_report_1.createStatusReportBase)(status_report_1.ActionName.Analyze, status, startedAt, config, await util.checkDiskUsage(), logger, error?.message, error?.stack);
     if (statusReportBase !== undefined) {
@@ -56,6 +56,7 @@ async function sendStatusReport(startedAt, config, stats, error, trapCacheUpload
             ...statusReportBase,
             ...(stats || {}),
             ...(dbCreationTimings || {}),
+            ...(trapCacheCleanup || {}),
         };
         if (config && didUploadTrapCaches) {
             const trapCacheUploadStatusReport = {
@@ -141,6 +142,7 @@ async function run() {
     let uploadResult = undefined;
     let runStats = undefined;
     let config = undefined;
+    let trapCacheCleanupTelemetry = undefined;
     let trapCacheUploadTime = undefined;
     let dbCreationTimings = undefined;
     let didUploadTrapCaches = false;
@@ -197,7 +199,7 @@ async function run() {
         didUploadTrapCaches = await (0, trap_caching_1.uploadTrapCaches)(codeql, config, logger);
         trapCacheUploadTime = perf_hooks_1.performance.now() - trapCacheUploadStartTime;
         // Clean up TRAP caches
-        await (0, trap_caching_1.cleanupTrapCaches)(config, logger);
+        trapCacheCleanupTelemetry = await (0, trap_caching_1.cleanupTrapCaches)(config, logger);
         // We don't upload results in test mode, so don't wait for processing
         if (util.isInTestMode()) {
             logger.debug("In test mode. Waiting for processing is disabled.");
@@ -220,10 +222,10 @@ async function run() {
         }
         if (error instanceof analyze_1.CodeQLAnalysisError) {
             const stats = { ...error.queriesStatusReport };
-            await sendStatusReport(startedAt, config, stats, error, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, logger);
+            await sendStatusReport(startedAt, config, stats, error, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, trapCacheCleanupTelemetry, logger);
         }
         else {
-            await sendStatusReport(startedAt, config, undefined, error, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, logger);
+            await sendStatusReport(startedAt, config, undefined, error, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, trapCacheCleanupTelemetry, logger);
         }
         return;
     }
@@ -231,13 +233,13 @@ async function run() {
         await sendStatusReport(startedAt, config, {
             ...runStats,
             ...uploadResult.statusReport,
-        }, undefined, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, logger);
+        }, undefined, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, trapCacheCleanupTelemetry, logger);
     }
     else if (runStats) {
-        await sendStatusReport(startedAt, config, { ...runStats }, undefined, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, logger);
+        await sendStatusReport(startedAt, config, { ...runStats }, undefined, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, trapCacheCleanupTelemetry, logger);
     }
     else {
-        await sendStatusReport(startedAt, config, undefined, undefined, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, logger);
+        await sendStatusReport(startedAt, config, undefined, undefined, trapCacheUploadTime, dbCreationTimings, didUploadTrapCaches, trapCacheCleanupTelemetry, logger);
     }
 }
 exports.runPromise = run();

lib/trap-caching.js

@@ -133,9 +133,13 @@ async function uploadTrapCaches(codeql, config, logger) {
 }
 exports.uploadTrapCaches = uploadTrapCaches;
 async function cleanupTrapCaches(config, logger) {
-    if (!(await actionsUtil.isAnalyzingDefaultBranch()))
-        return;
+    if (!(await actionsUtil.isAnalyzingDefaultBranch())) {
+        return {
+            trap_cache_cleanup_skipped_because: "not analyzing default branch",
+        };
+    }
     try {
+        let totalBytesCleanedUp = 0;
         for (const language of config.languages) {
             if (config.trapCaches[language]) {
                 const cachesToRemove = await getTrapCachesForLanguage(language, logger);
@@ -148,12 +152,13 @@ async function cleanupTrapCaches(config, logger) {
                     logger.debug(`Deleting old TRAP cache (${JSON.stringify(cache)})`);
                     await apiClient.deleteActionsCache(cache.id);
                 }
-                const totalBytesCleanedUp = cachesToRemove.reduce((acc, item) => acc + item.size_in_bytes, 0);
-                const totalMegabytesCleanedUp = (totalBytesCleanedUp /
-                    (1024 * 1024)).toFixed(2);
-                logger.info(`Cleaned up ${totalMegabytesCleanedUp} MiB of old TRAP caches for ${language}.`);
+                const bytesCleanedUp = cachesToRemove.reduce((acc, item) => acc + item.size_in_bytes, 0);
+                totalBytesCleanedUp += bytesCleanedUp;
+                const megabytesCleanedUp = (bytesCleanedUp / (1024 * 1024)).toFixed(2);
+                logger.info(`Cleaned up ${megabytesCleanedUp} MiB of old TRAP caches for ${language}.`);
             }
         }
+        return { trap_cache_cleanup_size_bytes: totalBytesCleanedUp };
     }
     catch (e) {
         if ((0, util_1.isHTTPError)(e) && e.status === 403) {
@@ -164,6 +169,7 @@ async function cleanupTrapCaches(config, logger) {
         else {
             logger.info(`Failed to cleanup TRAP caches, continuing. Details: ${e}`);
         }
+        return { trap_cache_cleanup_error: (0, util_1.wrapError)(e).message };
     }
 }
 exports.cleanupTrapCaches = cleanupTrapCaches;