README

为Craft CMS开发的插件

由Top Shelf Craft制作
Michael Rog，所有者

使用New Relic APM监控您的Craft应用程序。

tl;dr

此插件通过在每次请求中设置事务名称和（可选）应用程序名称，帮助连接您的Craft应用程序与New Relic APM。

安装

从您的项目目录中，使用Composer要求插件包
```
composer require topshelfcraft/new-relic
```
在控制面板中，转到设置→插件，然后单击“安装”按钮以安装New Relic。
添加一个new-relic.php配置文件，根据需要编辑插件设置。

New Relic插件还可在Craft CMS插件商店中安装。

配置

您可以使用控制面板设置屏幕来配置插件，或将new-relic.php文件添加到您的Craft配置目录中

<?php
return [

    /*
     * Specify a different app name than
     * the one provided in your .ini files,
     * e.g. If you want to change the app name
     * on a per-environment basis...
     */
    'appName' => '',
    
    /*
     * Specify a string to override Segment 2
     * from the request path, e.g. If you want to
     * consolidate your reported routes...
     */
    'groupSegment2As' => '',

];

测试时的启用/禁用

在运行测试套件时保留New Relic启用可能会导致问题，尤其是当使用CLI工具如Codeception时，因为Craft的isConsoleRequest()方法可能在测试上下文中启动时返回错误。

要在测试期间禁用New Relic，请将插件处理程序添加到disabledPlugins中的general.php配置文件在您的测试设置中

<?php
return [
    // ...
    
    'disabledPlugins' => [
        'new-relic',
    ],
    
    // ...
];

如果您在运行测试时确实需要使用New Relic，您需要在测试启动时显式调整请求

Yii:$app->request->setIsConsoleRequest(Yii:$app->request instanceof yii/console/Request);

什么是New Relic？

New Relic提供实时监控和性能洞察的工具。当您的软件和基础设施的每个方面都是可观察的时，您可以更快地发现和修复问题。New Relic APM（应用程序性能监控）通过提供详细的环境性能指标，帮助您构建、部署和维护出色的软件。

此插件假定您已在newrelic.com上设置了一个帐户，并且已在您的环境中安装了APM工具。

（此插件是Craft的New Relic设置的非官方伴侣。New Relic APM是New Relic，Inc.的商标。）

支持

系统要求是什么？

Craft 4.0+和PHP 8.0+

我发现了一个错误。

当然，你发现了。

我三番五次检查了。这是一个错误。

那么，感谢你照顾我。请打开GitHub 问题或向4.x.dev分支提交PR。

贡献者

插件开发：Michael Rog / @michaelrog
Craft 2 插件： Josh Angel / @josh_angell
图标： New Relic

topshelfcraft / new-relic

维护者

详细信息