PhabricatorGarbageCollectorDaemon.php
View Options

	<?php

	/**
	* Collects old logs and caches to reduce the amount of data stored in the
	* database.
	*
	* @group daemon
	*/
	final class PhabricatorGarbageCollectorDaemon extends PhabricatorDaemon {

	public function run() {

	// Keep track of when we start and stop the GC so we can emit useful log
	// messages.
	$just_ran = false;

	do {
	$run_at = PhabricatorEnv::getEnvConfig('gcdaemon.run-at');
	$run_for = PhabricatorEnv::getEnvConfig('gcdaemon.run-for');

	// Just use the default timezone, we don't need to get fancy and try
	// to localize this.
	$start = strtotime($run_at);
	if ($start === false) {
	throw new Exception(
	"Configuration 'gcdaemon.run-at' could not be parsed: '{$run_at}'.");
	}

	$now = time();

	if ($now < $start \|\| $now > ($start + $run_for)) {
	if ($just_ran) {
	$this->log("Stopped garbage collector.");
	$just_ran = false;
	}
	// The configuration says we can't collect garbage right now, so
	// just sleep until we can.
	$this->sleep(300);
	continue;
	}

	if (!$just_ran) {
	$this->log("Started garbage collector.");
	$just_ran = true;
	}

	$n_herald = $this->collectHeraldTranscripts();
	$n_daemon = $this->collectDaemonLogs();
	$n_parse = $this->collectParseCaches();
	$n_markup = $this->collectMarkupCaches();
	$n_tasks = $this->collectArchivedTasks();
	$n_cache = $this->collectGeneralCaches();

	$collected = array(
	'Herald Transcript' => $n_herald,
	'Daemon Log' => $n_daemon,
	'Differential Parse Cache' => $n_parse,
	'Markup Cache' => $n_markup,
	'Archived Tasks' => $n_tasks,
	'General Cache Entries' => $n_cache,
	);
	$collected = array_filter($collected);

	foreach ($collected as $thing => $count) {
	$count = number_format($count);
	$this->log("Garbage collected {$count} '{$thing}' objects.");
	}

	$total = array_sum($collected);
	if ($total < 100) {
	// We didn't max out any of the GCs so we're basically caught up. Ease
	// off the GC loop so we don't keep doing table scans just to delete
	// a handful of rows.
	$this->sleep(300);
	} else {
	$this->stillWorking();
	}
	} while (true);

	}

	private function collectHeraldTranscripts() {
	$ttl = PhabricatorEnv::getEnvConfig('gcdaemon.ttl.herald-transcripts');
	if ($ttl <= 0) {
	return 0;
	}

	$table = new HeraldTranscript();
	$conn_w = $table->establishConnection('w');

	queryfx(
	$conn_w,
	'UPDATE %T SET
	objectTranscript = "",
	ruleTranscripts = "",
	conditionTranscripts = "",
	applyTranscripts = "",
	garbageCollected = 1
	WHERE garbageCollected = 0 AND `time` < %d
	LIMIT 100',
	$table->getTableName(),
	time() - $ttl);

	return $conn_w->getAffectedRows();
	}

	private function collectDaemonLogs() {
	$ttl = PhabricatorEnv::getEnvConfig('gcdaemon.ttl.daemon-logs');
	if ($ttl <= 0) {
	return 0;
	}

	$table = new PhabricatorDaemonLogEvent();
	$conn_w = $table->establishConnection('w');

	queryfx(
	$conn_w,
	'DELETE FROM %T WHERE epoch < %d LIMIT 100',
	$table->getTableName(),
	time() - $ttl);

	return $conn_w->getAffectedRows();
	}

	private function collectParseCaches() {
	$key = 'gcdaemon.ttl.differential-parse-cache';
	$ttl = PhabricatorEnv::getEnvConfig($key);
	if ($ttl <= 0) {
	return 0;
	}

	$table = new DifferentialChangeset();
	$conn_w = $table->establishConnection('w');

	queryfx(
	$conn_w,
	'DELETE FROM %T WHERE dateCreated < %d LIMIT 100',
	DifferentialChangeset::TABLE_CACHE,
	time() - $ttl);

	return $conn_w->getAffectedRows();
	}

	private function collectMarkupCaches() {
	$key = 'gcdaemon.ttl.markup-cache';
	$ttl = PhabricatorEnv::getEnvConfig($key);
	if ($ttl <= 0) {
	return 0;
	}

	$table = new PhabricatorMarkupCache();
	$conn_w = $table->establishConnection('w');

	queryfx(
	$conn_w,
	'DELETE FROM %T WHERE dateCreated < %d LIMIT 100',
	$table->getTableName(),
	time() - $ttl);

	return $conn_w->getAffectedRows();
	}

	private function collectArchivedTasks() {
	$key = 'gcdaemon.ttl.task-archive';
	$ttl = PhabricatorEnv::getEnvConfig($key);
	if ($ttl <= 0) {
	return 0;
	}

	$table = new PhabricatorWorkerArchiveTask();
	$data_table = new PhabricatorWorkerTaskData();
	$conn_w = $table->establishConnection('w');

	$rows = queryfx_all(
	$conn_w,
	'SELECT id, dataID FROM %T WHERE dateCreated < %d LIMIT 100',
	$table->getTableName(),
	time() - $ttl);

	if (!$rows) {
	return 0;
	}

	$data_ids = array_filter(ipull($rows, 'dataID'));
	$task_ids = ipull($rows, 'id');

	$table->openTransaction();
	if ($data_ids) {
	queryfx(
	$conn_w,
	'DELETE FROM %T WHERE id IN (%Ld)',
	$data_table->getTableName(),
	$data_ids);
	}
	queryfx(
	$conn_w,
	'DELETE FROM %T WHERE id IN (%Ld)',
	$table->getTableName(),
	$task_ids);
	$table->saveTransaction();

	return count($task_ids);
	}


	private function collectGeneralCaches() {
	$key = 'gcdaemon.ttl.general-cache';
	$ttl = PhabricatorEnv::getEnvConfig($key);
	if ($ttl <= 0) {
	return 0;
	}

	$cache = new PhabricatorKeyValueDatabaseCache();
	$conn_w = $cache->establishConnection('w');

	queryfx(
	$conn_w,
	'DELETE FROM %T WHERE cacheCreated < %d
	ORDER BY cacheCreated ASC LIMIT 100',
	$cache->getTableName(),
	time() - $ttl);

	return $conn_w->getAffectedRows();
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Jan 19 2025, 18:09 (6 w, 4 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1127284
Default Alt Text: PhabricatorGarbageCollectorDaemon.php (5 KB)

PhabricatorGarbageCollectorDaemon.php
No OneTemporary
Actions

PhabricatorGarbageCollectorDaemon.php
View Options

File Metadata

Event Timeline

PhabricatorGarbageCollectorDaemon.phpNo OneTemporaryActions

PhabricatorGarbageCollectorDaemon.phpView Options

File Metadata

Event Timeline

PhabricatorGarbageCollectorDaemon.php
No OneTemporary
Actions

PhabricatorGarbageCollectorDaemon.php
View Options