interaction (SPA API)

構文

newrelic.interaction([JSON object $options])

現在の SPA インタラクションにバインドされた新しいハンドル オブジェクトを返します。存在しない場合は新しいインタラクションを返します。

要件

• ブラウザ Pro+SPA エージェント (v963 以降)

• $options問題には v1.285.0 以降が必要です

• npm を使用してブラウザ エージェントをインストールしている場合は、 BrowserAgentクラスをインスタンス化するときにspa機能を有効にする必要があります。features配列に以下を追加します。

  import { Spa } from '@newrelic/browser-agent/features/spa';
  
  const options = {
    info: { ... },
    loader_config: { ... },
    init: { ... },
    features: [
      Spa
    ]
  }

  コピー

  詳細については、 npm ブラウザのインストールに関するドキュメントを参照してください。

説明

SPA 監視interaction()呼び出しは、現在のインタラクションにバインドされた新しいハンドルを返します。

• New interaction: この関数が呼び出され、開いているか進行中のインタラクションがない場合は、新しいカスタムインタラクションが作成されます。

  • waitForEndが指定されていない限り、カスタム インタラクションでは引き続きデフォルトのヒューリスティックが実行され、次の完全なソフト ナビゲーションで自動的に閉じられます。

• New object: インタラクションの進行中にこの関数が呼び出されると、現在のインタラクションを参照する新しいハンドルが作成されます。

  • 複数のハンドルが同じインタラクションを指すことができます。各.interaction呼び出しは新しいハンドルを作成します。
  • ハンドルは、 clickなどのユーザー イベントから開始されたか、以前の API によってトリガーされた.interaction呼び出しから開始されたかに関係なく、オープン インタラクションを指します。
  • この関数は、それ自身の効果またはユーザー イベントの効果を置き換えることはできません。つまり、既存のオープンなインタラクションを新しい API 駆動型のインタラクションで上書きすることはできません。

パラメーター

戻り値

このメソッドは、潜在的なBrowserInteractionイベントを指すネイティブ JS オブジェクトを返します。このメソッドは、まだ終了していない間に同じBrowserInteractionに対して呼び出されるたびに、新しいオブジェクトが作成されますが、同じインタラクションを参照し続けます。

例

SPA API メソッドはnewrelic.interaction()で使用する必要があります。返された値またはハンドルを後で使用するために別の変数に割り当てることができます。例えば：

let myInteraction = newrelic.interaction();
...
myInteraction.save();

名前付きハンドルは保存してインタラクションの外部から使用できますが、インタラクションが終了した後は SPA メソッドは効果がないことに注意してください。

インタラクションの持続時間は次の方法でカスタマイズすることもできます。

// Say an interaction is already open from a user click.
const userInteraction = newrelic.interaction({ waitForEnd: true }); // grabs the current interaction in-progress & keep it open
// URL changes & DOM is modified. Because of those condition being met, interaction will be saved but is kept open.
fetch('myurl.com/endpoint').then(() => userInteraction.end()) // associate this request to the interaction before completing this BrowserInteraction

const myCustomIxn = newrelic.interaction({ waitForEnd: true }) // create a new api-triggered interaction
// This interaction will be kept open indefinitely until `.end` is called, and no new interaction will start, custom or otherwise. AjaxRequest will continue to buffer under this interaction until it is closed.