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

Aperta
  • Qualcosa non va?
#667 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
18/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
backend, cloud, observability

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
627
Fork
66
Merge medio
14h 56m
PR unite (30g)
170

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di voidzero-dev/void

Tutte le issue di voidzero-dev/void

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.