PingThis
, (*1)
PingThis is a lightweight PHP 7.2+ tool to build simple but functional headless monitoring systems., (*2)
Example
``` php
use PingThis\Daemon;
use PingThis\Alarm\PhpEmailAlarm;
use PingThis\Ping\NetworkPing;
use PingThis\Ping\WebScraperPing;
use PingThis\Ping\DatabasePing;
use PingThis\Ping\TlsCertificateExpirationPing;, (*3)
$daemon = new Daemon();, (*4)
// Check if the host correctly answers to ping every 10 seconds
$daemon->registerPing(new NetworkPing(10, 'domain.com'));, (*5)
// Check if a webserver responds correctly to a HTTP request every 30 seconds
$daemon->registerPing(new WebScraperPing(30, 'GET', 'http://domain.com', 'response.getStatusCode() == 200'));
$daemon->registerPing(new WebScraperPing(30, 'GET', 'http://domain.com', 'content.filter(".css").count()'));, (*6)
// Or equivalently using any PHP callable
$daemon->registerPing(new WebScraperPing(30, 'GET', 'http://domain.com', function ($response, $content) {
return $response->getStatus() < 400 && $content->filter('.element')->text() === "Hello";
}));, (*7)
// Check every day that a certificate won't expire during the next week
$daemon->registerPing(new TlsCertificateExpirationPing(86400, 'domain.com', 443, TlsCertificateExpirationPing::IMPLICIT_TLS, '+7 days'));, (*8)
// Check if a remote SQL server is still up every 10 seconds
$daemon->registerPing(new DatabasePing(10, 'mysql:host=my.sql.server', 'login', 'password'));, (*9)
// Otherwise send an email to alert an admin
$daemon->registerAlarm(new PhpEmailAlarm('your@email.com'));, (*10)
$daemon->run();, (*11)
## Quick description
PingThis aims to provide a simple and effective way for monitoring whatever you want.
Configure a daemon with one Alarm and one or multiple Pings. The Daemon periodically
verifies each Ping and, in case of failing, triggers the Alarm. Any class could act
like an Alarm or a Ping, provided that it implements respectively the `AlarmInterface`
or the `PingInterface`.
The different built-in Pings rely on Symfony's [Expression Language Component](https://symfony.com/doc/current/components/expression_language.html)
to allow a quick and easy construction of triggering logic but can be equivalently replaced
by a PHP callable.
## Built-in Pings
### Network
Name | Description
:------------------------------ | :---------------------------------------------------------------------------------------
NetworkPing | Sends a standard ICMP ping and checks the ICMP response
StreamSocketCommandPing | Sends a custom payload through a TCP/UDP/Unix socket and checks the response
TlsCertificateExpirationPing | Initiates a TLS handshake and checks the expiration date of a certificate
SnmpGetValuePing | Gets SNMP object value from a remote SNMP agent
SnmpWalkValuePing | Gets SNMP object values from a remote SNMP agent
### Web
Name | Description
:------------------------------ | :---------------------------------------------------------------------------------------
DatabasePing | Establishes a connection to a database using PDO
DatabaseQueryPing | Executes a SQL query on a database using PDO
HttpPing | Sends a HTTP request and checks only the returned code
WebScraperPing | Sends a HTTP request and get back a [Response](http://api.symfony.com/2.8/Symfony/Component/BrowserKit/Response.html), along with a [Crawler](http://symfony.com/doc/2.8/components/dom_crawler.html) instance
### Mails
Name | Description
:------------------------------ | :---------------------------------------------------------------------------------------
ImapServerPing | Connects to a IMAP server and checks the welcome response
SmtpServerPing | Connects to a SMTP server and checks the welcome response
### Other services
Name | Description
:------------------------------ | :---------------------------------------------------------------------------------------
LdapSearchPing | Executes a query on a LDAP server and checks the response
### Built-in Alarms
Name | Description
:-------------- | :---------------------------------------------------------------------------------------
PhpEmailAlarm | Send an email, using the PHP's mail() function
StreamAlarm | Logs the alarms events to a given open stream (stdout or file for instance)
LogAlarm | Specialized StreamAlarm for files that adds a lock on the log file
ParallelAlarm | Dispatch the alert on multiple other Alarm instances
## Installation
The recommended way to install PingThis is through Composer :
composer require bpmconcept/ping-this
```, (*12)
PingThis does not intend to provide a fully functional daemon out of the box. You are
still responsible for writing a configured daemon like in the previous example. Thereafter,
a real daemon can be registered to your favorite init system like systemd,
upstart or supervisor., (*13)
Wallogit.com
