Client Token 管理¶

Client Token は、Guanceのリアルユーザーモニタリング（RUM）機能におけるコア認証情報です。ユーザー端末（Web、モバイル、ミニプログラムなど）から Guance サーバーへ安全にデータを送信するために使用されます。

ユーザーが Web サイトやアプリケーションとやり取りする際、Client Token はパフォーマンスデータとともに送信され、サーバーがそれらのデータを検証して受信できるようにします。これにより、データのセキュリティと正確性が確保されます。このトークン機構は、認証プロセスを簡素化するだけでなく、効率的なクロスドメインデータ転送をサポートし、Guance がユーザーの実際の利用状況をシンプルかつ効果的に収集・分析するための手段を提供します。

ユースケース¶

Client Token は主にパブリック DataWay 接続方式で使用されます。この方式では、DataKit をインストールする必要はなく、site と clientToken パラメータを設定するだけで RUM データを迅速に取り込むことができます。

Client Token の作成¶

前提条件¶

Guance ワークスペースの管理者または Owner 権限を持っていること。
リアルユーザーモニタリング（RUM）機能が有効になっていること。
Client Token の名前を入力します。
「確定」をクリックします。
Guance が自動生成した 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/], // 必須ではありません。トレース収集に必要なヘッダーを注入することを許可するリクエストのリストです。リクエストの 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/], // 必須ではありません。トレース収集に必要なヘッダーを注入することを許可するリクエストのリストです。リクエストの 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 は Guance が提供するマネージドサービスであり、DataKit のインストールや管理は不要で、迅速な導入に適しています。

Client Token が漏洩した場合はどうすればよいですか？

Client Token の漏洩リスクは比較的低いですが（アップロードのみ可能で、データの照会や変更は不可）、以下の対応を推奨します。

すぐにコンソールで該当の Token を削除します。
新しい Token を作成し、アプリケーションの設定を更新します。
異常なアップロードデータがないか確認します。

アプリケーションを導入したのにデータが表示されません。

以下を確認してください。

Client Token が正しいか（大文字小文字の区別に注意）。
site アドレスが正しいか（地域によって異なる場合があります）。
ネットワークがパブリック DataWay にアクセスできるか。
サンプリングレート設定（sessionSampleRate）が低すぎないか。

複数のアプリケーションで同じ Token を使用できますか？

技術的には可能ですが、推奨しません。複数のアプリケーションで Token を共有すると、データが混在して発信元を特定することが困難になり、特定のアプリケーションのデータアップロードを個別に制御できなくなります。

ローカルデプロイとパブリック DataWay を混在して使用できますか？

いいえ、できません。1つのアプリケーションは1つの接続方式のみを選択できます。

パブリック DataWay を選択 → Client Token が必要、DataKit は不要
ローカルデプロイを選択 → Client Token は不要、DataKit が必要