Download the PHP package jmonitor/jmonitor-bundle without Composer

Jmonitor Bundle

Integration of the jmonitor/collector library into Symfony to collect metrics from your stack (Php, MySQL, PostgreSQL, Apache / Nginx / Caddy / FrankenPHP, Redis...) and send them to Jmonitor.io.

• Jmonitor.io: https://jmonitor.io
• Collector library (standalone): https://github.com/jmonitor/collector

Requirements

• PHP 8.1+ for this bundle. (The standalone collector library supports PHP 7.4.)
• Symfony 6.4+.

Quick Start

1) Install the bundle:

2) Create a project on https://jmonitor.io and copy your Project API key. 3) Configure your API key and collectors.

4) Run a collection manually to verify. It may be easier to do this in the production environment, since configuring the bundle (or certain collectors) in development is not always possible.

PHP metrics: CLI vs Web context

• PHP settings and extensions can differ significantly between CLI and your web server context.
• If you want metrics that reflect your web runtime, you must expose a tiny HTTP endpoint that returns PHP metrics from within that web context.

To do that, create a route config file:

Set up a firewall for this route before the main firewall to prevent your app from interfering with it:

Wire it in your bundle config

Running the collector

This command runs as a long-lived worker: it periodically collects metrics from the enabled collectors and sends them to Jmonitor.io.

You can also limit how long it runs:

• --memory-limit: stop when the process memory usage exceeds the given limit (e.g. 128M)
• --time-limit: stop after the given number of seconds

You can pass a collector name as an argument to run only that collector — useful for debugging a specific integration:

In production, it is recommended to run this command under a process manager (e.g. Supervisor or systemd) to ensure it is kept running and restarted if necessary. For practical guidance, you can follow Symfony Messenger's recommendations: https://symfony.com/doc/current/messenger.html#deploying-to-production

Logging and Debugging

• The command is resilient: individual collector failures do not crash the whole run; errors are logged (logging must be enabled in config).
• Symfony component collectors (flex, scheduler, messenger) that fail at worker startup are disabled for the lifetime of that worker process and an error is logged. Restart the worker to re-enable them.
• Log levels:
  • Errors (collector exceptions, HTTP responses with status >= 400): error
  • Collected metrics: debug
  • Summary: info

Useful commands:

Troubleshooting

Apache

mod_status is enabled, but my endpoint is not reachable.

Don't forget to let the request pass through your index.php.
For example, if you use .htaccess :

Need help?

• Open an issue on this repo https://github.com/jmonitor/jmonitor-bundle/issues
• Open a discussion on https://github.com/orgs/jmonitor/discussions