setUserId

構文

newrelic.setUserId(value: string|null)

ページ上の後続のイベントにユーザー定義の識別子文字列を追加します。

要件

• ブラウザ Lite、Pro、または Pro+SPA エージェント (v1.230.0 以降)

• npm を使用してブラウザ エージェントをインストールしている場合は、 BrowserAgentクラスをインスタンス化するときに少なくとも 1 つの機能を有効にする必要があります。たとえば、次をfeatures配列に追加します。

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

  コピー

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

説明

有効な値を指定してこの関数を実行すると、属性が手動で設定解除されるまで、ブラウザ エージェントはその値をすべてのイベントとともに enduser.id 属性として記録します。識別子はブラウザに保存されるため、 同じ オリジンの後続のページ アクセスでは 、セッション スパン内の イベントに関連付けられます。この機能は、エンドユーザーのブラウザーのプライバシー設定によって変動する可能性があることに注意してください。この関数が value = nullで呼び出された場合、既存のユーザー ID は現在のページのイベントとストレージの 両方 から削除されます。

ID は、特に Errors Inbox の使用のために、JavaScriptError イベントに添付されます。互換性のあるエージェント バージョンで SPA 監視を 使用している場合、ユーザー ID も newrelic.interaction イベントに含まれます。

パラメーター

例

エンド ユーザーの「セッションの開始」をマークする

newrelic.setUserId('user-1234-v1.0')

イベントが現在のユーザーに帰属しないようにする

newrelic.setUserId(null)