Download the PHP package ilyaplot/pulse without Composer
On this page you can find all versions of the php package ilyaplot/pulse. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package pulse
Pulse
Pulse allows you to easily write healthchecks for your application and display a simple, aggregated report so you can quickly diagnose whether and why your app is having trouble (or whether you can blame someone else). You can also monitor your healthchecks with nagios, zabbix, etc.
Wait, what's a healthcheck?
Healthchecks are a great way to test system health and connectivity to other services. For example, you can verify connectivity to memcache or mysql, that your app can read / write to certain files, or that your API key for a third-party service is still working.
Installation
You can install this into your project using composer. Create a composer.json
file in the root of your project and add the following:
Include vendor/autoload.php
, and you're off to the races!
Warnings
For non-critical checks you can use a warning and you'll get status 200 even if these fail. Use these to see when your app is experiencing service degredation but is still available. Warning checks must return boolean true
or false
.
Information
Custom Rules
You can also create your own custom rules by extending the ilyaplot\pulse\rules\AbstractRule
class or implementing ilyaplot\pulse\rules\RuleInterface
.
For example, you could create a rule that checks that your app can connect to a third-party service.
Then you can add it to your healthcheck:
Examples
You can see some very basic example healthchecks in examples/cli-usage.php
and examples/http-usage.php
.
Does Pulse Work With X?
Yep. Pulse is designed to be self-contained and is very simple, so it doesn't require you to use any particular framework. You are free to include other things like yml parsers, etc. if you choose, but we recommend NOT including a full framework stack on top of it. If the framework fails to load for some reason, your healthchecks won't be displayed, meaning they're not useful for diagnosing whatever problem you've encountered.
Won't This Expose Information About My App?
Potentially. You probably don't want to display the healthcheck results to the public. Instead, you could whitelist certain IPs.