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 ブラウザのインストールに関するドキュメントを参照してください。

説明

有効な値でこの関数を実行すると、属性が手動で設定解除されるまで、Browseragent はすべてのイベントとともに値をenduser.id属性として記録します。 識別子はbrowserに保存されるため、同じオリジンの以降のページ訪問では、イベント within a session スパンに識別子が付加されます。 この機能は、 browserプライバシー設定に応じて変動する場合がありますのでご了承ください。 この関数がvalue = nullで呼び出されると、既存のユーザー ID がboth現在のページのイベントとストレージから削除されます。

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

エージェントバージョン1.307.0以降では、resetSessionプロパティがtrueに設定されている場合、ユーザー識別子が更新されると、BrowserAgent セッションがリセットされます。 ただし、 enduser.id属性がまだ指定されていない場合はセッションはリセットされません。

パラメーター

例 - マシン/デバイスごとに1人のユーザー

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

newrelic.setUserId('user-1234')

現在のユーザーに対するプロパティ イベントを停止する

// Note: events are still attributed to the same session id
newrelic.setUserId(null)

例 - マシン/デバイスごとに複数のユーザー

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

// Note: associates the specified userid to the current session id
newrelic.setUserId('user-1234', true)

別のユーザーセッションに切り替える

// Note: resets the session, events will be attributed to a new user + session id
newrelic.setUserId('user-567', true)

ユーザーセッションの終了

// Note: resets the session, effectively ending it.  Events will be attributed to a new session id going forward.
newrelic.setUserId(null, true)