README

Synopsis

A lightweight PHP library for tracking execution time and memory usage of your code, with multiple named timers, lap support, human-readable reports, and JSON export. Perfect for benchmarking, profiling, and performance monitoring.

Features

• Start, stop, and lap multiple timers
• Measure memory usage and peak memory
• Human-readable formatting (e.g., 2.45 MB, 125 ms)
• Generate reports for single or all timers
• Export metrics as structured arrays or JSON
• Easy to integrate in any PHP project
• Fully unit-tested

Installation

Install via Composer:

composer require mmantakos/runtime-metrics

Quick Start

<?php

use mmantakos\RuntimeMetrics\RuntimeMetrics;

$metrics = new RuntimeMetrics();

// Start a timer
$metrics->start('api');
usleep(200_000); // simulate work
$metrics->stop('api');

// Report single timer
echo $metrics->report('api'); 
// [api] 200.51 ms, used 8 KB (peak 2 MB)

// Measure using a callback
$metrics->measure(function () {
    usleep(100_000);
}, 'callback');
echo $metrics->report('callback');

// Lap timers
$metrics->start('loop');
usleep(50_000);
echo $metrics->lap('loop'); // ~50 ms
usleep(100_000);
echo $metrics->lap('loop'); // ~100 ms
$metrics->stop('loop');

// Memory intensive operation
$metrics->start('heavy');
$data = range(1, 1000000);
$metrics->stop('heavy');
echo $metrics->report('heavy'); 
// [heavy] 120.23 ms, used 15.3 MB (peak 20.4 MB)

// Report all timers
echo $metrics->reportAll();

// Export as JSON
echo $metrics->toJson(true);
/*
{
    "api": {
        "duration": "200.51 ms",
        "memory": "8 KB",
        "peak": "2 MB"
    },
    "callback": { ... },
    "loop": { ... },
    "heavy": { ... }
}
*/

Methods