README

koality.io Magento 2 Plugin can be used to continuously monitor a Magento 2 shop for business metrics. To use this plugin, an active koality.io account is required. After the initial setup, the shop can be monitored easily directly in the koality.io admin area.

Layout in koality.io backend

Metrics

The following metrics are currently implemented:

Minimum orders per hour - this check fails if the number of orders within the last hour falls under a given threshold. The check provides two time intervals. Rush hour and normal shopping time. This is needed to minimize false positives.
Maximum number of open carts - fails if there are to many open carts in the last hour. This check also includes a distinction between rush hours and normal shopping hours. This often happens if the payment fails, and the customers can't finish the buying process.
Minimum number of active products - this check fails if there are not enough active products in the should. This will help find import errors.
Custom Metrics - we are more than happy to discuss the development of custom metrics just for you. Feel free to contact us at customgento.com.

How the plugin works

The plugin provides a JSON endpoint for the Magento storefront that is secured via a secret token. The endpoint returns the health status of the shop.

Example

{
    "status": "fail",
    "output": "Some Magento health metrics failed: ",
    "checks": {
        "carts.open.too_many": {
            "status": "fail",
            "output": "There are too many open carts at the moment.",
            "limit": 30,
            "limitType": "max",
            "observedValue": 60,
            "observedUnit": "carts",
            "metricType": "time_series_numeric"
        },
        "products.active": {
            "status": "pass",
            "output": "There are enough active products in your shop.",
            "limit": 0,
            "limitType": "min",
            "observedValue": 1,
            "observedUnit": "products",
            "metricType": "time_series_numeric"
        },
        "orders.too_few": {
            "status": "fail",
            "output": "There were too few orders within the last hour.",
            "limit": 20,
            "limitType": "min",
            "observedValue": 0,
            "observedUnit": "orders",
            "metricType": "time_series_numeric"
        }
    },
    "info": {
        "creator": "koality.io Magento 2 Plugin",
        "version": "1.0.0",
        "plugin_url": "https://www.koality.io/plugins/magento"
    }
}

koality.io can interpret this format and will alert if a check fails.

The API endpoint can be found here after installation:

https://myshop.com/koality/health/status/<api_key>

The format of the Magento2 health endpoint is implementing this standard (still RFC):

https://tools.ietf.org/html/draft-inadarei-api-health-check-05

Compatibility

Magento >= 2.3

Installation Instructions

composer require customgento/module-koality-m2
bin/magento module:enable Koality_MagentoPlugin
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush

Configuration

To configure the plugin, navigate in your Magento admin panel to Stores -> Configuration -> Services -> Koality. There you find the automatically created API key, which must be inserted in the koality.io backend. It is also possible to create a new key using the Refresh API Key button, if needed.

In the next tab you can define a rush hour if needed. The times should always be chosen in the local timezone.

In the third tab you can define the settings for the orders-per-hour metric. Set the minimal quantity of orders per hour, you expect and also define a value for the rush hour, if needed. The metric will fail, as soon as the number of orders falls below this limit.

In the section for open carts you can set the maximal quantity of open carts. Here it is also possible to define a value for the rush hour, if needed. The metric fails, as soon as there are more open carts than expected.

In the last tab it is possible to enter a minimal expectation for active products. If there are less active products, then entered here, the metric will fail in the koality.io backend.

Support

If you have any issues with this extension, please open a GitHub issue. If you have any issues with koality.io, please contact the koality.io support.

Licence

OSL - Open Software Licence 3.0

customgento / module-koality-m2

Maintainers

Details