Skip to content
← Back to Snippets
Code

System Health Checklist Builder

Builds a compact system health checklist from disk, PHP, database, cache, and queue signals.

Purpose

Builds a compact system health checklist from disk, PHP, database, cache, and queue signals.

Snippet details

ContextSystemLevelAdvancedCopy-and-paste statusMarked safe after review.

Categories

  • Security

Code

<?php

/*
 * Copyright (c) 2026 Jeffery L. Paris <jparis@phpog.com>.
 * Free for personal and internal use. Paid project use requires visible credit
 * to Jeffery L. Paris. Corporate use requires a paid license fee unless a
 * separate written license states otherwise.
 */

/**
 * System Health Checklist Builder.
 *
 * Purpose:
 * Builds a compact system health checklist from disk, PHP, database, cache, and queue signals.
 *
 * @param array $signals Service health signals.
 * @return array Health checklist rows and overall status.
 */
function ogSnippetSystemHealthChecklistBuilder(array $signals): array {
	$checks = array();
	$overall = 'ok';
	foreach ($signals as $name => $signal) {
		$status = 'ok';
		if (isset($signal['ok']) && $signal['ok'] === false) {
			$status = 'fail';
			$overall = 'fail';
		}
		$detail = '';
		if (isset($signal['detail'])) {
			$detail = (string) $signal['detail'];
		}
		$checks[] = array('name' => (string) $name, 'status' => $status, 'detail' => $detail);
	}
	return array('overall' => $overall, 'checks' => $checks);
}

$health = ogSnippetSystemHealthChecklistBuilder(array('disk' => array('ok' => true, 'detail' => '74% free'), 'queue' => array('ok' => false, 'detail' => 'delayed')));
echo $health['overall'];