README

安装

请参考上表中的包版本信息，并相应地更改下面的版本。

使用 composer，运行

composer require intouch/laravel-newrelic:"~2.0"

或者将 intouch/laravel-newrelic 添加到您的 composer 需求中

"require": {
    "intouch/laravel-newrelic": "~2.0"
}

... 然后运行 composer install

安装包后，打开您的 config/app.php 配置文件，找到 providers 键。将以下行添加到末尾

Intouch\LaravelNewrelic\NewrelicServiceProvider::class,

可选地，找到 aliases 键并添加以下行

'Newrelic' => Intouch\LaravelNewrelic\Facades\Newrelic::class,

最后，发布默认配置（它将出现在 config/newrelic.php 中）

php artisan vendor:publish --provider="Intouch\LaravelNewrelic\NewrelicServiceProvider"

配置

配置发布后，请参考 config/newrelic.php 中的配置选项和描述。

事务名称

通过将 name_provider 字符串中的令牌替换为从应用程序收集的格式化输出来完成命名。newrelic.name_provider 配置参数包含此字符串 - 注意，非令牌字符串部分保持不变。

默认的 newrelic.name_provider 字符串是 '{uri} {route}'。

Eloquent 模型观察者

有两个观察者类用于监控您的 Eloquent 模型，即 NewrelicCountingObserver 和 NewrelicTimingObserver。正如其名称所示，一个用于计算可观察模型事件发生的次数，另一个用于收集它们的计时（以毫秒为单位）。这些记录的指标将显示在您的 NewRelic 自定义指标中。

NewrelicCountingObserver 可用于任何可观察模型事件，包括您自定义的事件。目前 NewrelicTimingObserver 只支持内置的 Eloquent 可观察事件（请参阅 Laravel 文档中的模型事件）。

使用观察者很简单 - 在您选择注册模型观察者的地方，只需添加

User::observe(new \Intouch\LaravelNewrelic\Observers\NewrelicTimingObserver() );
User::observe(new \Intouch\LaravelNewrelic\Observers\NewrelicCountingObserver() );

... 假设您想观察 User 模型。

这两个观察者都接受两个可选参数给它们的构造函数： $name 和 $care。 $name 是您想为自定义指标提供的名称，如果未设置，将默认为观察的模型对象的类名。如果您想更改 $care 数组而不更改命名，只需将 null 作为第一个构造函数参数传递。

$care 是您想要关心的事件名称数组。这在 Counting 和 Timing 观察者之间略有不同。对于 Counting 观察者，任何事件都可以独立计数。对于 Timing 观察者，它使用 saving 和 saved 之间的时间差来提交指标，因此只能观察操作后的事件：created、saved、updated、deleted、restored。这也是为什么自定义可观察事件目前不支持 Timing 观察者（... 我们正在努力改进，我们很高兴接受 PR）。

根据NewRelic的“最佳实践”建议，所有指标名称都应以'Custom/'开头。计数观察器Counting也会在名称前添加'Counts/'，而计时观察器Timing会在名称前添加'Timing/'。两个观察器都会将事件名称追加到指标名称的末尾。以使用Counting观察器对User模型监控的created事件为例，名称将是：Custom/Counts/App/User/created（其中App/User是被观察模型的命名空间类名，为了NewRelic指标路径，斜杠被反转，或者如果您在$name中设置了，它将是任何您设置的内容）。

只要将newrelic.throw_if_not_installed设置为false，就可以在集成测试或交互式测试环境中安全地运行这些观察器。然后，如果在该环境中没有安装NewRelic PHP Agent，自定义指标将简单地不会被记录。如果在该环境中安装了NewRelic PHP Agent，指标将被记录。

两个观察器都关心的默认事件是：created、saved、updated、deleted、restored。

注意：要使用观察器，必须在您的应用程序配置中加载Newrelic外观，而不仅仅是服务提供者。

注意：NewRelic限制了您拥有的自定义指标总数为2000个，并建议不超过1000个。

自定义指标仪表板示例

基本使用

此包包含对Intouch/Newrelic类的外观。
您可以像访问其他外观一样访问其任何方法，例如

App::after( function() {
    Newrelic::setAppName( 'MyApp' );
} );

... 将NewRelic应用程序名称设置为'MyApp'

Laravel 4.x支持

问题

在为未按您配置的格式报告的数据提交问题之前，请检查您的NewRelic PHP Agent日志，并请参阅：https://discuss.newrelic.com/t/php-agent-4-19-0-disabled-3rd-party-service-provider-incorrectly/1666

如果这还没有解决问题，请在此处提交问题或发送给我们一个PR。

intouch / laravel-newrelic

维护者

详细信息