platform: option to keep request URLs, logs and exceptions out of platform and project Worker telemetry
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 18/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- typescript
- Bereich
- backend, cloud, observability
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 627
- Forks
- 66
- Ø Merge
- 14 Std. 56 Min.
- Gemergte PRs (30 T.)
- 170
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus voidzero-dev/void
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
voidzero-dev/void#677 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 52/100
voidzero-dev/void#680 ·
Maintainer antworten meist innerhalb von 1 Tag
-
`withValidator({ body })` rejects the multipart bodies that `useForm` and `action()` send for filesOffen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
voidzero-dev/void#679 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
voidzero-dev/void#676 ·
Maintainer antworten meist innerhalb von 1 Tag
-
platform: interrupted install ignores a replacement runtime token and never updates deployed WorkersOffen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
voidzero-dev/void#666 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in voidzero-dev/void
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
ready-for-agent
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
LucasSantana-Dev/Lucky#2951 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
danielmiessler/LifeOS#2567 ·
Maintainer antworten meist innerhalb von 9 Tagen
-
refactor(react-pi): classify base64 images with core's parseBase64Evtl. vergeben @jimmyallinai hat das heute übernommen. Offenmaintenance
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
assistant-ui/assistant-ui#10293 · 2 Kommentare · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
brijeshb42/monaco-vim#175 ·