構文
newrelic.start()
遅延状態で実行しているときにエージェント機能を開始するために使用されるブラウザ API。
要件
ブラウザ Lite、Pro、または Pro+SPA エージェント (v1.239.0 以降)
重要
この API を使用するために必要な設定は、現在 New Relic 内のより大規模なデプロイメント システムに接続されていません。そのため、この API の呼び出しは、さらなる変更が行われるまで、コピー/ペーストまたは npm ブラウザーのインストールにのみ影響します。
説明
機能はdeferred
状態でロードすることができ、これはエージェントが使用する設定ブロックNREUM.init.<feature>
で適切な機能のautoStart
プロパティをfalse
に設定することで制御できます。 この機能の状態は、イベントが監視されてエージェントに保存されますが、 .start()
API メソッドで指示されるまで NR1 に収集されないことを意味します。 機能名のリストについては、「機能名」を参照してください。 機能を遅延状態に設定する方法を示す例については、「例」を参照してください。
有効な値でこの関数を実行すると、Browseragent はautoStart: false
設定によって延期された関連機能を開始します。 メソッドが呼び出されると、延期されていたすべての機能が開始されます。 遅延状態で開始できる機能名のリストについては、機能名を参照してください。
機能名
アヤックス
jserrors
メトリックス
generic_events
ページビュー_イベント
page_view_timing
セッションリプレイ
セッショントレース
スパ
重要
page_view_event
ハーベストの応答本文には、他の機能を実行するための重要な情報が含まれています。page_view_event
の開始を延期すると、他のすべての機能は.start()
が呼び出されるまで待機することになります。
使用例
- ユーザーがサイト上のモーダルに同意するまでデータの収集を待ちたい場合
- サイトでカスタム属性が設定されるまでデータの収集を待ちたい場合
例
すべての機能を据え置き状態でロードする (コピー/ペースト、NPM)
// Change the init portion of the configuration block to add `autoStart: false` to any features desired to load in a deferred stateNREUM.init = { // feature configurations ajax: {autoStart: false}, jserrors: {autoStart: false}, metrics: {autoStart: false}, generic_events: {autoStart: false}, page_view_event: {autoStart: false}, page_view_timing: {autoStart: false}, session_replay: {autoStart: false}, session_trace: {autoStart: false}, spa: {autoStart: false}, // other configurations // ...}
すべての延期された機能を「開始」する
newrelic.start()// all deferred features in the agent will now start harvesting