Download the PHP package basilicom/koality-bundle without Composer
On this page you can find all versions of the php package basilicom/koality-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download basilicom/koality-bundle
More information about basilicom/koality-bundle
Files in basilicom/koality-bundle
Package koality-bundle
Short Description This Pimcore Bundle can be used to send metrics to koality.io
License MIT
Homepage https://basilicom.de
Informations about the package koality-bundle
Basilicom.de Pimcore - Koality Bundle
General Information
This Pimcore Bundle provides 2 different endpoints (one for business-metrics, one for server-metrics) for the health-check monitoring service of https://www.koality.io/de . See Metrics Section for a detailed overview of the provided metrics.
Usage
composer require basilicom/koality-bundle
Make sure to register the Bundle in AppKernel, e.g.
public function registerBundlesToCollection(BundleCollection $collection) {
$collection->addBundle(new \Basilicom\KoalityBundle\KoalityBundle());
}
How the plugin works
Once installed the Bundle will provide JSON formatted Data under the following endpoints
yourdomain.tu/pimcore-koality-bundle-business
yourdomain.tu/pimcore-koality-bundle-server
either for Business or Server metrics.
If you've set a secret token the endpoints will look as follows
yourdomain.tu/pimcore-koality-bundle-business?token=mySecret
yourdomain.tu/pimcore-koality-bundle-server?token=mySecret
Configuration
Add following config section to your config.yaml
Example JSON Output
Metrics
The following Metrics are implemented yet
Server Metrics
- SpaceUsedCheck - this check fails if the amount of space left on device is below de defined limit.
- UptimeCheck - this check fails if the defined uptime is exceeded (1 year per Default).
- ContainerIsRunningCheck - this check fails if the defined container isn't running.
Business (Pimcore) Metrics
- OrdersPerTimeIntervalCheck - this check measures the number of new orders during a certain time interval. It will fail, if the provided threshold isn't reached.
- NewCartsPerTimeIntervalCheck - this check measures the number of new carts during a certain time interval.
- MaintenanceWorkerRunningCheck - this check provides information on whether the maintenance job has been completed during the past hour.
- DebugModeEnabledCheck - this check indicates whether debug mode is on.
TODO
Add more Pimcore eCommerce Specific Metrics like
- Minimum number of active products (to detect import failures)
- Check for Pimcore Update
- Login attempts during specified time period
- tbc.