OpenReplay トラッカー Analytics SDK のセットアップ方法について説明します。

Analytics SDK は オプトイン 方式です。トラッカーのコンストラクターに analytics.active を渡した場合にのみインスタンス化されます。それまでは tracker.analytics は null のままで、tracker.track() は何も行いません。

import Tracker from '@openreplay/tracker'

const tracker = new Tracker({
  projectKey: "YOUR_PROJECT_KEY",
  analytics: { active: true },
})

tracker.start()

• active: boolean Analytics SDK を有効にします。デフォルト：false。
• ingestPoint?: string アナリティクスのバッチの送信先となるエンドポイントです。セルフホスト環境でのみ有効で、OpenReplay Cloud では無視され、https://api.openreplay.com/ingest が使用されます。デフォルトはトラッカーの ingestPoint です。

OpenReplay の UI でアナリティクスデータを管理する方法について詳しくは、データ管理をご覧ください。

// Identify a user with an id (e.g. email, username, etc.)
tracker.analytics.identify(userId: string): void
// same as
tracker.analytics.people.identify(userId)

// Add event to batch with option to send it immediately
tracker.analytics.track(eventName: string, tempProperties?: Record<string, any>, options?: { send_immediately: boolean })
// same as
tracker.analytics.events.track(eventName, tempProperties, options)

// Clear user id, people properties and super properties, and stop the batcher
tracker.analytics.reset(): void

これらはトラッカー自体に用意されているため、tracker.analytics を経由せずに安全に呼び出せます（アナリティクスが無効な間は何も行いません）：

// Same as tracker.analytics.track(...)
tracker.track(eventName: string, properties?: Record<string, any>, options?: { send_immediately: boolean })

// Sets the replay's user ID *and* calls analytics.people.identify() with it
tracker.setUserID(id: string): void
tracker.identify(id: string): void // alias of setUserID

// Send analytics events under your own token, without session recording
tracker.setAnalyticsToken(token: string): void

識別されたユーザー（永続的なデバイス ID を含む）、すべての people プロパティ、すべてのスーパープロパティをクリアし、バッチ送信を停止します。ログアウト時に呼び出してください。

tracker.analytics.reset()

問題が発生した場合は、Slack に参加して、コミュニティのサポートを受けてください。