platform: option to keep request URLs, logs and exceptions out of platform and project Worker telemetry
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 18/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- typescript
- Domaine
- backend, cloud, observability
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- TypeScript
- Étoiles
- 627
- Forks
- 66
- Merge moyen
- 14 h 56 min
- PR mergées (30 j)
- 170
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de voidzero-dev/void
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
voidzero-dev/void#677 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 3/5 1-2 jours Accessibilité débutants 52/100
voidzero-dev/void#680 ·
Les mainteneurs répondent en général sous 1 jour
-
`withValidator({ body })` rejects the multipart bodies that `useForm` and `action()` send for filesOuverte
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
voidzero-dev/void#679 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
voidzero-dev/void#676 ·
Les mainteneurs répondent en général sous 1 jour
-
platform: interrupted install ignores a replacement runtime token and never updates deployed WorkersOuverte
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
voidzero-dev/void#666 ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de voidzero-dev/void
Issues similaires
-
Remove unused dependenciesPeut-être pris @alastair-smith l’a pris aujourd’hui. Ouvertechore other
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
alastair-smith/card-games#384 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
code-yeongyu/senpi#5571 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
nexu-io/open-design#9262 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
friction
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
kentcdodds/kody#4753 ·
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulté 1/5 Moins d'une heure Accessibilité débutants 62/100
lingdojo/kana-dojo#33508 · 1 commentaire · 5 réactions ·
Les mainteneurs répondent en général sous 1 jour