README

Real-time dashboard and telemetry for CacheerPHP. Instruments your cache layer automatically — no code changes required.

Requirements

PHP 8.1+
CacheerPHP ^5.0

Installation

composer require cacheerphp/monitor

That's it. The package self-registers via Composer's autoload.files — every cache operation on any Cacheer instance is instrumented automatically as soon as vendor/autoload.php is loaded. No code changes required.

Start the Dashboard

vendor/bin/cacheer-monitor serve --port=9966

Open http://127.0.0.1:9966 in your browser.

How It Works

On install, src/Boot/bootstrap.php is registered in Composer's autoloader. When your app loads vendor/autoload.php, the bootstrap runs and calls:

Cacheer::addListener(new CacheerMonitorListener(new JsonlReporter()));

CacheerPHP's built-in event dispatcher fires after every cache operation (put, get, flush, increment, etc.) and the listener writes structured JSONL records to disk. The dashboard server reads those records in real time.

Custom Events File Path

By default, events are written to the path resolved in this order:

CACHEER_MONITOR_EVENTS environment variable
.env file in the project root
System temp dir (sys_get_temp_dir() . '/cacheer-monitor.jsonl')

To use a custom path, override after autoload.php is loaded:

use Silviooosilva\CacheerPhp\Cacheer;
use Cacheer\Monitor\CacheerMonitorListener;
use Cacheer\Monitor\Reporter\JsonlReporter;

Cacheer::removeListeners();
Cacheer::addListener(new CacheerMonitorListener(
    new JsonlReporter('/var/log/myapp/cacheer-events.jsonl')
));

Start the server pointing to the same file:

CACHEER_MONITOR_EVENTS=/var/log/myapp/cacheer-events.jsonl \
  vendor/bin/cacheer-monitor serve --port=9966

Dashboard Features

Hit / Miss rate — real-time ratio across all operations
Operation breakdown — puts, gets, flushes, increments
Top keys — most-accessed cache keys
Event stream — live feed of recent cache events
Driver & namespace view — filter metrics by driver or namespace

REST API

Method	Endpoint	Description
`GET`	`/api/health`	Server health check
`GET`	`/api/config`	Active configuration
`GET`	`/api/metrics`	Aggregated cache metrics
`GET`	`/api/events`	Paginated event log
`DELETE`	`/api/events/clear`	Clear all recorded events
`GET`	`/api/events/stream`	SSE stream of live events

Full API documentation: CacheerPHP - API Reference

CLI Reference

Flag	Default	Description
`--port`	`9966`	Port to listen on
`--host`	`127.0.0.1`	Host to bind to
`--quiet`	—	Suppress request logging

Security Note

The dashboard binds to 127.0.0.1 by default and is intended for local development only. Do not expose it on a public interface without adding authentication.

Documentation

Full documentation: CacheerPHP

License

MIT — see LICENSE.

cacheerphp / monitor

Maintainers

Package info

Statistics

Security