事件

为 OpenReplay tracker 的 analytics 事件定义和管理超级属性。

事件

此模块让你能够管理事件属性——持久化的键/值对,会自动附加到每个被追踪的事件上。

超级属性存储在本地,当你追踪事件时,会被合并到每个事件的 payload 中。

可通过以下方式访问:

tracker.analytics.events

超级属性存储在 SDK 中,并在 properties 下被合并到每个事件中。

事件属性仅在单次调用 track/sendEvent 时传入,并且不会作为超级属性被保存。

以下键为保留键,无法通过超级属性的辅助方法创建/移除:

  • properties
  • token
  • timestamp
// Track an event.
// The `properties` argument is per-event only (not persisted).
tracker.analytics.events.sendEvent(eventName: string, properties?: Record<string, any>, options?: { send_immediately: boolean })

// Create/update super properties (persisted)
tracker.analytics.events.setProperty(name: string, value: any): void
tracker.analytics.events.setProperty(properties: Record<string, any>): void

// Create super properties only if they don't exist yet (persisted)
tracker.analytics.events.setPropertiesOnce(name: string, value: any): void
tracker.analytics.events.setPropertiesOnce(properties: Record<string, any>): void

// Remove super properties (persisted)
tracker.analytics.events.unsetProperties(name: string): void
tracker.analytics.events.unsetProperties(names: string[]): void

// Clear all super properties
tracker.analytics.events.reset(): void

单次事件属性(不持久化)

Section titled 单次事件属性(不持久化)
tracker.analytics.events.sendEvent("Button Clicked", {
  button_text: "Start",
  page: "home",
})

这些属性仅适用于此事件。

超级属性 + 单次事件属性(合并)

Section titled 超级属性 + 单次事件属性(合并)

当你设置了超级属性后,它们会自动包含在每个事件中,然后与单次事件属性合并:

tracker.analytics.events.setProperty({
  app_version: "1.42.0",
  env: "prod",
})

tracker.analytics.events.sendEvent("Signup Started", {
	// per-event, can override a super property with the same key
  plan: "pro", 
})

合并顺序:

  • 先添加超级属性
  • 单次事件属性叠加在其上进行合并

因此,当键发生冲突时,单次事件属性优先。

创建或覆盖超级属性。

// object form
tracker.analytics.events.setProperty({
  app_version: "1.42.0",
  region: "eu",
})

// key/value form
tracker.analytics.events.setProperty("build_sha", "3f2c9a1")
  • 默认/内部键(由 SDK 追踪)会被忽略,不会作为超级属性添加。
  • 仅当确实发生变化时,更改才会保存到本地。

仅在超级属性尚不存在时才创建它们。

tracker.analytics.events.setPropertiesOnce({
  first_seen_at: Date.now(),
  signup_source: "docs",
})

// key/value form
tracker.analytics.events.setPropertiesOnce("initial_referrer", document.referrer)
  • 仅当键缺失时才会设置属性。
  • 保留键(propertiestokentimestamp)会被忽略。

移除一个或多个超级属性。

// single
tracker.analytics.events.unsetProperties("region")

// multiple
tracker.analytics.events.unsetProperties(["app_version", "build_sha"])
  • 保留键无法被移除。
  • 移除操作会被持久化。

清除所有超级属性。

tracker.analytics.events.reset()

默认情况下,事件会被排队/批量处理。你可以请求立即发送某个事件:

tracker.analytics.events.sendEvent(
  "Checkout Completed",
  { value: 199, currency: "EUR" },
  { send_immediately: true },
)

为了方便使用,所有方法都支持提供的兼容层:

tracker.analytics.events.register       // setProperty
tracker.analytics.events.register_once  // setPropertiesOnce
tracker.analytics.events.unregister     // unsetProperties
tracker.analytics.events.track          // sendEvent

如果你遇到任何问题,请加入我们的 Slack,或访问我们的论坛,从我们的社区获得帮助。