リアルユーザー監視のカスタムAPI

カスタムAPIを使用することで、ユーザーIDの動的な値の設定、Javascript（JS）エラーのキャプチャ、セッションタイムアウトの指定など、さまざまな機能を実行することが可能になります。

例えば、ユーザー名を設定するためのカスタムAPIを使用するには、ユーザー名が存在するCookieやDOMなどから、アプリケーションに基づいてユーザー名をキャプチャするスクリプトを作成する必要があります。ユーザー名を取得することで、カスタムAPIを呼び出すことが可能になります。

カスタムAPIを使用して、リアルユーザー監視のユーザー名をキャプチャする方法は、以下の本社ナレッジをご参照ください。
How to capture username in Real User Monitor using Custom API?

  • カスタムAPIは、Applications Managerビルド16400以降、RUMエージェントバージョン3.2以降でサポートしています。
  • 250文字以下のユーザー名を指定する必要があります。
  • 以下の特殊文字は仕様できません。キャプチャしたユーザー名から削除されます。
    `~!@#$^&_|+=?;'",<>(){}[]

サポート対象のカスタムAPIタイプ

タイプ 説明 構文
ユーザー名をキャプチャ ユーザーIDのユーザー名をキャプチャ（デフォルトでは、RUMスクリプトによって各ユーザーに一意のユーザーIDを生成）
このAPIは、特定のユーザーに固有のメトリクスを追跡や、問題をデバッグしたい時に有効です。		 apmr('userName',"user@test.com");
JSエラーをキャプチャ JSエラーを手動でキャプチャし、RUMエージェントサーバーに送信 try {
unKnownFunction();
} catch(err) {
apmr('captureException',err);
}
カスタムブレッドクラムを追加 JSのエラー時に識別しやすいように、カスタムブレッドクラムを設定 apmr('addBreadCrumbs',"setTimeoutFunction");
現在のユーザーセッションを終了 現在のセッションを終了し、次のページのナビゲーションを新しいセッションとして開始 apmr('endCurrentSession');