跳转至

自定义用户标识

SDK 会为匿名用户生成标识。用户登录后,可调用 setUser() 写入稳定的业务用户信息,便于跨 Session 查询同一用户的 View、Action、Resource 和 Error。

属性 类型 必填 说明
id String 否 推荐填写稳定且不直接暴露敏感信息的业务用户 ID
name String 否 用户昵称或展示名称
email String 否 用户邮箱
其他字段 Unknown 否 业务需要的用户属性,例如会员等级

建议至少提供 id。不要使用会频繁变化的昵称或邮箱代替稳定用户 ID。

使用用户分析关联业务用户时,首次设置或切换业务用户必须传入稳定、非空的 id。SDK 的 user.id 对应查看器中的落库字段 userid;SDK 自动生成的非空标识也可参与用户统计,无需提供姓名或邮箱。

同一工作空间内多个应用需要联合分析时,应使用一致的业务 ID 规则,避免相同 ID 对应不同用户。

NPM 示例

import { datafluxRum } from "@cloudcare/browser-rum"

datafluxRum.setUser({
  id: "user-1234",
  name: "John Doe",
  email: "john@example.com",
  membership_level: "gold"
})

CDN 示例

window.DATAFLUX_RUM &&
  window.DATAFLUX_RUM.setUser({
    id: "user-1234",
    name: "John Doe",
    email: "john@example.com"
  })
window.DATAFLUX_RUM.onReady(function () {
  window.DATAFLUX_RUM.setUser({
    id: "user-1234",
    name: "John Doe",
    email: "john@example.com"
  })
})

退出登录或切换用户

setUser() 和 clearUser() 只更新用户上下文,不会自动结束或新建 Session。从 SDK 3.3.6 开始,登录或切换账号后,可以先设置完整的业务用户信息,再调用 startSession() 创建新的 Session 边界:

datafluxRum.setUser({ id: "user-5678", name: "Jane Doe" })
datafluxRum.startSession()

退出登录时,先清除业务用户信息,再创建新的 Session,避免后续事件继续关联到原业务用户:

datafluxRum.clearUser()
datafluxRum.startSession()

CDN 接入使用 window.DATAFLUX_RUM 上的同名方法;异步加载时,在 onReady 回调内执行。

如果只更新同一用户的姓名或其他属性,使用 setUserProperty() 局部更新,不要使用缺少 id 的 setUser() 覆盖已有用户上下文,也无需因此调用 startSession():

datafluxRum.setUserProperty("name", "Jane Smith")

页面刷新与本地存储

默认用户上下文保留在标签页内存中,刷新后应由应用恢复登录态,再设置用户信息。启用 storeContextsToLocal 后,用户上下文可在刷新后恢复,退出时仍需调用 clearUser() 清除持久化的业务用户信息。

同源多个应用使用本地存储时,应通过 storeContextsKey 区分工作空间、应用和环境。同源且使用相同 Key 的标签页可能同步用户上下文;业务上下文的存储隔离不等于 Session 隔离,需要结合多账号场景验证会话归属。参数说明参见 Web 应用接入。

注意事项

  1. 不要写入密码、访问 Token、身份证号等敏感信息。
  2. 用户信息只影响设置之后产生的事件,不会修改已经上报的数据。
  3. 用户切换后应同步更新用户信息和 Session,避免两个账号的数据落入同一 Session。

在用户分析中,包含多个用户或无法确认完整用户归属的会话不提供回放。事后更新用户信息不会修正历史会话的归属。

验证

设置用户后触发一次页面操作,在 View 或 Action 查看器中确认 userid 与设置的 user.id 一致。登录、切换账号或退出登录后,按上述顺序更新用户上下文并调用 startSession(),确认新事件的 session_id 已变化,且不继续关联原业务用户。

仅通过 setUserProperty() 更新同一用户的属性时,确认 userid 和 session_id 均保持不变。

文档评价

文档内容是否对您有帮助?