Merge pull request #2112 from github/henrymercer/status-report-handle…

…-disk-failures Telemetry: Handle failures determining disk usage
github · Feb 2, 2024 · 2db0327 · 2db0327
2 parents 81eb6b2 + f9dea84
commit 2db0327
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 41 deletions.
diff --git a/lib/status-report.js b/lib/status-report.js
diff --git a/lib/status-report.js.map b/lib/status-report.js.map
diff --git a/lib/util.js b/lib/util.js
diff --git a/lib/util.js.map b/lib/util.js.map
diff --git a/src/status-report.ts b/src/status-report.ts
@@ -96,7 +96,7 @@ export interface StatusReportBase {
   /** Action runner hardware architecture (context runner.arch). */
   runner_arch?: string;
   /** Available disk space on the runner, in bytes. */
-  runner_available_disk_space_bytes: number;
+  runner_available_disk_space_bytes?: number;
   /**
    * Version of the runner image, for workflows running on GitHub-hosted runners. Absent otherwise.
    */
@@ -106,7 +106,7 @@ export interface StatusReportBase {
   /** Action runner operating system release (x.y.z from os.release()). */
   runner_os_release?: string;
   /** Total disk space on the runner, in bytes. */
-  runner_total_disk_space_bytes: number;
+  runner_total_disk_space_bytes?: number;
   /** Time the first action started. Normally the init action. */
   started_at: string;
   /** State this action is currently in. */
@@ -192,7 +192,7 @@ export async function createStatusReportBase(
   actionName: ActionName,
   status: ActionStatus,
   actionStartedAt: Date,
-  diskInfo: DiskUsage,
+  diskInfo: DiskUsage | undefined,
   cause?: string,
   exception?: string,
 ): Promise<StatusReportBase> {
@@ -230,9 +230,7 @@ export async function createStatusReportBase(
     job_name: jobName,
     job_run_uuid: jobRunUUID,
     ref,
-    runner_available_disk_space_bytes: diskInfo.numAvailableBytes,
     runner_os: runnerOs,
-    runner_total_disk_space_bytes: diskInfo.numTotalBytes,
     started_at: workflowStartedAt,
     status,
     testing_environment: testingEnvironment,
@@ -241,6 +239,11 @@ export async function createStatusReportBase(
     workflow_run_id: workflowRunID,
   };
 
+  if (diskInfo) {
+    statusReport.runner_available_disk_space_bytes = diskInfo.numAvailableBytes;
+    statusReport.runner_total_disk_space_bytes = diskInfo.numTotalBytes;
+  }
+
   // Add optional parameters
   if (cause) {
     statusReport.cause = cause;

diff --git a/src/util.ts b/src/util.ts
@@ -1011,26 +1011,37 @@ export interface DiskUsage {
   numTotalBytes: number;
 }
 
-export async function checkDiskUsage(logger?: Logger): Promise<DiskUsage> {
-  const diskUsage = await checkDiskSpace(
-    getRequiredEnvParam("GITHUB_WORKSPACE"),
-  );
-  const gbInBytes = 1024 * 1024 * 1024;
-  if (logger && diskUsage.free < 2 * gbInBytes) {
-    const message =
-      "The Actions runner is running low on disk space " +
-      `(${(diskUsage.free / gbInBytes).toPrecision(4)} GB available).`;
-    if (process.env[EnvVar.HAS_WARNED_ABOUT_DISK_SPACE] !== "true") {
-      logger.warning(message);
-    } else {
-      logger.debug(message);
+export async function checkDiskUsage(
+  logger?: Logger,
+): Promise<DiskUsage | undefined> {
+  try {
+    const diskUsage = await checkDiskSpace(
+      getRequiredEnvParam("GITHUB_WORKSPACE"),
+    );
+    const gbInBytes = 1024 * 1024 * 1024;
+    if (logger && diskUsage.free < 2 * gbInBytes) {
+      const message =
+        "The Actions runner is running low on disk space " +
+        `(${(diskUsage.free / gbInBytes).toPrecision(4)} GB available).`;
+      if (process.env[EnvVar.HAS_WARNED_ABOUT_DISK_SPACE] !== "true") {
+        logger.warning(message);
+      } else {
+        logger.debug(message);
+      }
+      core.exportVariable(EnvVar.HAS_WARNED_ABOUT_DISK_SPACE, "true");
     }
-    core.exportVariable(EnvVar.HAS_WARNED_ABOUT_DISK_SPACE, "true");
+    return {
+      numAvailableBytes: diskUsage.free,
+      numTotalBytes: diskUsage.size,
+    };
+  } catch (error) {
+    if (logger) {
+      logger.warning(
+        `Failed to check available disk space: ${getErrorMessage(error)}`,
+      );
+    }
+    return undefined;
   }
-  return {
-    numAvailableBytes: diskUsage.free,
-    numTotalBytes: diskUsage.size,
-  };
 }
 
 /**