PHPackages                             basilicom/koality-bundle - 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. basilicom/koality-bundle

ActivePimcore-bundle

basilicom/koality-bundle
========================

This Pimcore Bundle can be used to send metrics to koality.io

v1.0.2(5y ago)001[2 PRs](https://github.com/basilicom/koality-bundle/pulls)MITPHP

Since Apr 12Pushed 3y ago5 watchersCompare

[ Source](https://github.com/basilicom/koality-bundle)[ Packagist](https://packagist.org/packages/basilicom/koality-bundle)[ Docs](https://basilicom.de)[ RSS](/packages/basilicom-koality-bundle/feed)WikiDiscussions main Synced 4d ago

READMEChangelog (5)Dependencies (1)Versions (8)Used By (0)

Basilicom.de Pimcore - Koality Bundle
=====================================

[](#basilicomde-pimcore---koality-bundle)

### General Information

[](#general-information)

This Pimcore Bundle provides 2 different endpoints (one for business-metrics, one for server-metrics) for the health-check monitoring service of  . See Metrics Section for a detailed overview of the provided metrics.

### Usage

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

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

[](#configuration)

Add following config section to your config.yaml

```
koality:
    token:
        secret: 'mySecret'
    orders_per_time_interval_check:
        enable: true
        hours: 24
        threshold: 1000
    new_carts_per_time_interval_check:
        enable: true
        hours: 1
    debug_mode_enabled_check:
        enable: true
    maintenance_worker_running_check:
        enable: true
    server_uptime_check:
        enable: true
        time_interval: '7 years'
    space_used_check:
        enable: true
        limit_in_percent: 80
        path_to_container: '/some/path/'
    container_is_running_check:
        enable: true
        container_name: 'test container name'

```

##### Example JSON Output

[](#example-json-output)

```
{
    "status": "fail",
    "output": "The health check failed.",
    "checks": {
        "orders_per_time_interval": {
            "status": "fail",
            "output": "Count of orders during the specified time interval is below threshold of: 1000",
            "description": "Shows count of orders during the last 24 hour(s)",
            "observedValue": 0,
            "observedUnit": "Orders",
            "metricType": "time_series_numeric",
            "observedValuePrecision": 2
        },
        "debug_mode_enabled_check": {
            "status": "fail",
            "output": "Debug mode is ON",
            "description": "Indicates whether debug mode is enabled.",
            "observedValue": 0,
            "metricType": "time_series_percent",
            "observedUnit": "percent"
        },
        "maintenance_worker_running_check": {
            "status": "fail",
            "output": "Maintenance Job wasn't executed within the last hour",
            "description": "Indicates whether maintenance jobs where running within last hour",
            "observedValue": 0,
            "metricType": "time_series_percent",
            "observedUnit": "percent"
        },

        ...

    }
}

```

### Metrics

[](#metrics)

The following Metrics are implemented yet

#### Server Metrics

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

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

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

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity1

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~5 days

Total

5

Last Release

1837d ago

Major Versions

v0.0.2 → v1.02021-05-03

### Community

Maintainers

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

---

Top Contributors

[![hehobasilico](https://avatars.githubusercontent.com/u/49902565?v=4)](https://github.com/hehobasilico "hehobasilico (26 commits)")

### Embed Badge

![Health badge](/badges/basilicom-koality-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/basilicom-koality-bundle/health.svg)](https://phpackages.com/packages/basilicom-koality-bundle)
```

PHPackages © 2026

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