跳转至

Client Tokens 管理

Client Token 是观测云用户访问监测(RUM)功能的核心认证凭证,用于从用户设备(Web、移动端、小程序等)安全发送数据到观测云服务器。

当用户与网站或应用程序交互时,Client Token 随性能数据一起被发送,以便服务器验证并接收这些数据,从而确保数据的安全性和准确性。这种令牌机制不仅简化了身份验证流程,还支持了高效的跨域数据传输,为观测云提供了一种简洁而有效的方式来收集和分析用户的真实使用情况。

应用场景

Client Token 主要用于公网 DataWay 接入方式。使用此方式时,无需安装 DataKit 采集器,只需配置 siteclientToken 参数即可快速接入 RUM 数据。

创建 Client Token

前置条件

  1. 拥有观测云工作空间的管理员Owner 权限;
  2. 已开通用户访问监测(RUM)功能

  3. 输入 Client Token 名称;

  4. 点击确定;
  5. 按需复制观测云自动生成的 Client Token。
注意

Client Token 仅在创建时显示完整内容,后续无法再次查看完整令牌。如遗失请重新创建。

在 RUM 应用中使用 Client Token

公网 DataWay 接入配置

使用公网 DataWay 接入时,需在 SDK 初始化配置中指定 site(DataWay 地址)和 clientToken 参数。

Web 应用接入示例

1. NPM 接入

import { datafluxRum } from "@cloudcare/browser-rum"
datafluxRum.init({
  applicationId: "<应用 ID>",
  site: "http://172.16.212.186:9529",
  clientToken: "a993f53a8ea04bc6b9350e5e670a3a3b",
  env: "production",
  version: "1.0.0",
  service: "browser",
  sessionSampleRate: 100,
  sessionReplaySampleRate: 70,
  compressIntakeRequests: true,
  trackInteractions: true,
  traceType: "ddtrace", // 非必填,默认为ddtrace,目前支持 ddtrace、zipkin、skywalking_v3、jaeger、zipkin_single_header、w3c_traceparent 6种类型
  allowedTracingOrigins: ["https://api.example.com", /https:\/\/.*\.my-api-domain\.com/], // 非必填,允许注入trace采集器所需header头部的所有请求列表。可以是请求的origin,也可以是是正则
})
datafluxRum.startSessionReplayRecording()

2. CDN 同步加载

<script
  src="https://static.guance.com/browser-sdk/v3/dataflux-rum.js"
  type="text/javascript"
></script>
<script>
  window.DATAFLUX_RUM &&
    window.DATAFLUX_RUM.init({
      applicationId: "<应用 ID>",
      site: "http://172.16.212.186:9529",
      clientToken: "a993f53a8ea04bc6b9350e5e670a3a3b",
      env: "production",
      version: "1.0.0",
      service: "browser",
      sessionSampleRate: 100,
      sessionReplaySampleRate: 70,
      compressIntakeRequests: true,
      trackInteractions: true,
      traceType: "ddtrace", // 非必填,默认为ddtrace,目前支持 ddtrace、zipkin、skywalking_v3、jaeger、zipkin_single_header、w3c_traceparent 6种类型
      allowedTracingOrigins: ["https://api.example.com", /https:\/\/.*\.my-api-domain\.com/], // 非必填,允许注入trace采集器所需header头部的所有请求列表。可以是请求的origin,也可以是是正则
    })
  window.DATAFLUX_RUM && window.DATAFLUX_RUM.startSessionReplayRecording()
</script>

更多接入配置说明和示例,可参考 Web 应用接入

管理 Client Token

所有已创建的 Client Token 均在列表内列出。您可通过列表直接查看 Client Token 名称、Client Token、创建人与创建时间。

删除 Token

点击删除按钮,即可删除当前 Token。删除后,如果有任何代理正在使用此令牌,将立即停止数据上报。

注意

如果应用被删除,Client Token 管理列表中对应的 Client Token 也会被同步删除。

自动清理机制

当 RUM 应用被删除时,系统会自动同步删除关联的 Client Token。建议定期清理不再使用的 Token,减少安全风险。

常见问题

Client Token 和 DataKit Token 有什么区别?

Client Token 用于 RUM 公网 DataWay 接入,仅允许数据上报;DataKit Token(tkn_ 开头)用于 DataKit 采集器认证,权限更大。两者不可混用。


使用公网 DataWay 是否需要安装 DataKit?

不需要。公网 DataWay 是观测云提供的托管服务,无需安装和维护 DataKit,适合快速接入场景。


Client Token 泄露了怎么办?

Client Token 泄露风险相对较低(仅允许上报,无法查询或修改数据),但仍建议:

  1. 立即在控制台删除该 Token;
  2. 创建新 Token 并更新应用配置;
  3. 观察是否有异常上报数据

为什么我的应用接入了但没有数据?

请检查:

  1. Client Token 是否正确(注意区分大小写);
  2. site 地址是否正确(不同地域可能不同);
  3. 网络是否允许访问公网 DataWay;
  4. 采样率配置(sessionSampleRate)是否过低。

可以一个 Token 用于多个应用吗?

技术上可以,但不建议。多个应用共用 Token会导致数据混乱,难以区分来源,且无法单独控制某个应用的数据上报。


本地部署和公网 DataWay 可以混用吗?

不可以。一个应用只能选择一种接入方式:

  • 选择公网 DataWay → 需要 Client Token,不需要 DataKit
  • 选择本地部署 → 不需要 Client Token,需要 DataKit

文档评价

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