PHPackages                             customgento/module-koality-m2 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. customgento/module-koality-m2

AbandonedArchivedMagento2-module[Logging & Monitoring](/categories/logging)

customgento/module-koality-m2
=============================

koality.io Magento 2 Plugin can be used to continuously monitor a Magento 2 shop for business metrics.

1.0.3(2y ago)201OSL-3.0PHPPHP ~7.3.0||~7.4.0||~8.1.0||~8.2.0CI passing

Since Aug 18Pushed 11mo ago3 watchersCompare

[ Source](https://github.com/customgento/module-koality-m2)[ Packagist](https://packagist.org/packages/customgento/module-koality-m2)[ RSS](/packages/customgento-module-koality-m2/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (5)Versions (6)Used By (0)

koality.io Magento 2 Plugin
===========================

[](#koalityio-magento-2-plugin)

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
----------------------------

[](#layout-in-koalityio-backend)

[![Active products](images/active_products.png "Active products")](images/active_products.png)[![Open carts](images/open_carts.png "Open carts")](images/open_carts.png)[![Orders per hour](images/orders_per_hour.png "Orders per hour")](images/orders_per_hour.png)

Metrics
-------

[](#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](https://www.customgento.com/).

How the plugin works
--------------------

[](#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

[](#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/

```

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
-------------

[](#compatibility)

- Magento >= 2.3

Installation Instructions
-------------------------

[](#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
-------------

[](#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.

[![API key configuration](images/api_key_config.png "API key configuration")](images/api_key_config.png)

In the next tab you can define a rush hour if needed. The times should always be chosen in the local timezone. [![Rush hour config](images/rush_hour_config.png "Rush hour config")](images/rush_hour_config.png)

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.

[![Orders per hour config](images/orders_per_hour_config.png "Orders per hour config")](images/orders_per_hour_config.png)

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.

[![Open carts config](images/open_carts_config.png "Open carts config")](images/open_carts_config.png)

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.

[![Active products config](images/active_products_config.png "Active products config")](images/active_products_config.png)

Support
-------

[](#support)

If you have any issues with this extension, please open a [GitHub issue](https://github.com/customgento/module-koality-m2/issues/new). If you have any issues with koality.io, please contact the koality.io support.

Licence
-------

[](#licence)

[OSL - Open Software Licence 3.0](https://opensource.org/licenses/osl-3.0.php)

Copyright
---------

[](#copyright)

© 2021 - present CustomGento GmbH

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance38

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 52.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~153 days

Total

3

Last Release

1056d ago

PHP version history (2 changes)1.0.1PHP ~7.3.0||~7.4.0||~8.1.0

1.0.3PHP ~7.3.0||~7.4.0||~8.1.0||~8.2.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/eb85d8f7d2571d1c913f90b0a4a832eec0c88e8522ec915d5ffe9b92a4e397c8?d=identicon)[sprankhub](/maintainers/sprankhub)

---

Top Contributors

[![norgeindian](https://avatars.githubusercontent.com/u/11156287?v=4)](https://github.com/norgeindian "norgeindian (11 commits)")[![sprankhub](https://avatars.githubusercontent.com/u/930199?v=4)](https://github.com/sprankhub "sprankhub (9 commits)")[![annv99](https://avatars.githubusercontent.com/u/190375859?v=4)](https://github.com/annv99 "annv99 (1 commits)")

---

Tags

magentomagento2magento2-extensionmagento2-extension-freemagento2-modulemonitoringmonitoring-plugins

### Embed Badge

![Health badge](/badges/customgento-module-koality-m2/health.svg)

```
[![Health](https://phpackages.com/badges/customgento-module-koality-m2/health.svg)](https://phpackages.com/packages/customgento-module-koality-m2)
```

###  Alternatives

[smile/elasticsuite

Magento 2 merchandising and search engine built on ElasticSearch

8044.5M33](/packages/smile-elasticsuite)[mollie/magento2

Mollie Payment Module for Magento 2

1121.6M10](/packages/mollie-magento2)[dotdigital/dotdigital-magento2-extension

Dotdigital for Magento 2

50374.2k18](/packages/dotdigital-dotdigital-magento2-extension)[lizardmedia/module-varnish-warmer

Varnish Cache Warmer Magento2 module by Lizard Media

6276.8k](/packages/lizardmedia-module-varnish-warmer)[swissup/module-search-mysql-legacy

Legacy mysql search for magento 2.4

10483.0k](/packages/swissup-module-search-mysql-legacy)[mage-os/module-inventory-reservations-grid

Add a grid with the list of inventory reservations.

126.8k](/packages/mage-os-module-inventory-reservations-grid)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)