jmonitoring/jmonitor

Simple php web server monitoring library

dev-master 2025-07-15 21:09 UTC

Requires

• php: ^7.3|^8.0
• ext-json: *
• php-http/discovery: ^1.17
• psr/http-client: ^1.0
• psr/http-client-implementation: *
• psr/http-factory-implementation: *

Requires (Dev)

• ext-pdo: *
• doctrine/dbal: ^3.0|^4.2
• nyholm/psr7: ^1.8
• php-http/message: ^1.0
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.0|^10.0|^11.5
• predis/predis: ^3.0
• symfony/http-client: ^5.4.45 || ^6.4 || ^7.0

Suggests

• ext-pdo: If you want to collect mysql datas with Pdo as driver.
• doctrine/dbal: If you want to collect mysql datas with Doctrine DBAL as driver.

AGPL-3.0-or-later

• Johndodev

• redis
• php
• mysql
• monitoring
• Metrics
• system
• apache
• nginx

README

Easy monitoring for PHP web server.

Getting Started

To get started, require the project using Composer.
It should install for you a PSR-18 httpclient for you if you don't have one already.

composer require jmonitoring/jmonitor

use Jmonitor\Jmonitor;
use Jmonitor\Collector\Apache\ApacheCollector;

$jmonitor = new Jmonitor('apiKey');

// Add some collectors 
$jmonitor->addCollector(new ApacheCollector('https://example.com/server-status'));
$jmonitor->addCollector(new SystemCollector());
// see the documentation below for more collectors

// send metrics periodically to jmonitor (ex. every 15 seconds)
$jmonitor->collect();

You can customize yout HttpClient, for example, if you want to use the Symfony HttpClient or Guzzle.

composer require symfony/http-client nyholm/psr7

use Symfony\Component\HttpClient\Psr18Client;

$httpClient = ... // create or retrieve your Symfony HttpClient instance
$client = new Psr18Client()->withOptions(...);

$jmonitor = new Jmonitor('apiKey', $client);

Collectors

• System

  Collects system metrics like CPU usage, memory usage, disk usage, etc.
  Only Linux is supported for now, feel free to open an issue if you need support for another OS.

  use Jmonitor\Collector\System\SystemCollector;
    
  $collector = new SystemCollector();

• Apache

  Collects Apache server metrics from a server status URL.
  You'll need to enable the mod_status module in Apache and set up a server status URL. There are some resources to help you with that:

  • Apache doc :https://httpd.apache.org/docs/current/mod/mod_status.html.
  • Blogpost in English : https://statuslist.app/apache/apache-status-page-simple-setup-guide/
  • Blogpost in French : https://www.blog.florian-bogey.fr/activer-et-configurer-le-server-status-apache-mod_status.html

  Then you'll be able to use the ApacheCollector class to collect metrics from the server status URL.

  use Jmonitor\Collector\Apache\ApacheCollector;
  
  $collector = new ApacheCollector('https://example.com/server-status');

• Mysql

  Collects MySQL server variables and status.
  You'll need to use PDO or Doctrine to connect to your MySQL database. If you need support for other drivers, like Mysqli, please open an issue.

  use Jmonitor\Collector\Mysql\MysqlCollector;
  use Jmonitor\Collector\Mysql\Adapter\PdoAdapter;
  use Jmonitor\Collector\Mysql\Adapter\DoctrineAdapter;
  use Jmonitor\Collector\Mysql\MysqlStatusCollector;
  use Jmonitor\Collector\Mysql\MysqlVariablesCollector;
  use Jmonitor\Collector\Mysql\MysqlQueriesCountCollector;
  
  // with PDO
  $adapter = new PdoAdapter($pdo); // retrieve your \PDO connection
  
  // or Doctrine DBAL
  $adapter = new DoctrineAdapter($connection) /* retrieve your Doctrine\DBAL\Connection connection*/ );
  
  // Mysql has multiple collectors, use the same adapter for all of them
  $collector = new MysqlStatusCollector($adapter);
  $collector = new MysqlVariablesCollector($adapter);
  $collector = new MysqlQueriesCountCollector($adapter, 'your_db_name');

• Php

  Collects PHP metrics like loaded extensions, some ini settings, opcache status, etc.
  Php FPM status URL support is coming soon.

  use Jmonitor\Collector\Php\PhpCollector
  
  $collector = new PhpCollector();

• Redis

  Collects Redis metrics from info command.

  use Jmonitor\Collector\Redis\RedisCollector;
  
  // You can use any Redis client that supports the info command, like Predis or PhpRedis.
  $redisClient = new \Redis([...]);
  $redisClient = new Predis\Client();
  // also support \RedisArray, \RedisCluster, Relay... feel free to open an issue if you need support for another client.
  
  $collector = new RedisCollector($redis);