platform: option to keep request URLs, logs and exceptions out of platform and project Worker telemetry
メンテナーはふだん 1 日以内に返信
関連するプルリクエストがすでにマージされています。
- #683 @Brooooooklyn による — マージ済み
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 18/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- typescript
- 領域
- backend, cloud, observability
調査の方向性
The telemetry settings live in packages/platform/src/worker-config.ts (platform Worker observability), platform/packages/api/src/deploy/upload-worker.ts (project Workers logs and tail consumer), and platform/packages/tail/src/index.ts (the Analytics Engine write of logs, exceptions and URL). Read the install/upgrade manifest path before changing anything. Done means the flag shape is agreed first, then a minimal mode drops those fields while keeping outcome, status and deployment id, with tests. The open questions need a maintainer decision before coding.
索引モデルが issue の本文から書いたものです。
説明
Motivation
Some operators run a Void platform for apps whose request URLs, console output or exception messages can carry personal data, such as query strings with email addresses or one-time links. Their data-minimisation rules require these values to stay out of Cloudflare Workers Logs and the platform's Analytics Engine datasets. Today every platform and project Worker always records them, and an operator has no setting to turn this off.
Where it is recorded (v1.5.0)
- Platform Workers (API, proxy, dispatch and others) are always deployed with
observability: { enabled: true }: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/packages/platform/src/worker-config.ts#L82-L88 - Project Workers are always uploaded with Workers Logs and invocation logs at a 100% sampling rate, plus the platform tail consumer: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/api/src/deploy/upload-worker.ts#L490-L494
- The tail Worker writes each event's
logs,exceptionsand fullrequest.url(including the query string) into Analytics Engine: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/tail/src/index.ts#L70-L84
This data stays inside the installation's own Cloudflare account. The project log endpoints are scoped per project. This is a request for a privacy setting, not a report of a leak.
Proposal (opt-in, default unchanged)
Add an installation-level setting that is stored in the deployment manifest and applied on install and upgrade. In its minimal mode it would:
- disable Workers Logs (or only invocation logs) on platform Workers and on newly uploaded project Workers;
- keep the tail data point, but write empty values (or a path with the query string removed) in place of
logs,exceptionsandurl. Outcome, method, status and deployment id would still be recorded, so error rates and status filtering keep working.
Trade-off
In minimal mode, project owners and administrators would lose data in these views:
- the project logs endpoint: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/api/src/routes/projects.ts#L2507-L2525
- the admin deployment-log view, which reads the same columns: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/api/src/operator/deployment-operations.ts#L270-L271 and https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/api/src/admin/fate/telemetry.ts#L34-L38
The request-metering dataset that dispatch writes does not store URLs, so usage and quotas would be unaffected. The UI should probably say "not recorded on this platform" rather than show an empty list.
Questions
- Flag shape: which would you prefer?
- an install/upgrade flag (for example
--telemetry full|minimal) persisted in the manifest - an environment variable read at deploy time
- separate switches for Workers Logs and for the tail fields
- an install/upgrade flag (for example
- Scope: for the URL field, would you prefer dropping it entirely or keeping the path without the query string?
- Per project: should project owners be able to opt in to full logs on a platform that defaults to minimal, or should this stay platform-wide only?
- Is this something you would accept as a PR once the shape is agreed?
Prepared with Claude Code on behalf of @iPLAYCAFE-dev; reviewed by the maintainer of this account.
- 主要言語
- TypeScript
- スター
- 627
- フォーク
- 66
- 平均マージ
- 14時間 38分
- マージ済み PR（30日）
- 179
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
voidzero-dev/void のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
voidzero-dev/void#677 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
voidzero-dev/void#689 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 52/100
voidzero-dev/void#686 ·
メンテナーはふだん 1 日以内に返信
-
`VoidActionError.message` ignores the server's message, though the docs show it to users対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
voidzero-dev/void#680 ·
メンテナーはふだん 1 日以内に返信
-
`withValidator({ body })` rejects the multipart bodies that `useForm` and `action()` send for filesオープン
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
voidzero-dev/void#679 ·
メンテナーはふだん 1 日以内に返信
voidzero-dev/void の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
riverqueue/river#1576 ·
メンテナーはふだん 1 日以内に返信
-
[bug] A prompt queued during a run is assessed without its text対応中かも @jwiegley が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
DevMortimer/pi-warden#211 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 84/100
mattermost/compass-design#191 ·
メンテナーはふだん 1 日以内に返信
-
Add unit tests for the organization admin role check対応中かも @SaffuSafwan が今日担当しました。 オープンarea/core good first issue help wanted
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
HorusGoul/trizum#559 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信