setCurrentRouteName (SPA API)

この API を使用するには、ブラウザエージェントの Browser Pro+SPA エディションが必要です。

構文

newrelic.setCurrentRouteName(string $name)

SPA ルートにデフォルトの名前よりも正確な名前をつける。デフォルトのグループ化ではなく、特定のルートを監視します。

エージェントのバージョン nr-998 以上。

このメソッドは、現在のルートに名前を付けます。これは次のような場合に便利です。

現在、このメソッドは SPA BrowserInteractionイベントにのみ適用されます。この API を使用すると、以前のルートとターゲットルートを追跡する 2 つの新しいカスタム属性が作成されます。

この API を使用する場合、 browserInteractionName属性はtargetRouteName値を取ります。setNameを使用してブラウザーインタラクション名を設定すると、それが優先されます。

setCurrentRouteName() API はBrowserInteractionイベントの名前属性を決定するため、ルートが変更されるたびにこの API を呼び出す必要があります。これにより、 BrowserInteractionイベントが正しい属性を持つことが保証されます。

ルートではなくブラウザインタラクションの名前を設定するsetName()と比較してください。

パラメータ	説明
`$name` ストリング	必須項目です。ページの現在のルート名。 `setCurrentRouteName()`に渡されるルート名は任意の文字列にすることができますが、特定のリソースではなくルーティングパターンを表す必要があります。たとえば、 `/users/123` } ではなく`/users/:id`を使用します。 `null`の場合、ルート変更要件を終了し、デフォルトの命名戦略に戻ります。

パラメータ

説明

$name

ストリング

必須項目です。ページの現在のルート名。

setCurrentRouteName()に渡されるルート名は任意の文字列にすることができますが、特定のリソースではなくルーティングパターンを表す必要があります。たとえば、 /users/123 } ではなく/users/:idを使用します。

nullの場合、ルート変更要件を終了し、デフォルトの命名戦略に戻ります。

router.onChange(function(route) {
  newrelic.setCurrentRouteName(route.name);
});