Queue job profiling

src/config/app.php

@@ -4,7 +4,7 @@
     'id' => 'CraftCMS',
     'name' => 'Craft CMS',
     'version' => '4.5.6.1',
-    'schemaVersion' => '4.5.3.0',
+    'schemaVersion' => '4.6.0.0',
     'minVersionRequired' => '3.7.11',
     'basePath' => dirname(__DIR__), // Defines the @app alias
     'runtimePath' => '@storage/runtime', // Defines the @runtime alias

src/controllers/QueueController.php

@@ -9,6 +9,7 @@
 
 use Craft;
 use craft\helpers\App;
+use craft\helpers\DateTimeHelper;
 use craft\helpers\Json;
 use craft\queue\QueueInterface;
 use craft\web\Controller;
@@ -174,7 +175,12 @@ public function actionGetJobInfo(): Response
 
         return $this->asJson([
             'total' => $this->queue->getTotalJobs(),
-            'jobs' => $this->queue->getJobInfo($limit),
+            'jobs' => array_map(function(array $info) {
+                if (isset($info['averageDuration'])) {
+                    $info['averageDurationLabel'] = DateTimeHelper::humanDuration($info['averageDuration']);
+                }
+                return $info;
+            }, $this->queue->getJobInfo($limit)),
         ]);
     }
 

src/db/Table.php

@@ -74,6 +74,8 @@ abstract class Table
     /** @since 3.4.0 */
     public const PROJECTCONFIG = '{{%projectconfig}}';
     public const QUEUE = '{{%queue}}';
+    /** @since 4.6.0 */
+    public const QUEUEPROFILES = '{{%queueprofiles}}';
     public const RELATIONS = '{{%relations}}';
     public const SECTIONS = '{{%sections}}';
     public const SECTIONS_SITES = '{{%sections_sites}}';

src/migrations/Install.php

@@ -557,6 +557,12 @@ public function createTables(): void
             'dateFailed' => $this->dateTime(),
             'error' => $this->text(),
         ]);
+        $this->createTable(Table::QUEUEPROFILES, [
+            'key' => $this->string(),
+            'dateExecuted' => $this->dateTime()->notNull(),
+            'duration' => $this->integer()->notNull(),
+            'PRIMARY KEY([[key]], [[dateExecuted]])',
+        ]);
         $this->createTable(Table::RELATIONS, [
             'id' => $this->primaryKey(),
             'fieldId' => $this->integer()->notNull(),

src/migrations/m231006_071504_job_profiling.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace craft\migrations;
+
+use craft\db\Migration;
+use craft\db\Table;
+
+/**
+ * m231006_071504_job_profiling migration.
+ */
+class m231006_071504_job_profiling extends Migration
+{
+    /**
+     * @inheritdoc
+     */
+    public function safeUp(): bool
+    {
+        $this->createTable(Table::QUEUEPROFILES, [
+            'key' => $this->string(),
+            'dateExecuted' => $this->dateTime()->notNull(),
+            'duration' => $this->integer()->notNull(),
+            'PRIMARY KEY([[key]], [[dateExecuted]])',
+        ]);
+
+        return true;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function safeDown(): bool
+    {
+        echo "m231006_071504_job_profiling cannot be reverted.\n";
+        return false;
+    }
+}

src/queue/BaseBatchedJob.php

@@ -9,6 +9,7 @@
 
 use Craft;
 use craft\base\Batchable;
+use craft\helpers\ArrayHelper;
 use craft\helpers\ConfigHelper;
 use craft\helpers\Queue as QueueHelper;
 use craft\i18n\Translation;
@@ -31,7 +32,7 @@
  * @author Pixel & Tonic, Inc. <[email protected]>
  * @since 4.4.0
  */
-abstract class BaseBatchedJob extends BaseJob
+abstract class BaseBatchedJob extends BaseJob implements ProfilableJobInterface
 {
     /**
      * @var int The number of items that should be processed in a single batch
@@ -172,4 +173,14 @@ final public function getDescription(): ?string
             'total' => $totalBatches,
         ]);
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function getProfileAttributes(): array
+    {
+        $arr = ArrayHelper::toArray($this);
+        unset($arr['batchIndex'], $arr['itemOffset'], $arr['priority'], $arr['ttr']);
+        return $arr;
+    }
 }

src/queue/ProfilableJobInterface.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license https://craftcms.github.io/license/
+ */
+
+namespace craft\queue;
+
+/**
+ * ProfilableJobInterface aids in aggregating profile results for queue jobs.
+ *
+ * It should be implemented by jobs which could have wide-varying runtime lengths based on their configuration.
+ *
+ * @author Pixel & Tonic, Inc. <[email protected]>
+ * @since 4.6.0
+ */
+interface ProfilableJobInterface
+{
+    /**
+     * Returns the job attributes that should be used to semi-uniquely identify this job, based on its configuration,
+     * so that its profile results can be compared with recent similarly-configured jobs.
+     *
+     * @return array
+     */
+    public function getProfileAttributes(): array;
+}