Add archiving metrics code with timer

config/global.ini.php

@@ -1154,6 +1154,10 @@
 delete_reports_keep_range_reports    = 0
 delete_reports_keep_segment_reports  = 0
 
+[ArchivingMetrics]
+; retention_days - delete archiving metrics older than this many days. Set to 0 to disable cleanup.
+retention_days = 180
+
 [mail]
 defaultHostnameIfEmpty = defaultHostnameIfEmpty.example.org ; default Email @hostname, if current host can't be read from system variables
 transport = ; smtp (using the configuration below) or empty (using built-in mail() function)

core/Application/Kernel/PluginList.php

@@ -33,6 +33,7 @@ class PluginList
      * @var array
      */
     private $corePluginsDisabledByDefault = array(
+        'ArchivingMetrics',
         'DBStats',
         'ExamplePlugin',
         'ExampleCommand',

core/ArchiveProcessor/Loader.php

@@ -36,6 +36,13 @@ class Loader
 {
     private static $archivingDepth = 0;
 
+    /**
+     * Tracks whether the current prepareArchive run reused an existing archive instead of processing.
+     *
+     * @var boolean
+     */
+    private $didReuseArchive = false;
+
     /**
      * @var Parameters
      */
@@ -103,6 +110,11 @@ public function prepareArchive($pluginName)
         return Context::changeIdSite($this->params->getSite()->getId(), function () use ($pluginName) {
             try {
                 ++self::$archivingDepth;
+
+                if (self::$archivingDepth === 1) {
+                    $this->didReuseArchive = false;
+                }
+
                 return $this->prepareArchiveImpl($pluginName);
             } finally {
                 --self::$archivingDepth;
@@ -135,6 +147,7 @@ private function prepareArchiveImpl($pluginName)
         // load existing data from archive
         $data = $this->loadArchiveData();
         if (sizeof($data) == 2) {
+            $this->didReuseArchive = true;
             return $data;
         }
         [$idArchives, $visits, $visitsConverted, $foundRecords] = $data;
@@ -153,6 +166,7 @@ private function prepareArchiveImpl($pluginName)
                 $data = $this->loadArchiveData();
 
                 if (sizeof($data) == 2) {
+                    $this->didReuseArchive = true;
                     return $data;
                 }
 
@@ -542,6 +556,11 @@ public function canSkipThisArchiveWithReason(): array
         ];
     }
 
+    public function didReuseArchive(): bool
+    {
+        return $this->didReuseArchive;
+    }
+
     private function hasChildArchivesInPeriod($idSite, Period $period): bool
     {
         $cacheKey = CacheId::siteAware('Archiving.hasChildArchivesInPeriod.' . $period->getRangeString(), [$idSite]);

core/Db/Schema/Mysql.php

@@ -334,6 +334,25 @@ public function getTablesCreateSql()
                                       ) $tableOptions
             ",
 
+            'archiving_metrics'     => "CREATE TABLE {$prefixTables}archiving_metrics (
+                                      metadataid BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
+                                      idarchive BIGINT UNSIGNED NOT NULL,
+                                      idsite INTEGER UNSIGNED NOT NULL,
+                                      archive_name VARCHAR(255) NOT NULL,
+                                      date1 DATE NOT NULL,
+                                      date2 DATE NOT NULL,
+                                      period TINYINT UNSIGNED NOT NULL,
+                                      ts_started DATETIME NOT NULL,
+                                      ts_finished DATETIME NOT NULL,
+                                      total_time BIGINT UNSIGNED NOT NULL,
+                                      total_time_exclusive BIGINT UNSIGNED NOT NULL,
+                                        PRIMARY KEY(metadataid),
+                                        INDEX index_idarchive(idarchive),
+                                        INDEX index_idsite_archive_name(idsite, archive_name),
+                                        INDEX index_idsite_date1_period(idsite, date1, period)
+                                      ) $tableOptions
+            ",
+
             'archive_invalidations' => "CREATE TABLE `{$prefixTables}archive_invalidations` (
                                             idinvalidation BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
                                             idarchive INTEGER UNSIGNED NULL,

core/Updates/5.7.0-b2.php

@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Updates;
+
+use Piwik\Updater;
+use Piwik\Updater\Migration\Factory as MigrationFactory;
+use Piwik\Updates as PiwikUpdates;
+use Piwik\Updater\Migration;
+
+/**
+ * Update for version 5.7.0-b1
+ */
+class Updates_5_7_0_b2 extends PiwikUpdates
+{
+    /**
+     * @var MigrationFactory
+     */
+    private $migration;
+
+    public function __construct(MigrationFactory $factory)
+    {
+        $this->migration = $factory;
+    }
+
+    /**
+     * @param Updater $updater
+     * @return Migration[]
+     */
+    public function getMigrations(Updater $updater)
+    {
+        return [
+            $this->migration->db->createTable('archiving_metrics', [
+                'metadataid' => 'BIGINT UNSIGNED NOT NULL AUTO_INCREMENT',
+                'idarchive' => 'BIGINT UNSIGNED NOT NULL',
+                'idsite' => 'INTEGER UNSIGNED NOT NULL',
+                'archive_name' => 'VARCHAR(255) NOT NULL',
+                'date1' => 'DATE NOT NULL',
+                'date2' => 'DATE NOT NULL',
+                'period' => 'TINYINT UNSIGNED NOT NULL',
+                'ts_started' => 'DATETIME NOT NULL',
+                'ts_finished' => 'DATETIME NOT NULL',
+                'total_time' => 'BIGINT UNSIGNED NOT NULL',
+                'total_time_exclusive' => 'BIGINT UNSIGNED NOT NULL',
+            ], ['metadataid']),
+            $this->migration->db->addIndex('archiving_metrics', ['idarchive'], 'index_idarchive'),
+            $this->migration->db->addIndex('archiving_metrics', ['idsite', 'archive_name'], 'index_idsite_archive_name'),
+            $this->migration->db->addIndex('archiving_metrics', ['idsite', 'date1', 'period'], 'index_idsite_date1_period'),
+        ];
+    }
+
+    public function doUpdate(Updater $updater)
+    {
+        $updater->executeMigrations(__FILE__, $this->getMigrations($updater));
+    }
+}

core/Version.php

@@ -22,7 +22,7 @@ final class Version
      * The current Matomo version.
      * @var string
      */
-    public const VERSION = '5.7.0-b1';
+    public const VERSION = '5.7.0-b2';
 
     public const MAJOR_VERSION = 5;
 

plugins/ArchivingMetrics/ArchivingMetrics.php

@@ -0,0 +1,64 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\ArchivingMetrics;
+
+use Piwik\Period;
+use Piwik\Segment;
+
+class ArchivingMetrics extends \Piwik\Plugin
+{
+    public function registerEvents()
+    {
+        return [
+            'CoreAdminHome.archiveReports.start' => 'onArchiveReportsStart',
+            'CoreAdminHome.archiveReports.complete' => 'onArchiveReportsComplete',
+        ];
+    }
+
+    public function onArchiveReportsStart(
+        int $idSite,
+        Period $period,
+        Segment $segment,
+        string $plugin,
+        $report,
+        bool $isArchivePhpTriggered
+    ): void {
+        $timer = Timer::getInstance($isArchivePhpTriggered);
+        $context = $this->buildContext($idSite, $period, $segment, $plugin, $report);
+
+        $timer->start($context);
+    }
+
+    /**
+     * @param int[] $idArchives
+     */
+    public function onArchiveReportsComplete(
+        int $idSite,
+        Period $period,
+        Segment $segment,
+        string $plugin,
+        $report,
+        bool $isArchivePhpTriggered,
+        array $idArchives,
+        bool $wasCached
+    ): void {
+        $timer = Timer::getInstance($isArchivePhpTriggered);
+        $context = $this->buildContext($idSite, $period, $segment, $plugin, $report);
+
+        $timer->complete($context, $idArchives, $wasCached);
+    }
+
+    private function buildContext(int $idSite, Period $period, Segment $segment, string $plugin, $report): Context
+    {
+        return new Context($idSite, $period, $segment, $plugin, $report);
+    }
+}

plugins/ArchivingMetrics/Clock/Clock.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\ArchivingMetrics\Clock;
+
+final class Clock implements ClockInterface
+{
+    public function microtime(): float
+    {
+        return microtime(true);
+    }
+}

plugins/ArchivingMetrics/Clock/ClockInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\ArchivingMetrics\Clock;
+
+interface ClockInterface
+{
+    public function microtime(): float;
+}

plugins/ArchivingMetrics/Context.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\ArchivingMetrics;
+
+use Piwik\Period;
+use Piwik\Segment;
+
+final class Context
+{
+    /**
+     * @var int
+     */
+    public $idSite;
+
+    /**
+     * @var Period
+     */
+    public $period;
+
+    /**
+     * @var Segment
+     */
+    public $segment;
+
+    /**
+     * @var string
+     */
+    public $plugin;
+
+    /**
+     * @var false|string|string[]
+     */
+    public $report;
+
+    /**
+     * @param false|string|string[] $report
+     */
+    public function __construct(int $idSite, Period $period, Segment $segment, string $plugin, $report = false)
+    {
+        $this->idSite = $idSite;
+        $this->period = $period;
+        $this->segment = $segment;
+        $this->plugin = $plugin;
+        $this->report = $report;
+    }
+
+    public function getKey(): string
+    {
+        return implode('|', [
+            $this->idSite,
+            $this->period->getLabel(),
+            $this->segment->getString(),
+            $this->period->getDateTimeStart()->toString('Y-m-d'),
+            $this->period->getDateTimeEnd()->toString('Y-m-d'),
+            $this->plugin,
+        ]);
+    }
+}