README

开发者信息: basilicom的Pimcore

概要

此Pimcore http://www.pimcore.org 插件简化了记录到Librato服务的统计数据和指标。

代码示例 / 工作方法

如果已安装并启用，该插件将挂钩到pimcore的维护过程/脚本（通过“system.maintenance”事件），并且每五分钟向Librato服务器发送自定义指标值。

可以通过SQL查询和/或静态方法定义指标。

动机

监控业务价值是每个应用程序的关键部分。Librato是一个强大的外部服务，用于记录指标和分析统计数据。此插件通过使用简单的配置文件并挂钩到维护/计划任务过程，使Pimcore集成变得简单。

安装

将“basilicom-pimcore-plugin/librato”添加到您的Pimcore安装顶级目录中的composer.json文件的要求中。

示例

{
    "require": {
        "basilicom-pimcore-plugin/librato": "~1.0"
    }
}

通过Pimcore扩展管理器安装插件。

在扩展管理器中，按Librato插件的“配置”按钮，并将“email”和“token”属性设置为您的Librato账户中的值（ https://metrics.librato.com/account/api_tokens ）。

当前Pimcore数据库名称用作默认指标源。使用“source”属性可以覆盖此值。

定义一些指标。以下示例涵盖了所有可能性

<metrics>
    <metric><type>counter</type><name>object_cnt</name><sql>select count(*) as cnt from `objects`</sql></metric>
    <metric><type>counter</type><name>version_cnt</name><sql>select count(*) as cnt from `versions`</sql></metric>
    <metric><type>gauge</type><name>php_sample_method</name><php>\Librato\Plugin::getSampleRandomMetric</php></metric>
</metrics>

请注意：SQL查询和PHP静态方法必须返回一个适合Librato API消费的精确数值。支持“计数器”和“量表”类型。

将“enabled”属性更改为“1”以启用发送值。

API参考

如果您想在不进行维护运行而是在手动的情况下将指标发送到librato，请使用以下方法

• &\Librato\Plugin::getClient() 返回一个配置并准备好发送指标的 \Librato\Client。如果插件未配置/启用，则返回一个虚拟客户端。
• \Librato\Client->addGauge(string $name, int|float $value) - 添加量表指标
• \Librato\Client->addCounter(string $name, int|float $value) - 添加计数器指标
• \Librato\Client->flush() - 将指标缓冲区发送到Librato

测试

• 无

待办事项

• 实现一个简单的Pimcore仪表板小部件以实现Librato集成

贡献者

• Christoph Luehr christoph.luehr@basilicom.de

许可

• BSD-3-Clause