Client Tokens 管理¶
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/], // 省略可能。trace 収集に必要なヘッダーを注入するすべてのリクエストのリスト。リクエストの 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 収集に必要なヘッダーを注入するすべてのリクエストのリスト。リクエストの origin または正規表現を指定できます
})
window.DATAFLUX_RUM && window.DATAFLUX_RUM.startSessionReplayRecording()
</script>
接続設定の詳しい説明と例については、Web アプリケーションの接続 を参照してください。
Client Token の管理¶
作成済みのすべての Client Token は一覧に表示されます。一覧では、Client Token 名、Client Token、作成者、作成時間を直接確認できます。
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)が低すぎないか
1つの Token を複数のアプリケーションで使用できますか?
技術的には可能ですが、お勧めしません。複数のアプリケーションで Token を共用すると、データが混在して送信元を区別しにくくなり、特定のアプリケーションのデータ送信を個別に制御することもできません。
オンプレミスとパブリック DataWay は併用できますか?
いいえ、できません。1つのアプリケーションでは、1つの接続方法のみ選択できます。
- パブリック DataWay を選択 → Client Token が必要、DataKit は不要
- オンプレミスを選択 → Client Token は不要、DataKit が必要
