README

开发者信息：basilicom 的 Pimcore

摘要

此 Pimcore http://www.pimcore.org 插件简化了使用和配置 Tideways Profiler。

代码示例 / 工作方法

如果已安装并启用，以下 Tideways 属性将通过网站/var/config/tideways.xml 文件进行配置

• \Tideways\Profiler::detectFramework(\Tideways\Profiler::FRAMEWORK_ZEND_FRAMEWORK1);
• \Tideways\Profiler::start($apiKey, $sampleRate);
• \Tideways\Profiler::watch($watcher); // 从 XML 文件配置的所有监视器

动机

Tideways 与 ZF1 框架检测“开箱即用”。为了配置某些方面（主要是自定义跨度时间线事件），需要额外的代码。此插件通过在 Tideways API 调用之间添加一层，并通过 Pimcore 插件管理系统访问简单的基于 XML 的配置文件，简化了此过程。

安装

在您的服务器上安装 Tideways 系统，请参阅： https://tideways.io/profiler/docs/getting-started/installation

确保您已在 php.ini 中禁用 Tideways 自动启动：tideways.auto_start=No（插件会处理此问题。）

将 "basilicom-pimcore-plugin/tideways" 添加到 Pimcore 安装根目录中的 composer.json 的需求中。

示例

{
    "require": {
        "basilicom-pimcore-plugin/tideways": ">=1.0.0"
    }
}

通过 Pimcore 扩展管理器安装插件。在扩展管理器中，按下 Tideways 插件的 "配置" 按钮，并相应设置 "apiKey" 属性。

为了将信息传输到 Tideways 服务器，也将 "enabled" 属性设置为 "1"。

通过更改 "sampleRate" 限制样本率。

如果您还想分析/跟踪后端请求：将 xml 文件中的 "excludeBackend" 属性设置为 "0"。

如果您还想分析/跟踪 CLI 请求：将 xml 文件中的 "excludeCli" 属性设置为 "0"（这是跟踪 maintenance.php 运行所必需的）。

您可以添加其他方法监视器 - 请参阅配置文件中的示例部分。

可选地，通过 Tideways UI 上传样本包配置文件 "tideways-pimcore.xml" 进行自定义包配置 - 这里进行配置

https://app.tideways.io/o/basilicom/[TIDEWAYS-APPLICATION-NAME]/settings/packages

请参阅： https://github.com/QafooLabs/profiler-packages/blob/master/package.xsd

API 参考

以下静态方法作为原始 Tideways 函数的包装器提供

• \Tideways\Plugin::setTransactionName(string $transactionName)
• \Tideways\Plugin::setCustomVariable(string $variable, mixed $value)
• \Tideways\Plugin::createEvent(string $eventName, string $environment='production', string $type='release')

测试

• 无

待办事项

• 实现异常处理跟踪

贡献者

• Tim Jagodzinski tim.jagodzinski@basilicom.de
• Christoph Luehr christoph.luehr@basilicom.de

许可证

• BSD-3-Clause