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代理，则自定义指标将不会记录。如果在该环境中安装了NewRelic PHP代理，则将记录指标。

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

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

注意：NewRelic限制您可以拥有的自定义指标总数为2000，并建议少于1000。

示例自定义指标仪表板

基本用法

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

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

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

Laravel 4.x支持

问题

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

如果这还没有澄清问题，请在此处打开问题或向我们发送PR。

reginaldomourabefore / laravel-newrelic

维护者

详细信息