本文へスキップ

テレメトリ ​

debuff build が成功すると、CLI はプロジェクトがビルドされたことを debuff.jp に知らせます。これは debuff で作られたゲームを見つけるためのもので、みなさんが何を作っているかを知り、いずれショーケースへお招きするためです。用途はそれだけです。

送られるもの ​

ビルドごとに https://debuff.jp/api/telemetry へ小さなリクエストを 1 回送ります。

フィールド例内容
id1b9f…c3初回ビルド時に作られるランダムな ID。プロジェクトの .debuff/project.json に保存されます
namemy-gamepackage.json の name
debuff0.8.0debuff CLI のバージョン

リクエストの中身はこれで全部です。コード、ファイルパス、URL、マシンの情報、プレイヤーに関する情報は一切含みません。ゲームが遊ばれるときには何も送られません。テレメトリが動くのは、あなたのマシンでビルドするときだけです。

こちら側では、プロジェクト ID ごとに 1 件の記録を保持します。名前、debuff のバージョン、最初と最後にビルドされた日時、ビルド回数です。IP アドレスは保存しません。

オフにする ​

次のどれかの方法でオフにできます。

bash
npx debuff telemetry off
  • 環境変数で DEBUFF_TELEMETRY=0 を設定する。
  • CI では自動的にオフになります。

npx debuff telemetry で、オンかどうかと設定の保存場所を確認できます。npx debuff telemetry on で再びオンになります。

何かを送信する最初のビルドでは、そのことを知らせる 1 行の通知が表示されます。リクエストは約 1.5 秒で諦めるので、ビルドを失敗させることはありません。

質問 ​

Discord で聞くか、issue を立ててください。コードは tooling/cli/src/telemetry.ts、エンドポイントはサイトのリポジトリの src/telemetry.ts です。