Add queuedDurationSec for job (#1304)

Kesin11 · Sep 1, 2024 · 82d2501 · 82d2501
2 parents aa0419c + 85e0af5
commit 82d2501
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 4 deletions.
diff --git a/bigquery_schema/workflow_report.json b/bigquery_schema/workflow_report.json
@@ -202,6 +202,11 @@
     "name": "executorName",
     "type": "STRING",
     "mode": "NULLABLE"
+   },
+   {
+    "name": "queuedDurationSec",
+    "type": "FLOAT",
+    "mode": "NULLABLE"
    }
   ]
  },

diff --git a/proto/workflow.proto b/proto/workflow.proto
@@ -60,6 +60,7 @@ message PbJobReport {
   string executorClass = 12;
   string executorType = 13;
   string executorName = 14;
+  float queuedDurationSec = 15;
 }
 
 message PbStepReport {
@@ -85,4 +86,4 @@ message PbWorkflowParams {
   string workflowRunId = 2;
   int32 buildNumber = 3;
   string workflowName = 4;
-}
+}
diff --git a/src/analyzer/bitrise_analyzer.ts b/src/analyzer/bitrise_analyzer.ts
@@ -58,6 +58,7 @@ type JobReport = {
   executorClass: string; // "standard"
   executorType: string; // osx-vs4mac-stable
   executorName: ""; // Bitrise does not support self-hosted runner
+  queuedDurationSec: 0; // BitriseAnalyzer does not support job queued duration yet
 };
 
 type StepReport = {
@@ -134,6 +135,7 @@ export class BitriseAnalyzer implements Analyzer {
           executorClass: build.machine_type_id,
           executorType: build.stack_identifier,
           executorName: "",
+          queuedDurationSec: 0, // Not supported yet
         },
       ],
       startedAt,

diff --git a/src/analyzer/circleci_analyzer.ts b/src/analyzer/circleci_analyzer.ts
@@ -59,6 +59,7 @@ export type JobReport = {
   executorClass: ""; // CircleCIAnalyzer(v1) does not support
   executorType: ""; // CircleCIAnalyzer(v1) does not support
   executorName: ""; // CircleCIAnalyzer(v1) does not support
+  queuedDurationSec: 0; // CircleciAnalyzer(v1) does not support
 };
 
 type StepReport = {
@@ -142,6 +143,7 @@ export class CircleciAnalyzer implements Analyzer {
         executorClass: "",
         executorType: "",
         executorName: "",
+        queuedDurationSec: 0, // Not supported yet
       };
     });
 

diff --git a/src/analyzer/circleci_analyzer_v2.ts b/src/analyzer/circleci_analyzer_v2.ts
@@ -55,6 +55,7 @@ type JobReport = {
   executorClass: string; // medium
   executorType: string; // docker
   executorName: ""; // CircleCI does not support self-hosted runner
+  queuedDurationSec: 0; // CircleciAnalyzerV2 does not support job queued duration yet
 };
 
 type StepReport = {
@@ -139,6 +140,7 @@ export class CircleciAnalyzerV2 implements Analyzer {
         executorClass: job.detail.executor.resource_class,
         executorType: job.detail.executor.type,
         executorName: "",
+        queuedDurationSec: 0, // Not supported yet
       };
     });
 

diff --git a/src/analyzer/github_analyzer.ts b/src/analyzer/github_analyzer.ts
@@ -36,7 +36,7 @@ type WorkflowReport = {
   sumJobsDurationSec: number; // = sum(jobs sumStepsDurationSec)
   successCount: 0 | 1; // = 'SUCCESS': 1, others: 0
   parameters: []; // GithubAnalyzer does not support build parameters yet
-  queuedDurationSec: number; // createdAt - startedAt
+  queuedDurationSec: number; // workflow createdAt - workflow startedAt
   commitMessage: string;
   actor: string; // Kenta Kase
   url: string; // https://github.com/{org}/{repo}/actions/runs/{runId}
@@ -57,6 +57,7 @@ type JobReport = {
   executorClass: ""; // Github Actions does not provide about class of executor
   executorType: ""; // Github Actions does not provde about type of executor
   executorName: string; // self-hosted runner name
+  queuedDurationSec: number; // job createdAt - job startedAt
 };
 
 type StepReport = {
@@ -109,6 +110,7 @@ export class GithubAnalyzer implements Analyzer {
 
       const startedAt = new Date(job.started_at);
       const completedAt = new Date(job.completed_at!);
+      const createdAt = new Date(job.created_at);
       // job
       return {
         workflowRunId: workflowRunId,
@@ -125,6 +127,7 @@ export class GithubAnalyzer implements Analyzer {
         executorClass: "",
         executorType: "",
         executorName: job.runner_name ?? "",
+        queuedDurationSec: diffSec(createdAt, startedAt), // job.createdAt - job.startedAt
       };
     });
 
@@ -156,7 +159,7 @@ export class GithubAnalyzer implements Analyzer {
       sumJobsDurationSec: sumBy(jobReports, "sumStepsDurationSec"),
       successCount: status === "SUCCESS" ? 1 : 0,
       parameters: [],
-      queuedDurationSec: diffSec(createdAt, startedAt),
+      queuedDurationSec: diffSec(createdAt, startedAt), // workflow.created_at - firstJob.started_at
       commitMessage: workflow.head_commit?.message ?? "",
       actor: workflow.head_commit?.author?.name ?? "",
       url: workflow.html_url,

diff --git a/src/analyzer/jenkins_analyzer.ts b/src/analyzer/jenkins_analyzer.ts
@@ -61,7 +61,8 @@ type JobReport = {
   url: ""; // Jenkins does not provide each stage url
   executorClass: ""; // JenkinsAnalyzer does not support
   executorType: ""; // JenkinsAnalyzer does not support
-  executorName: ""; // JenkinsAnalyzer doen not support
+  executorName: ""; // JenkinsAnalyzer does not support
+  queuedDurationSec: 0; // JenkinsAnalyzer does not support job queued duration yet
 };
 
 type StepReport = {
@@ -130,6 +131,7 @@ export class JenkinsAnalyzer implements Analyzer {
         executorClass: "",
         executorType: "",
         executorName: "",
+        queuedDurationSec: 0, // Not supported yet
       };
     });
 

diff --git a/src/pb_types/workflow.ts b/src/pb_types/workflow.ts