customgento/module-koality-m2

koality.io Magento 2 插件可以用来持续监控 Magento 2 商店的业务指标。

维护者

详细信息

github.com/customgento/module-koality-m2

源代码

问题

安装: 0

依赖项: 0

建议者: 0

安全: 0

星标: 2

关注者: 3

分支: 1

开放问题: 0

类型：magento2-module

1.0.3 2023-06-19 12:13 UTC

Requires

  • php: ~7.3.0||~7.4.0||~8.1.0||~8.2.0
  • magento/framework: ~102.0||~103.0
  • magento/module-backend: ~101.0||~102.0
  • magento/module-catalog: ~103.0||~104.0
  • magento/module-config: ~101.0
  • magento/module-store: ~101.0

OSL-3.0 3e9e3dff0c063147be888790206c830cfc1008ec

  • Team CustomGento <info.woop@customgento.com>

This package is auto-updated.

Last update: 2024-08-26 20:10:53 UTC

README

koality.io Magento 2 插件可以用来持续监控 Magento 2 商店的业务指标。要使用此插件，需要一个有效的 koality.io 账户。初始设置完成后，可以直接在 koality.io 管理区域轻松监控商店。

koality.io 后端布局

Active products Open carts Orders per hour

指标

以下指标目前已实现

  • 每小时最小订单数 - 如果过去一小时内订单数量低于给定阈值，则检查失败。此检查提供两个时间间隔。高峰时段和平常购物时间。这是为了最小化误报。

  • 最大开放购物车数量 - 如果过去一小时内开放购物车数量过多，则检查失败。此检查也区分高峰时段和平常购物时段。这通常发生在支付失败，客户无法完成购买过程时。

  • 最小活跃产品数量 - 如果应该中活跃产品不足，则检查失败。这将有助于发现导入错误。

  • 自定义指标 - 我们非常乐意讨论为贵公司开发定制指标。请随时通过 customgento.com 联系我们。

插件工作原理

插件提供了一个通过秘密令牌加密的 JSON 端点，用于 Magento 店面。该端点返回商店的健康状态。

示例

{
    "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 可以解释此格式，并在检查失败时发出警报。

安装后，可以在以下位置找到 API 端点

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

Magento2 健康端点的格式正在实施此标准（仍为 RFC）

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

兼容性

  • Magento >= 2.3

安装说明

  • 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

配置

要配置插件，请在您的 Magento 管理面板中导航到“商店”>“配置”>“服务”>“Koality”。在那里您可以找到自动创建的 API 密钥，必须将其插入 koality.io 后端。如果需要，还可以使用“刷新 API 密钥”按钮创建新密钥。

API key configuration

在下一个选项卡中，您可以根据需要定义高峰时段。时间应始终选择本地时区。 Rush hour config

在第三个选项卡中，您可以定义每小时订单数指标设置。设置您期望的每小时最小订单数量，如果需要，还可以定义高峰时段的值。如果订单数量低于此限制，则指标将失败。

Orders per hour config

在开放购物车部分，您可以设置最大开放购物车数量。如果需要，在此处也可以定义高峰时段的值。如果开放购物车数量超过预期，则指标将失败。

Open carts config

在上一个标签页中，可以输入活动产品的最小期望值。如果活动产品数量少于这里输入的数量，则该指标将在koality.io后端失败。

Active products config

支持

如果您对这个扩展有任何问题，请打开GitHub问题。如果您对koality.io有任何问题，请联系koality.io支持。

许可证

OSL - 开放软件许可 3.0

版权

© 2021 - 现在 CustomGento GmbH