構文
newrelic.start(value: string[]|undefined)
遅延状態で実行しているときにエージェント機能を開始するために使用されるブラウザ API。
要件
ブラウザ Lite、Pro、または Pro+SPA エージェント (v1.239.0 以降)
重要
この API を使用するために必要な設定は、現在 New Relic 内のより大規模なデプロイメント システムに接続されていません。そのため、この API の呼び出しは、さらなる変更が行われるまで、コピー/ペーストまたは npm ブラウザーのインストールにのみ影響します。
説明
機能はdeferred
状態でロードできます。これは、エージェントが使用する構成ブロックNREUM.init.<feature>
で適切な機能のautoStart
プロパティをfalse
に設定することで制御できます。この機能の状態は、イベントが監視されてエージェントに保存されますが、 .start()
API メソッドで指示されるまで NR1 に収集されないことを意味します。機能名のリストについては、 「機能名」を参照してください。機能を遅延状態に設定する方法を示す例については、「例」を参照してください。
有効な値を指定してこの関数を実行すると、ブラウザ エージェントは、 autoStart: false
構成によって延期されていた関連機能を開始します。引数なしで呼び出された場合、メソッドは延期されているすべての機能を開始します。機能名を表す文字列のリストを指定して呼び出された場合は、その文字列に一致する機能名が開始されます。機能名のリストについては、 「機能名」を参照してください。
パラメーター
パラメータ | 説明 |
---|---|
文字列[]または未定義 | オプション。開始する機能のリストに関連する文字列の配列 |
機能名
- アヤックス
- jserrors
- メトリックス
- ページアクション
- ページビュー_イベント
- page_view_timing
- セッションリプレイ
- セッショントレース
- スパ
使用例
- ユーザーがサイト上のモーダルに同意するまでデータの収集を待ちたい場合
- サイトでカスタム属性が設定されるまでデータの収集を待ちたい場合
例
すべての機能を据え置き状態でロードする (コピー/ペースト、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}, page_action: {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(['ajax', 'jserrors', 'page_action'])// ajax, jserrors, and page_action features will now start harvesting
すべての延期された機能を「開始」する
newrelic.start()// all deferred features in the agent will now start harvesting