platform: option to keep request URLs, logs and exceptions out of platform and project Worker telemetry

已關閉
#667 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

已經有一個關聯 PR 被合併了。

  • #683 來自 @Brooooooklyn —— 已合併

評估

難度
5/5
預估耗時
一週以上
新手友好度
18/100
Issue 類型
功能
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
typescript

研究方向

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)

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, exceptions and url. 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 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
  1. 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
  2. Scope: for the URL field, would you prefer dropping it entirely or keeping the path without the query string?
  3. 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?
  4. 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 分鐘
30 天內合併 PR
179

環境準備

這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

voidzero-dev/void 的其他 Issue

查看 voidzero-dev/void 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。