feat(jobs): allow to keep track of job executions

Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
2026-06-09 00:32:29 -04:00 · 2026-05-27 11:28:00 +02:00 · 2026-05-27 11:28:00 +02:00 · 4ee75168d5
commit 4ee75168d5
parent e5d91cc64e
9 changed files with 399 additions and 0 deletions
--- a/core/Command/Background/RunningJobs.php
+++ b/core/Command/Background/RunningJobs.php
@ -0,0 +1,92 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\Core\Command\Background;
+
+use OC\BackgroundJob\JobRuns;
+use OC\Core\Command\Base;
+use OCP\IConfig;
+use Override;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+final class RunningJobs extends Base {
+	public function __construct(
+		private readonly JobRuns $jobRuns,
+		private IConfig $config,
+	) {
+		parent::__construct();
+	}
+
+	#[Override]
+	protected function configure(): void {
+		parent::configure();
+
+		$help = <<<EOF
+			Display all currently running background jobs.
+
+			You can find the following informations:
+			  - <info>Run ID:</info> job identifier a found in database (Snowflake ID)
+			  - <info>Class:</info> class of the job
+			  - <info>Started at:</info> start time of the job
+			  - <info>Server ID:</info> server ID as defined in <options=bold>config.php</> (see `serverid`). Highlighted if it’s running on current server.
+			  - <info>PID:</info> PID of process executing the job
+			  - <info>Running since:</info> human readable elapsed time since job started
+
+			EOF;
+
+		$this
+			->setName('background-job:running')
+			->setDescription('Show currently running jobs')
+			->setHelp($help)
+			->addOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Maximum number of results returned by the command', 200);
+	}
+
+	#[Override]
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$limit = (int)$input->getOption('limit');
+		$jobs = $this->jobRuns->runningJobs($limit);
+		$this->writeStreamingTableInOutputFormat($input, $output, $this->formatLine($jobs), 20);
+
+		return Base::SUCCESS;
+	}
+
+	private function formatLine(iterable $jobs): \Generator {
+		$now = time();
+		$currentServerId = $this->config->getSystemValueInt('serverid', -1);
+		foreach ($jobs as $job) {
+			yield [
+				'Run ID' => $job->runId,
+				'Class' => $job->className,
+				'Started at' => $job->startedAt->format('Y-m-d H:i:s'),
+				'Server ID' => $job->serverId === $currentServerId ? '<info>' . $job->serverId . '</info>' : $job->serverId,
+				'PID' => $job->pid,
+				'Running since' => $this->formatDuration($now - $job->startedAt->format('U')),
+			];
+		}
+	}
+
+	/**
+	 * TODO Move this function to utils class with better formatting (plural, i18n…)
+	 */
+	private function formatDuration(int $seconds): string {
+		if ($seconds < 60) {
+			return sprintf('%d seconds', $seconds);
+		}
+		if ($seconds < 3600) {
+			return sprintf('%d minutes', $seconds / 60);
+		}
+		if ($seconds < (3600 * 24)) {
+			return sprintf('> %d hours', $seconds / 3600);
+		}
+
+		return sprintf('> %d days', $seconds / (3600 * 24));
+	}
+}
--- a/core/Migrations/Version34000Date20260521110333.php
+++ b/core/Migrations/Version34000Date20260521110333.php
@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\Core\Migrations;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\Attributes\AddIndex;
+use OCP\Migration\Attributes\CreateTable;
+use OCP\Migration\Attributes\IndexType;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+use Override;
+
+#[CreateTable(
+	table: 'job_runs',
+	columns: ['class_id', 'pid', 'status', 'duration', 'ram_peak_usage'],
+	description: 'New table to store executions of background jobs',
+)]
+#[AddIndex(table: 'job_runs', type: IndexType::PRIMARY)]
+#[AddIndex(table: 'job_runs', type: IndexType::INDEX, description: 'Allows to search on job status')]
+class Version34000Date20260521110333 extends SimpleMigrationStep {
+	#[Override]
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		if (!$schema->hasTable('job_runs')) {
+			$table = $schema->createTable('job_runs');
+			$table->addColumn('run_id', Types::BIGINT, [
+				'notnull' => true,
+				'unsigned' => true,
+			]);
+			$table->addColumn('class_id', Types::BIGINT, ['notnull' => true]);
+			$table->addColumn('pid', Types::INTEGER, ['notnull' => true]); // Should be MEDIUMINT
+			$table->addColumn('status', Types::SMALLINT, ['notnull' => true]); // Should be TINYINT
+			$table->addColumn('duration', Types::INTEGER, ['notnull' => true, 'default' => 0]);
+			$table->addColumn('ram_peak_usage', Types::INTEGER, ['notnull' => true, 'default' => 0]); // Should be MEDIUMINT
+			$table->setPrimaryKey(['run_id']);
+			$table->addIndex(['status'], 'status');
+
+			return $schema;
+		}
+
+		return null;
+	}
+}
--- a/core/register_command.php
+++ b/core/register_command.php
@ -20,6 +20,7 @@ use OC\Core\Command\Background\Job;
 use OC\Core\Command\Background\JobWorker;
 use OC\Core\Command\Background\ListCommand;
 use OC\Core\Command\Background\Mode;
+use OC\Core\Command\Background\RunningJobs;
 use OC\Core\Command\Broadcast\Test;
 use OC\Core\Command\Check;
 use OC\Core\Command\Config\App\DeleteConfig;
@ -148,6 +149,7 @@ if ($config->getSystemValueBool('installed', false)) {
 	$application->add(Server::get(ListCommand::class));
 	$application->add(Server::get(Delete::class));
 	$application->add(Server::get(JobWorker::class));
+	$application->add(Server::get(RunningJobs::class));

 	$application->add(Server::get(Test::class));

--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@ -200,8 +200,10 @@ return array(
    'OCP\\AutoloadNotAllowedException' => $baseDir . '/lib/public/AutoloadNotAllowedException.php',
    'OCP\\BackgroundJob\\IJob' => $baseDir . '/lib/public/BackgroundJob/IJob.php',
    'OCP\\BackgroundJob\\IJobList' => $baseDir . '/lib/public/BackgroundJob/IJobList.php',
+    'OCP\\BackgroundJob\\IJobRuns' => $baseDir . '/lib/public/BackgroundJob/IJobRuns.php',
    'OCP\\BackgroundJob\\IParallelAwareJob' => $baseDir . '/lib/public/BackgroundJob/IParallelAwareJob.php',
    'OCP\\BackgroundJob\\Job' => $baseDir . '/lib/public/BackgroundJob/Job.php',
+    'OCP\\BackgroundJob\\JobRun' => $baseDir . '/lib/public/BackgroundJob/JobRun.php',
    'OCP\\BackgroundJob\\JobStatus' => $baseDir . '/lib/public/BackgroundJob/JobStatus.php',
    'OCP\\BackgroundJob\\QueuedJob' => $baseDir . '/lib/public/BackgroundJob/QueuedJob.php',
    'OCP\\BackgroundJob\\TimedJob' => $baseDir . '/lib/public/BackgroundJob/TimedJob.php',
@ -1253,6 +1255,7 @@ return array(
    'OC\\Avatar\\UserAvatar' => $baseDir . '/lib/private/Avatar/UserAvatar.php',
    'OC\\BackgroundJob\\JobClassesRegistry' => $baseDir . '/lib/private/BackgroundJob/JobClassesRegistry.php',
    'OC\\BackgroundJob\\JobList' => $baseDir . '/lib/private/BackgroundJob/JobList.php',
+    'OC\\BackgroundJob\\JobRuns' => $baseDir . '/lib/private/BackgroundJob/JobRuns.php',
    'OC\\BinaryFinder' => $baseDir . '/lib/private/BinaryFinder.php',
    'OC\\Blurhash\\Listener\\GenerateBlurhashMetadata' => $baseDir . '/lib/private/Blurhash/Listener/GenerateBlurhashMetadata.php',
    'OC\\Broadcast\\Events\\BroadcastEvent' => $baseDir . '/lib/private/Broadcast/Events/BroadcastEvent.php',
@ -1335,6 +1338,7 @@ return array(
    'OC\\Core\\Command\\Background\\JobWorker' => $baseDir . '/core/Command/Background/JobWorker.php',
    'OC\\Core\\Command\\Background\\ListCommand' => $baseDir . '/core/Command/Background/ListCommand.php',
    'OC\\Core\\Command\\Background\\Mode' => $baseDir . '/core/Command/Background/Mode.php',
+    'OC\\Core\\Command\\Background\\RunningJobs' => $baseDir . '/core/Command/Background/RunningJobs.php',
    'OC\\Core\\Command\\Base' => $baseDir . '/core/Command/Base.php',
    'OC\\Core\\Command\\Broadcast\\Test' => $baseDir . '/core/Command/Broadcast/Test.php',
    'OC\\Core\\Command\\Check' => $baseDir . '/core/Command/Check.php',
@ -1614,6 +1618,7 @@ return array(
    'OC\\Core\\Migrations\\Version34000Date20260318095645' => $baseDir . '/core/Migrations/Version34000Date20260318095645.php',
    'OC\\Core\\Migrations\\Version34000Date20260415161745' => $baseDir . '/core/Migrations/Version34000Date20260415161745.php',
    'OC\\Core\\Migrations\\Version34000Date20260518163022' => $baseDir . '/core/Migrations/Version34000Date20260518163022.php',
+    'OC\\Core\\Migrations\\Version34000Date20260521110333' => $baseDir . '/core/Migrations/Version34000Date20260521110333.php',
    'OC\\Core\\Notification\\CoreNotifier' => $baseDir . '/core/Notification/CoreNotifier.php',
    'OC\\Core\\ResponseDefinitions' => $baseDir . '/core/ResponseDefinitions.php',
    'OC\\Core\\Service\\CronService' => $baseDir . '/core/Service/CronService.php',
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@ -241,8 +241,10 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
        'OCP\\AutoloadNotAllowedException' => __DIR__ . '/../../..' . '/lib/public/AutoloadNotAllowedException.php',
        'OCP\\BackgroundJob\\IJob' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/IJob.php',
        'OCP\\BackgroundJob\\IJobList' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/IJobList.php',
+        'OCP\\BackgroundJob\\IJobRuns' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/IJobRuns.php',
        'OCP\\BackgroundJob\\IParallelAwareJob' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/IParallelAwareJob.php',
        'OCP\\BackgroundJob\\Job' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/Job.php',
+        'OCP\\BackgroundJob\\JobRun' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/JobRun.php',
        'OCP\\BackgroundJob\\JobStatus' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/JobStatus.php',
        'OCP\\BackgroundJob\\QueuedJob' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/QueuedJob.php',
        'OCP\\BackgroundJob\\TimedJob' => __DIR__ . '/../../..' . '/lib/public/BackgroundJob/TimedJob.php',
@ -1294,6 +1296,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
        'OC\\Avatar\\UserAvatar' => __DIR__ . '/../../..' . '/lib/private/Avatar/UserAvatar.php',
        'OC\\BackgroundJob\\JobClassesRegistry' => __DIR__ . '/../../..' . '/lib/private/BackgroundJob/JobClassesRegistry.php',
        'OC\\BackgroundJob\\JobList' => __DIR__ . '/../../..' . '/lib/private/BackgroundJob/JobList.php',
+        'OC\\BackgroundJob\\JobRuns' => __DIR__ . '/../../..' . '/lib/private/BackgroundJob/JobRuns.php',
        'OC\\BinaryFinder' => __DIR__ . '/../../..' . '/lib/private/BinaryFinder.php',
        'OC\\Blurhash\\Listener\\GenerateBlurhashMetadata' => __DIR__ . '/../../..' . '/lib/private/Blurhash/Listener/GenerateBlurhashMetadata.php',
        'OC\\Broadcast\\Events\\BroadcastEvent' => __DIR__ . '/../../..' . '/lib/private/Broadcast/Events/BroadcastEvent.php',
@ -1376,6 +1379,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
        'OC\\Core\\Command\\Background\\JobWorker' => __DIR__ . '/../../..' . '/core/Command/Background/JobWorker.php',
        'OC\\Core\\Command\\Background\\ListCommand' => __DIR__ . '/../../..' . '/core/Command/Background/ListCommand.php',
        'OC\\Core\\Command\\Background\\Mode' => __DIR__ . '/../../..' . '/core/Command/Background/Mode.php',
+        'OC\\Core\\Command\\Background\\RunningJobs' => __DIR__ . '/../../..' . '/core/Command/Background/RunningJobs.php',
        'OC\\Core\\Command\\Base' => __DIR__ . '/../../..' . '/core/Command/Base.php',
        'OC\\Core\\Command\\Broadcast\\Test' => __DIR__ . '/../../..' . '/core/Command/Broadcast/Test.php',
        'OC\\Core\\Command\\Check' => __DIR__ . '/../../..' . '/core/Command/Check.php',
@ -1655,6 +1659,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
        'OC\\Core\\Migrations\\Version34000Date20260318095645' => __DIR__ . '/../../..' . '/core/Migrations/Version34000Date20260318095645.php',
        'OC\\Core\\Migrations\\Version34000Date20260415161745' => __DIR__ . '/../../..' . '/core/Migrations/Version34000Date20260415161745.php',
        'OC\\Core\\Migrations\\Version34000Date20260518163022' => __DIR__ . '/../../..' . '/core/Migrations/Version34000Date20260518163022.php',
+        'OC\\Core\\Migrations\\Version34000Date20260521110333' => __DIR__ . '/../../..' . '/core/Migrations/Version34000Date20260521110333.php',
        'OC\\Core\\Notification\\CoreNotifier' => __DIR__ . '/../../..' . '/core/Notification/CoreNotifier.php',
        'OC\\Core\\ResponseDefinitions' => __DIR__ . '/../../..' . '/core/ResponseDefinitions.php',
        'OC\\Core\\Service\\CronService' => __DIR__ . '/../../..' . '/core/Service/CronService.php',
--- a/lib/private/BackgroundJob/JobRuns.php
+++ b/lib/private/BackgroundJob/JobRuns.php
@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OC\BackgroundJob;
+
+use OCP\BackgroundJob\IJobRuns;
+use OCP\BackgroundJob\JobRun;
+use OCP\BackgroundJob\JobStatus;
+use OCP\IDBConnection;
+use OCP\Snowflake\ISnowflakeDecoder;
+use OCP\Snowflake\ISnowflakeGenerator;
+use Override;
+
+final readonly class JobRuns implements IJobRuns {
+	private const TABLE = 'job_runs';
+
+	public function __construct(
+		private IDBConnection $connection,
+		private ISnowflakeGenerator $snowflakeGenerator,
+		private ISnowflakeDecoder $snowflakeDecoder,
+		private JobClassesRegistry $classesRegistry,
+	) {
+	}
+
+	#[Override]
+	public function started(int|string $classId): string {
+		$id = $this->snowflakeGenerator->nextId();
+		$qb = $this->connection->getQueryBuilder();
+		$qb
+			->insert(self::TABLE)
+			->setValue('run_id', $id)
+			->setValue('class_id', $qb->createNamedParameter($classId))
+			->setValue('pid', $qb->createNamedParameter(posix_getpid()))
+			->setValue('status', $qb->createNamedParameter(JobStatus::RUNNING->value))
+			->executeStatement();
+
+		return $id;
+	}
+
+	#[Override]
+	public function finished(int|string $runId, int $duration, int $memoryPeakUsage, JobStatus $status = JobStatus::SUCCEEDED): bool {
+		$qb = $this->connection->getQueryBuilder();
+		$result = $qb
+			->update(self::TABLE)
+			->set('status', $qb->createNamedParameter($status->value))
+			->set('duration', $qb->createNamedParameter($duration))
+			->set('ram_peak_usage', $qb->createNamedParameter($memoryPeakUsage))
+			->where($qb->expr()->eq('run_id', $qb->createNamedParameter($runId)))
+			->executeStatement();
+
+		return $result === 1;
+	}
+
+	#[Override]
+	public function runningJobs(int $limit = 200): \Generator {
+		$qb = $this->connection->getQueryBuilder();
+		$result = $qb
+			->select('run_id', 'class_id', 'pid', 'status')
+			->from(self::TABLE)
+			->where($qb->expr()->eq('status', $qb->createNamedParameter(JobStatus::RUNNING->value)))
+			->setMaxResults($limit)
+			->executeQuery();
+
+		foreach ($result->iterateAssociative() as $row) {
+			$snowflakeInfo = $this->snowflakeDecoder->decode((string)$row['run_id']);
+			yield new JobRun(
+				$row['run_id'],
+				$this->classesRegistry->getName($row['class_id']),
+				$snowflakeInfo->getServerId(),
+				(int)$row['pid'],
+				$snowflakeInfo->getCreatedAt(),
+				JobStatus::from((int)$row['status']),
+			);
+		}
+	}
+}
--- a/lib/public/BackgroundJob/IJobRuns.php
+++ b/lib/public/BackgroundJob/IJobRuns.php
@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\BackgroundJob;
+
+/**
+ * List executed jobs
+ *
+ * Keep track of background jobs: start time, resource used, exit status…
+ *
+ * @since 34.0.0
+ */
+interface IJobRuns {
+	/**
+	 * List of currently running jobs
+	 *
+	 * @since 34.0.0
+	 */
+	public function runningJobs(int $limit = 200): \Generator;
+}
--- a/lib/public/BackgroundJob/JobRun.php
+++ b/lib/public/BackgroundJob/JobRun.php
@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\BackgroundJob;
+
+use DateTimeImmutable;
+
+/**
+ * Job run
+ *
+ * Information about the execution of a single job
+ *
+ * @since 34.0.0
+ */
+final readonly class JobRun {
+	/**
+	 * Constructor
+	 *
+	 * @since 34.0.0
+	 */
+	public function __construct(
+		/** Run ID (Snowflake ID) */
+		public int|string $runId,
+		/** Class name */
+		public string $className,
+		/** Server ID */
+		public int $serverId,
+		/** Process ID on server */
+		public int $pid,
+		/** Job start time */
+		public DateTimeImmutable $startedAt,
+		/** Job status (running, fail…) */
+		public JobStatus $status,
+		/** Job duration in milliseconds */
+		public ?int $duration = null,
+		/** Job memory usage peak in kilobytes (base 10) */
+		public ?int $memoryPeak = null,
+	) {
+	}
+}
--- a/tests/lib/BackgroundJob/JobRunsTest.php
+++ b/tests/lib/BackgroundJob/JobRunsTest.php
@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace Test\BackgroundJob;
+
+use OC\BackgroundJob\JobClassesRegistry;
+use OC\BackgroundJob\JobRuns;
+use OCP\BackgroundJob\JobRun;
+use OCP\BackgroundJob\JobStatus;
+use OCP\IDBConnection;
+use OCP\Server;
+use OCP\Snowflake\ISnowflakeDecoder;
+use OCP\Snowflake\ISnowflakeGenerator;
+use Override;
+use Test\TestCase;
+
+/**
+ * @package Test\BackgroundJob
+ */
+#[\PHPUnit\Framework\Attributes\Group('DB')]
+class JobRunsTest extends TestCase {
+	private IDBConnection $connection;
+	private JobClassesRegistry $registry;
+	private JobRuns $runs;
+
+	#[Override]
+	protected function setUp(): void {
+		parent::setUp();
+
+		$this->connection = Server::get(IDBConnection::class);
+		$this->registry = Server::get(JobClassesRegistry::class);
+		$this->runs = new JobRuns(
+			$this->connection,
+			Server::get(ISnowflakeGenerator::class),
+			Server::get(ISnowflakeDecoder::class),
+			$this->registry,
+		);
+	}
+
+	public function testJobStarted(): void {
+		$myPid = 1337;
+		$myClass = DummyJob::class;
+
+		$runId = $this->runs->started($this->registry->getId(DummyJob::class), $myPid);
+
+		$this->assertGreaterThan(0, $runId);
+	}
+
+	public function testJobSucceeded(): void {
+		$myPid = 1337;
+		$myClass = DummyJob::class;
+
+		$runId = $this->runs->started($this->registry->getId(DummyJob::class), $myPid);
+
+		$result = $this->runs->finished($runId, 12, 9876543);
+
+		$this->assertTrue($result);
+	}
+
+	public function testJobFailed(): void {
+		$myPid = 1337;
+		$myClass = DummyJob::class;
+
+		$runId = $this->runs->started($this->registry->getId(DummyJob::class), $myPid);
+
+		$result = $this->runs->finished($runId, 13, 87654321, JobStatus::FAILED);
+
+		$this->assertTrue($result);
+	}
+
+	public function testRunningJobs(): void {
+		$myPid = 1337;
+		$myClass = DummyJob::class;
+
+		$runId = $this->runs->started($this->registry->getId(DummyJob::class), $myPid);
+
+		$runningJobs = 0;
+		foreach ($this->runs->runningJobs() as $job) {
+			$this->assertInstanceOf(JobRun::class, $job);
+			++$runningJobs;
+		}
+		$this->assertGreaterThan(0, $runningJobs);
+	}
+}