PHPackages                             cacheerphp/monitor - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. cacheerphp/monitor

ActiveLibrary

cacheerphp/monitor
==================

Dashboard and telemetry reporter for CacheerPHP.

v1.0.5(today)19↑2566.7%MITPHPPHP >=8.1

Since Apr 3Pushed todayCompare

[ Source](https://github.com/CacheerPHP/monitor)[ Packagist](https://packagist.org/packages/cacheerphp/monitor)[ RSS](/packages/cacheerphp-monitor/feed)WikiDiscussions main Synced today

READMEChangelog (6)Dependencies (2)Versions (12)Used By (0)

Cacheer Monitor
===============

[](#cacheer-monitor)

Real-time dashboard and telemetry for [CacheerPHP](https://github.com/cacheerphp/CacheerPHP). Instruments your cache layer automatically — no code changes required.

[![PHP](https://camo.githubusercontent.com/43a52de372d08e615769aeeed8ba305d51236062c2f310351a08c9805d833f33/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e312532422d3737374242343f7374796c653d666c61742d737175617265266c6f676f3d706870)](https://camo.githubusercontent.com/43a52de372d08e615769aeeed8ba305d51236062c2f310351a08c9805d833f33/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e312532422d3737374242343f7374796c653d666c61742d737175617265266c6f676f3d706870)[![License](https://camo.githubusercontent.com/422db9fd40f5831c765cf6530b6750c081b696bd18d904cf89554df98c676277/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e3f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/422db9fd40f5831c765cf6530b6750c081b696bd18d904cf89554df98c676277/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e3f7374796c653d666c61742d737175617265)[![CacheerPHP](https://camo.githubusercontent.com/2fd907a095467b63f2dedbfa12893a276319936efc074c183ec5f6f0bcb1abed/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f436163686565725048502d253545352e302d626c75653f7374796c653d666c61742d737175617265)](https://github.com/cacheerphp/CacheerPHP)

---

Requirements
------------

[](#requirements)

- PHP 8.1+
- CacheerPHP `^5.0`

---

Installation
------------

[](#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
-------------------

[](#start-the-dashboard)

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

Open  in your browser.

---

How It Works
------------

[](#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
-----------------------

[](#custom-events-file-path)

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

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

Relative paths such as `Tests/cacheer-events.jsonl` are always resolved from the consuming project root, not from `vendor/cacheerphp/monitor`.

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
------------------

[](#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
--------

[](#rest-api)

MethodEndpointDescription`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 eventsFull API documentation: [CacheerPHP - API Reference](https://cacheerphp.com/docs/en/api/)

---

CLI Reference
-------------

[](#cli-reference)

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

Security Note
-------------

[](#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
-------------

[](#documentation)

Full documentation: [CacheerPHP](https://cacheerphp.com/docs/en/cacheer-monitor/)

---

License
-------

[](#license)

MIT — see [LICENSE](LICENSE).

###  Health Score

43

—

FairBetter than 90% of packages

Maintenance100

Actively maintained with recent releases

Popularity8

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

6

Last Release

0d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/acafabb3f98c3e7db56fccf9461fc7085d247c8ff23c177e3eb1182d2f9bcfbe?d=identicon)[silviooosilva](/maintainers/silviooosilva)

---

Top Contributors

[![silviooosilva](https://avatars.githubusercontent.com/u/66147538?v=4)](https://github.com/silviooosilva "silviooosilva (14 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/cacheerphp-monitor/health.svg)

```
[![Health](https://phpackages.com/badges/cacheerphp-monitor/health.svg)](https://phpackages.com/packages/cacheerphp-monitor)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)